` is the user token. The token identifies the user and provides access to personalized data. Alternatively, you can use a [token for opening the payment UI](/de/api/pay-station/token/create-token).\n\n2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/de/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n - `x-unauthorized-id` with a request ID\n - `x-user` with the user's email address encoded in Base64\n\n## Useful links\n\n- [API calls by interaction model](https://developers.xsolla.com/de/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/de/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/de/api/catalog/)\n- [API keys](https://developers.xsolla.com/de/api/catalog/)\n\n# Core entity structure\n\nItems of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.\n\nNote
Some calls may include additional fields but they don't change the basic structure.
\n\n**Identification**\n\n- `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/)\n- `project_id` — project ID in Publisher Account\n- `sku` — item SKU, unique within the project\n\n**Store display**\n\n- `name` — item name\n- `description` — item description\n- `image_url` — image URL\n- `is_enabled` — item availability\n- `is_show_in_store` — whether the item is displayed in the catalog\n\nFor more information about managing item availability in the catalog, see the [documentation](/de/items-catalog/catalog-features/items-availability/).\n\n**Organization**\n\n- `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`)\n- `groups` — groups the item belongs to\n- `order` — display order in the catalog\n\n**Sale conditions**\n\n- `prices` — prices in real or virtual currency\n- `limits` — purchase limits\n- `periods` — availability periods\n- `regions` — regional restrictions\n\n**Example of core entity structure:**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n\n# Basic purchase flow\n\nThe Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into **Admin** and **Catalog** subsections, which use different [authentication schemes](/de/api/catalog/section/authentication).\n\nThe following example shows a basic flow for setting up and operating a store, from item creation to purchase.\n\n## Create items and groups (Admin)\n\nCreate an item catalog for your store, such as virtual items, bundles, or virtual currency.\n\nExample API calls:\n- [Create virtual item](/de/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/de/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/de/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Set up promotions, chains, and limits (Admin)\n\nConfigure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.\n\nExample API calls:\n- [Create bonus promotion](/de/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/de/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/de/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Get item information (Client)\n\nConfigure item display in your application.\n\n\n
Notice\n Do not use API calls from the Admin subsection to build a user catalog. These API calls have
rate limits and aren't intended for user traffic.\n
\n\nExample API calls:\n- [Get virtual items list](/de/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/de/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/de/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/de/api/catalog/common-catalog/get-sellable-items)\n\n\n Note
\n By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter \"show_inactive_time_limited_items\": 1 in the catalog request.\n
\n\n## Sell items\n\nYou can sell items using the following methods:\n- Fast purchase — sell one SKU multiple times.\n- Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.\n\nIf an item is purchased using virtual currency instead of real money, use the [Create order with specified item purchased by virtual currency](/de/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required, as the charge is processed when the API call is executed.\n\nFor free item purchase, use the [Create order with specified free item](/de/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/de/api/catalog/free-item/create-free-order) API call. The payment UI is not required — the order is immediately set to the done status.\n\n### Fast purchase\n\nUse the client-side API call to [create an order with a specified item](/de/api/catalog/payment-client-side/create-order-with-item). The call returns a token used to open the payment UI.\n\n\n Note
\n Discount information is available to the user only in the payment UI. Promo codes are not supported.\n
\n\n### Cart purchase\n\nCart setup and purchase can be performed on the client or on the server side.\n\n**Set up and purchase a cart on the client**\n\nImplement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/de/api/shop-builder/operation/cart-fill/) API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).\n2. Update the cart contents based on user actions:\n - To add an item or change item quantity, use the [Update cart item by cart ID](/de/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/de/api/shop-builder/operation/delete-item-by-cart-id/) API call.\n\n\n Note
\n To get the current status of the cart, use the Get current user's cart API call.\n
\n\n3. Use the [Create order with all items from current cart](/de/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n**Set up and purchase a cart on the server**\n\nThis setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/de/api/catalog/cart-server-side) API call. The call returns current information about the selected items (prices before and after discounts, bonus items).\n2. Use the [Create order with all items from current cart](/de/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n## Open payment UI\n\nUse the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the [documentation](/de/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui).\n\n| Action | Endpoint |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} |\n| Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n\n
Note\n Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use
test bank cards.\n\n After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in [Publisher Account > Company settings > Users](https://publisher.xsolla.com/0/settings/users).\n\n Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in [Publisher Account](https://publisher.xsolla.com/), go to **Agreements & Taxes > Agreements**, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.\n
Hinweis
Die Methode gibt eine paginierte Artikelliste zurück. Der Maximal- und Standardwert beträgt 50 Artikel pro Antwort. Verwenden Sie die Parameter `limit` und `offset`, um weitere Seiten bzw. Artikel aus der Liste abzurufen. Wenn Sie beispielsweise die Methode mit den Parameterwerten \"limit = 25\" und \"offset = 100\" aufrufen, sind in der Antwort 25 Artikel aufgeführt, beginnend mit dem 101. Artikel in der Gesamtliste.
",
"operationId": "admin-get-daily-chains",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
},
{
"$ref": "#/components/parameters/is_expired-daily-chain-query-param"
},
{
"$ref": "#/components/parameters/type-daily-chain-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-daily-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der täglichen Belohnungen abrufen",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt eine tägliche Belohnung",
"operationId": "admin-create-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-daily-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-daily-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-error-list"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Tägliche Belohnung erstellen",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}": {
"delete": {
"description": "Löscht eine bestimmte tägliche Belohnung.",
"operationId": "admin-delete-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Tägliche Belohnung wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Tägliche Belohnung löschen",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft eine bestimmte tägliche Belohnung zur Verwaltung ab.",
"operationId": "admin-get-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-daily-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Tägliche Belohnung abrufen",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert eine bestimmte tägliche Belohnung.",
"operationId": "admin-update-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-daily-chain"
},
"responses": {
"204": {
"content": {},
"description": "Tägliche Belohnung wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-admin-update-error-list"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Tägliche Belohnung aktualisieren",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/reset": {
"post": {
"description": "Setzt den Fortschritt aller Nutzer bei der täglichen Belohnung zurück. Gilt nur für tägliche Belohnungen vom Typ `rolling`.",
"operationId": "admin-reset-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Die tägliche Belohnung wurde zurückgesetzt."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Tägliche Belohnung zurücksetzen",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/daily_chain/id/{daily_chain_id}/toggle": {
"put": {
"description": "Aktiviert oder deaktiviert eine tägliche Belohnung.",
"operationId": "admin-toggle-daily-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Die tägliche Belohnung wurde deaktiviert oder aktiviert."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Tägliche Belohnung aktivieren/deaktivieren",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/upsell": {
"get": {
"description": "Ruft die Informationen zum Upselling im Projekt ab: ob es aktiviert ist, die Art des Upsellings und die SKU-Liste der Artikel, die Teil dieses Upsellings sind.",
"operationId": "get-upsell-configurations-for-project-admin",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"upsell": {
"summary": "Projekt beinhaltet Upselling",
"value": [
{
"is_enabled": true,
"items": [
{
"item_id": 1,
"name": {
"de": "Name des Artikels",
"en": "Item's name"
},
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good"
},
{
"bundle_type": "standard",
"item_id": 2,
"name": {
"de": "Name des Artikels",
"en": "Item's name"
},
"sku": "com.xsolla.booster_mega_2",
"type": "bundle"
},
{
"item_id": 3,
"name": {
"en": "Mega game"
},
"sku": "com.xsolla.mega_game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam_key_1",
"item_id": 4,
"name": {
"en": "Mega game steam"
},
"sku": "com.xsolla.mega_game_steam_1"
}
],
"unit_type": "game"
}
],
"type": "fixed_list"
}
]
}
},
"schema": {
"items": {
"properties": {
"is_enabled": {
"description": "Ob Upselling für das Projekt aktiviert ist.",
"example": true,
"type": "boolean"
},
"items": {
"description": "Die Liste der Artikel-SKU, die Teil des Upsellings im Projekt sind.",
"example": [
{
"item_id": 1,
"name": {
"de": "Name des Artikels",
"en": "Item's name"
},
"sku": "com.xsolla.booster_mega_1",
"type": "virtual_good"
}
],
"items": {
"properties": {
"bundle_type": {
"$ref": "#/components/schemas/bundle_type"
},
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
},
"unit_items": {
"description": "Spielschlüssel für verschiedene DRMs.",
"items": {
"description": "Spielschlüssel-Artikel. Repräsentiert ein Spiel auf einer bestimmten Plattform (Steam, GOG usw.).",
"properties": {
"drm_name": {
"$ref": "#/components/schemas/drm_name"
},
"drm_sku": {
"$ref": "#/components/schemas/drm_sku"
},
"item_id": {
"$ref": "#/components/schemas/item_id"
},
"name": {
"$ref": "#/components/schemas/name-localization-object"
},
"sku": {
"$ref": "#/components/schemas/sku"
},
"type": {
"$ref": "#/components/schemas/item_type"
}
},
"type": "object"
},
"type": "array"
},
"unit_type": {
"$ref": "#/components/schemas/unit_type"
}
},
"type": "object"
},
"type": "array"
},
"type": {
"description": "Die Art des Upsellings.",
"enum": [
"fixed_list",
"most_sellable",
"only_promotions"
],
"example": "fixed_list",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "Die Liste der Konfigurationsdetails und Elemente, die im Projekt für Upselling verwendet werden."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Informationen zum Upselling im Projekt abrufen",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Creates an upsell for a project.
\n Notice
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "post-upsell",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-upsell"
},
"responses": {
"202": {
"description": "Für das Projekt wurde Upselling erstellt."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/Upsell-404-item-not-found"
},
"422": {
"$ref": "#/components/responses/Upsell-422-invalid-request"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Upselling erstellen",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Update an upsell for a project.
\n Notice
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "put-upsell",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-upsell"
},
"responses": {
"202": {
"description": "Upselling wurde für das Projekt aktualisiert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/Upsell-404-item-not-found"
},
"422": {
"$ref": "#/components/responses/Upsell-422-invalid-request"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Upselling aktualisieren",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/upsell/{toggle}": {
"put": {
"description": "Changes an upsell’s status in a project to be either active or inactive.
\n Notice
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "put-upsell-toggle-active-inactive",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"description": "Aktivierungsstatus.",
"in": "path",
"name": "toggle",
"required": true,
"schema": {
"example": "activate",
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Ein Upselling-Artikel in einem Projekt wurde aktiviert oder deaktiviert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Upselling-Artikel des Projekts aktivieren/deaktivieren",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/value_points": {
"get": {
"description": "Ruft die Liste der Wertpunkte innerhalb eines Projekts zu Verwaltungszwecken ab.",
"operationId": "admin-get-value-points-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-value-points"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Wertpunkte abrufen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt einen Wertpunkt.",
"operationId": "admin-create-value-points",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-value-point"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-value-point"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Wertpunkt erstellen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/value_points/sku/{item_sku}": {
"delete": {
"description": "Löscht einen durch Angabe der SKU festgelegten Wertpunkt.",
"operationId": "admin-delete-value-point",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Der Wertpunkt wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Wertpunkte löschen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft einen durch Angabe der SKU festgelegten Wertpunkt innerhalb eines Projekts zu Verwaltungszwecken ab.",
"operationId": "admin-get-value-point",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-value-point"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Wertpunkt abrufen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert einen durch Angabe der SKU festgelegten Wertpunkt.",
"operationId": "admin-update-value-point",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-value-point"
},
"responses": {
"204": {
"content": {},
"description": "Der Wertpunkt wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Wertpunkt aktualisieren",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards": {
"delete": {
"description": "Entfernt Wertpunktbelohnungen von ALLEN Artikeln.",
"operationId": "admin-delete-items-value-point-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Wertpunktbelohnungen für Artikel wurden erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Wertpunkte von Artikeln löschen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft eine Liste aller Artikel mit Wertpunkten innerhalb eines Projekts zu Verwaltungszwecken ab.",
"operationId": "admin-get-items-value-point-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-value-point-rewards"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Artikel mit Wertpunkten abrufen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"patch": {
"description": "Aktualisiert die Anzahl der Wertpunkte für einen oder mehrere Artikel teilweise anhand der SKU des Artikels. Nutzer erhalten Wertpunkte nach dem Kauf der angegebenen Artikel.\n\nGrundregeln für die Aktualisierung von Wertpunkten:\n * Wenn einem Artikel noch keine Wertpunkte zugewiesen sind, werden diese durch das Senden eines Wertes ungleich Null in das Feld `amount` eingetragen.\n * Wenn einem Artikel bereits Wertpunkte zugewiesen sind, werden die im Feld `amount` angegebenen Wertpunkte durch das Senden eines Wertes ungleich Null überschrieben.\n * Wenn`amount` auf 0 festgelgt wird, werden die vorhandenen Wertpunkte für diesen Artikel gelöscht.\n\nIm Gegensatz zur `PUT`-Methode ([Wertpunkte für Artikel festlegen](https://developers.xsolla.com/de/api/shop-builder/operation/admin-set-items-value-point-reward/)), werden bei dieser `PATCH`-Methode nicht alle vorhandenen Artikel-Wertpunkte im Projekt überschrieben, sondern nur die Wertpunkte der angegebenen Artikel aktualisiert.\n\nMit einer einzelnen Anfrage können bis zu 100 Artikel aktualisiert werden. Doppelt vorhandene Artikel-SKUs dürfen nicht in derselben Anfrage enthalten sein.",
"operationId": "admin-patch-items-value-point-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/set-item-value-point-reward-for-patch"
},
"responses": {
"204": {
"content": {},
"description": "Wertpunktbelohnungen für Artikel wurden erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Wertpunkte für Artikel teilweise aktualisieren",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Weist einem oder mehreren Artikeln durch Angabe der entsprechenden SKU Wertpunkte zu. Nutzer erhalten Wertpunkte, nachdem sie diese Artikel gekauft haben.\n\n Beachten Sie, dass diese PUT-Anfrage alle zuvor festgelegten Wertpunkte für Artikel im Projekt überschreibt.\n\nUm ein unbeabsichtigtes Löschen von Wertpunkten zu vermeiden, müssen alle Artikel und ihre jeweiligen Wertpunkte in jeder PUT-Anfrage angegeben sein.\n\nWenn Sie nur die Wertpunkte für einen bestimmten Artikel aktualisieren und die Wertpunkte anderer Artikel unverändert lassen möchten, sollten Sie den aktuellen Satz Wertpunkte mithilfe einer GET-Anfrage abrufen, die Wertpunkte des gewünschten Artikels ändern und dann den geänderten Satz mit den aktualisierten Wertpunkten für den entsprechenden Artikel zurücksenden.",
"operationId": "admin-set-items-value-point-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/value_point_sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/set-item-value-point-reward"
},
"responses": {
"204": {
"content": {},
"description": "Wertpunktbelohnungen für Artikel wurden erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Wertpunkte für Artikel festlegen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/offer_chain": {
"get": {
"description": "Ruft eine Liste der Angebotsketten zur Verwaltung ab.\nHinweis
In allen Projekten ist die Anzahl der Artikel, die in einer einzigen Antwort zurückgegeben werden können, begrenzt. Der Standard- und Maximalwert beträgt 10 Artikel pro Antwort. Verwenden Sie die Abfrageparameter limit und offset für die Paginierung, um weitere Daten abzurufen.
",
"operationId": "admin-get-offer-chains",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-offer-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Angebotsketten abrufen",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt eine Angebotskette.",
"operationId": "admin-create-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-offer-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-offer-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-create-error-list"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Angebotskette erstellen",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}": {
"delete": {
"description": "Löscht eine bestimmte Angebotskette.\n\n Nach dem Löschen:- verbleiben alle bereits von den Nutzern erhaltenen Belohnungen in deren Besitz.
- sind unvollendete Schritte nicht mehr verfügbar und zugehörige Belohnungen können nicht mehr erhalten werden.
\n\n Im Gegensatz zur Deaktivierung der Angebotskette über den Aufruf Angebotskette aktivieren/deaktivieren, ist die Löschung ist unumkehrbar und der Nutzerfortschritt wird nicht gespeichert.",
"operationId": "admin-delete-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Angebotskette wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Angebotskette löschen",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft eine bestimmte Angebotskette zur Verwaltung ab.",
"operationId": "admin-get-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-offer-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Angebotskette abrufen",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert eine bestimmte Angebotskette.",
"operationId": "admin-update-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-offer-chain"
},
"responses": {
"204": {
"content": {},
"description": "Angebotskette wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-update-error-list"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Angebotskette aktualisieren",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/offer_chain/id/{offer_chain_id}/toggle": {
"put": {
"description": "Aktiviert oder deaktiviert eine Angebotskette.\n\nWenn die Angebotskette deaktiviert ist, verlieren Nutzer vorübergehend den Zugriff darauf, ihr Fortschritt bleibt jedoch erhalten.\n\nNachdem die Angebotskette erneut aktiviert wurde, können Nutzer an der Stelle fortfahren, an der sie aufgehört haben.",
"operationId": "admin-toggle-offer-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Die Angebotskette wurde deaktiviert/aktiviert."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Angebotskette aktivieren/deaktivieren",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/activate": {
"put": {
"description": "Aktiviert eine Promocode-Aktion.\n\nDie erstellte Promocode-Aktion ist standardmäßig deaktiviert.\nPromocodes lassen sich erst einlösen, wenn Sie die zugehörige Werbeaktion aktivieren.\nVerwenden Sie diesen Endpunkt, um eine Promocode-Aktion zu aktivieren.",
"operationId": "activate-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Promocode wurde erfolgreich aktiviert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Promocode-Aktion aktivieren",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/code": {
"get": {
"description": "Ruft Codes einer Promocode-Aktion ab.",
"operationId": "get-promocode-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promocode-code-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Codes von Promocode-Aktion abrufen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt Code für eine Promocode-Aktion.",
"operationId": "create-promo-code-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Code für Promocode-Aktion erstellen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/code/generate": {
"put": {
"description": "Generiert Codes für eine Promocode-Aktion.",
"operationId": "generate-promo-code-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"required": [
"count"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"count": 10
}
}
},
"schema": {
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"type": "object"
}
}
},
"description": "Codes wurden erfolgreich generiert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Codes für eine Promocode-Aktion generieren",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promocode/{external_id}/deactivate": {
"put": {
"description": "Deaktiviert eine Promocode-Aktion.\n\nDie erstellte Promocode-Aktion ist standardmäßig deaktiviert.\nPromocodes lassen sich erst einlösen, wenn Sie die zugehörige Werbeaktion aktivieren.\nVerwenden Sie diesen Endpunkt, um eine Promocode-Aktion zu deaktivieren.",
"operationId": "deactivate-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Gutschein wurde erfolgreich deaktiviert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Promocode-Aktion deaktivieren",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promotion/{promotion_id}/activate": {
"put": {
"description": "Aktiviert eine Werbeaktion.",
"operationId": "activate-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Werbeaktion wurde erfolgreich aktiviert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Werbeaktion aktivieren",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/promotion/{promotion_id}/deactivate": {
"put": {
"description": "Deaktiviert eine Werbeaktion.",
"operationId": "deactivate-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Werbeaktion wurde erfolgreich deaktiviert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Werbeaktion deaktivieren",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/activate": {
"put": {
"description": "Aktiviert ein Katalogsonderangebot.\n Das erstellte Katalogsonderangebot ist standardmäßig deaktiviert.\nDas Angebot kann erst eingelöst werden, nachdem Sie es aktiviert haben.\nVerwenden Sie diesen Endpunkt, um eine Gutscheinaktion freizuschalten und zu aktivieren.",
"operationId": "activate-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Das Katalogsonderangebot wurde erfolgreich aktiviert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogsonderangebot aktivieren",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code": {
"get": {
"description": "Ruft Codes für Katalogsonderangebote ab.",
"operationId": "get-unique-catalog-offer-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-unique-catalog-offer-code-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Codes für Katalogsonderangebote abrufen",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt einen Code für Katalogsonderangebote.",
"operationId": "create-unique-catalog-offer-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-coupon-promocode-code"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-coupon-promocode-code-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-coupon-promocode-same-code-exists"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Code für Katalogsonderangebote erstellen",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/code/generate": {
"put": {
"description": "Generiert Codes für Katalogsonderangebote.",
"operationId": "generate-unique-catalog-offer-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"required": [
"count"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"count": 10
}
}
},
"schema": {
"properties": {
"count": {
"$ref": "#/components/schemas/Promotions_coupon-generate-count"
}
},
"type": "object"
}
}
},
"description": "Die Codes wurden erfolgreich generiert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Codes für Katalogsonderangebote generieren",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/unique_catalog_offer/{external_id}/deactivate": {
"put": {
"description": "Deaktiviert ein Katalogsonderangebot.\n Das erstellte Katalogsonderangebot ist standardmäßig deaktiviert.\nDas Angebot kann erst eingelöst werden, nachdem Sie es aktiviert haben.\nVerwenden Sie diesen Endpunkt, um eine Gutscheinaktion zu deaktivieren.",
"operationId": "deactivate-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Katalogsonderangebot wurde erfolgreich deaktiviert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-error"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogsonderangebot deaktivieren",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/attribute/rule": {
"get": {
"description": "Ruft alle Regeln ab, die für Benutzerattribute gelten.",
"operationId": "get-filter-rules",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/is_enabled-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"has_more": true,
"items": [
{
"attribute_conditions": [
{
"attribute": "race",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "ork"
}
],
"is_enabled": true,
"is_satisfied_for_unauth": false,
"items": [
{
"item_id": 1,
"name": "Ork Armor",
"sku": "com.xsolla.ork_armor_1",
"type": "virtual_good"
},
{
"bundle_type": "standard",
"item_id": 2,
"name": "Potion pack",
"sku": "com.xsolla.potion_pack_1",
"type": "bundle"
}
],
"name": "Ork race armor rule",
"rule_id": 1
}
],
"total_items_count": 20
}
}
},
"schema": {
"properties": {
"has_more": {
"description": "Wenn eine andere Seite mit Regeln existiert.",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog"
},
"type": "array"
},
"total_items_count": {
"description": "Gesamtzahl der Regeln.",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "Regeln wurden erfolgreich empfangen."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Katalogfilterregeln abrufen",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt Regeln für Benutzerattribute.",
"operationId": "create-filter-rule",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/personalized-catalog_create-update-body"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"rule_id": 1
}
}
},
"schema": {
"properties": {
"rule_id": {
"description": "Regel-ID.",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "Regel wurde erfolgreich erstellt."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogfilterregel erstellen",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/attribute/rule/all": {
"get": {
"description": "Ruft eine Liste aller Katalogregeln zum clientseitigen Durchsuchen ab.\nAchtung
Gibt nur die Regel-ID, den Namen und is_enabled zurück
",
"operationId": "get-all-filter-rules",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"is_enabled": true,
"is_satisfied_for_unauth": false,
"name": "Ork race armor rule",
"rule_id": 1
},
{
"is_enabled": false,
"is_satisfied_for_unauth": false,
"name": "Age",
"rule_id": 2
}
]
}
}
},
"schema": {
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog_all"
},
"type": "array"
}
},
"type": "object"
}
}
},
"description": "Regeln wurden erfolgreich empfangen."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Alle Katalogregeln zum clientseitigen Durchsuchen abrufen",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/attribute/rule/{rule_id}": {
"delete": {
"description": "Löscht eine bestimmte Regel.",
"operationId": "delete-filter-rule-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"responses": {
"204": {
"description": "Löschen war erfolgreich."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogfilterregel löschen",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Bestimmte für Benutzerattribute geltende Regel abrufen",
"operationId": "get-filter-rule-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"attribute_conditions": [
{
"attribute": "race",
"can_be_missing": false,
"operator": "eq",
"type": "string",
"value": "ork"
}
],
"is_enabled": true,
"is_satisfied_for_unauth": true,
"items": [
{
"item_id": 1,
"name": "Ork Armor",
"sku": "com.xsolla.ork_armor_1"
}
],
"name": "Ork race armor rule",
"rule_id": 1
}
}
},
"schema": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog"
}
}
},
"description": "Die Regel wurde erfolgreich empfangen."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogfilterregel abrufen",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"patch": {
"description": "Aktualisiert eine bestimmte Regel, die für Benutzerattribute gilt. Bei einer unbestimmten Eigenschaft wird der aktuelle Wert verwendet.",
"operationId": "patch-filter-rule-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"requestBody": {
"content": {
"application/json": {
"example": {
"is_enabled": false
},
"schema": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog-body"
}
}
}
},
"responses": {
"204": {
"description": "Update war erfolgreich."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogfilterregel patchen",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert eine bestimmte Regel, die für Benutzerattribute gilt. Bei einer unbestimmten Eigenschaft wird der Standardwert verwendet (wenn die Eigenschaft nicht erforderlich ist).",
"operationId": "update-filter-rule-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/personalized-catalog-rule_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/personalized-catalog_create-update-body"
},
"responses": {
"204": {
"description": "Erfolgreiche Aktualisierung."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogfilterregel aktualisieren",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}": {
"get": {
"description": "Ruft ab, wie oft der angegebene Nutzer den Gutschein noch in Anspruch nehmen kann.\n\nMit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer einen Gutschein in Anspruch nehmen kann. Das Nutzerlimit können Sie im Abschnitt \"Verwaltung\" festlegen:\n* [Gutscheine](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-coupons/)",
"operationId": "get-coupon-user-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-coupon-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Coupon not found": {
"$ref": "#/components/examples/404-coupon-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Artikel nicht gefunden."
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/Promotions_422-invalid-coupon"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Ungültige Anfrage."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Gutschein-Limit für den angegebenen Benutzer abrufen",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/promocode/external_id/{external_id}": {
"get": {
"description": "Ruft ab, wie oft der angegebene Nutzer den Promocode in Anspruch nehmen kann.\n\nMit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer einen Promocode in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\":\n* [Promocodes](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-promo-codes/)",
"operationId": "get-promo-code-user-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promo-code-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Promo code not found": {
"$ref": "#/components/examples/404-coupon-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Artikel nicht gefunden."
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/Promotions_422-invalid-coupon"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Ungültige Anfrage."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Promo-Code-Limit für den angegebenen Benutzer abrufen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/all": {
"delete": {
"description": "Aktualisiert alle für den angegebenen Nutzer geltenden Werbeaktionslimits, sodass er diese Werbeaktionen wieder in Anspruch nehmen kann.\n\nMit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" der gewünschten Werbeaktionsart:\n* [Rabattaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-discounts/)\n* [Bonusaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "reset-all-user-promotions-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits"
},
"responses": {
"200": {
"description": "Das Werbeaktionslimit wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Artikel nicht gefunden."
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Ungültige Anfrage."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Alle Werbeaktionslimits für den angegebenen Benutzer aktualisieren",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}": {
"delete": {
"description": "Verringert die Anzahl der verbleibenden Male, die der angegebene Nutzer eine Werbeaktion innerhalb des geltenden Limits in Anspruch nehmen darf.\n\nMit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Bereich \"Verwaltung\" der gewünschten Werbeaktionsart:\n* [Rabattaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-discounts/)\n* [Bonusaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "remove-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
},
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Artikel nicht gefunden."
},
"422": {
"content": {
"application/json": {
"examples": {
"Available promotion limit is out of range": {
"$ref": "#/components/examples/422-promotion-out-of-range-available-user-limit"
},
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Ungültige Anfrage."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Werbeaktionslimit für angegebenen Benutzer herabsetzen",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft ab, wie oft die der angegebene Nutzer die Werbeaktion innerhalb des geltenden Limits noch in Anspruch nehmen darf.\n\nMit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Bereich \"Verwaltung\" der gewünschten Werbeaktionsart:\n* [Rabattaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-discounts/)\n* [Bonusaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "get-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
},
{
"$ref": "#/components/parameters/user_external_id-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Artikel nicht gefunden."
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Ungültige Anfrage."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Werbeaktionslimit für angegebenen Benutzer abrufen",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erhöht die Anzahl der verbleibenden Male, die der angegebene Nutzer die Werbeaktion innerhalb des geltenden Limits in Anspruch nehmen darf.\n\nMit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Bereich \"Verwaltung\" der gewünschten Werbeaktionsart:\n* [Rabattaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-discounts/)\n* [Bonusaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "add-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-strict"
},
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Artikel nicht gefunden."
},
"422": {
"content": {
"application/json": {
"examples": {
"Available promotion limit is out of range": {
"$ref": "#/components/examples/422-promotion-out-of-range-available-user-limit"
},
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Ungültige Anfrage."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Werbeaktionslimit für angegebenen Benutzer erhöhen",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Legt fest, wie oft der angegebene Nutzer eine Werbeaktion innerhalb des geltenden Limits in Anspruch nehmen darf, nachdem das Limit erhöht oder herabgesetzt wurde.\n\nMit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" der gewünschten Werbeaktionsart:\n* [Rabattaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-discounts/)\n* [Bonusaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "set-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-user-limits-flexible"
},
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-user-promotion-limits"
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Artikel nicht gefunden."
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Ungültige Anfrage."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Werbeaktionslimit für angegebenen Benutzer festlegen",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/user/limit/promotion/id/{promotion_id}/all": {
"delete": {
"description": "Aktualisiert das Werbaaktionslimit, damit ein Nutzer diese Aktion erneut in Anspruch nehmen kann. Ist dem Parameter *user* der Wert `null` zugewiesen, wird das Limit für alle Nutzer aktualisiert.\n\nMit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen kann. Um das Nutzerlimit zu konfigurieren, wechseln Sie zum Abschnitt \"Verwaltung\" der gewünschten Werbeaktionsart:\n* [Rabattaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-discounts/)\n* [Bonusaktionen](https://developers.xsolla.com/de/api/shop-builder/tag/promotions-bonuses/)",
"operationId": "reset-user-promotion-limit",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/reset-user-limits-flexible"
},
"responses": {
"200": {
"description": "Das Werbeaktionslimit wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Common_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"Item not found": {
"$ref": "#/components/examples/404-promotion-by-id-not-found"
},
"User not found": {
"$ref": "#/components/examples/404-user-not-found"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Artikel nicht gefunden."
},
"422": {
"content": {
"application/json": {
"examples": {
"Invalid user_external_id": {
"$ref": "#/components/examples/422-user_external_id_invalid"
},
"Promotion does not have configured user limits": {
"$ref": "#/components/examples/422-promotion-without-user-limit"
}
},
"schema": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"errorMessageExtended": {
"type": "array"
},
"statusCode": {
"type": "integer"
},
"transactionId": {
"type": "string"
}
},
"type": "object"
}
}
},
"description": "Ungültige Anfrage."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Werbeaktionslimit für Benutzer aktualisieren",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/coupon/code/{coupon_code}/rewards": {
"get": {
"description": "Gets coupons rewards by its code.\nCan be used to allow users to choose one of many items as a bonus.\nThe usual case is choosing a DRM if the coupon contains a game as a bonus (`type=unit`).
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-coupon-rewards-by-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/coupon_code-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-coupon-rewards"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-rewards"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Gutscheinbelohnung abrufen",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/coupon/redeem": {
"post": {
"description": "Redeems a coupon code. The user gets a bonus after a coupon is redeemed.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "redeem-coupon",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_redeem-coupon-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-coupon-redeemed"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-redeem-coupon"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Gutscheincode einlösen",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/items/upsell": {
"get": {
"description": "Gets a list of upsell items in a project if they have already been set up.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-upsell-for-project-client",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Upsell-200-get-client-list"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Liste der Upselling-Artikel im Projekt abrufen",
"tags": [
"upsell-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/code/{promocode_code}/rewards": {
"get": {
"description": "Gets promo code rewards by its code.\nCan be used to allow users to choose one of many items as a bonus.\nThe usual case is choosing a DRM if the promo code contains a game as a bonus (`type=unit`).
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-promo-code-rewards-by-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promocode_code-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promocode-rewards"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-rewards"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Promocode-Belohnungen abrufen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/redeem": {
"post": {
"description": "Löst einen Promocode aus einer Werbeaktion ein.\nNach dem Einlösen eines Promocodes erhält der Nutzer kostenlose Artikel und/oder der Preis des Warenkorbs und/oder bestimmter Artikel wird reduziert.",
"operationId": "redeem-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_redeem-promo-code-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promo-code-redeemed"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-redeem-coupon"
}
},
"security": [
{
"AuthForCart": []
}
],
"summary": "Promocode einlösen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/remove": {
"put": {
"description": "Entfernt einen Promocode aus einem Warenkorb.\nNachdem der Promocode entfernt wurde, wird der Gesamtpreis aller Artikel im Warenkorb neu berechnet, ohne die durch einen Promocode sich ergebenden Boni und Rabatte.",
"operationId": "remove-cart-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_cancel-promo-code-model"
},
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-promo-code-canceled"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"422": {
"$ref": "#/components/responses/Promotions_422-cancel-promo-code"
}
},
"security": [
{
"AuthForCart": []
}
],
"summary": "Promocode aus Warenkorb entfernen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promotion/code/{code}/verify": {
"get": {
"description": "Determines if the code is a promo code or coupon code and if the user can apply it.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "verify-promotion-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/code-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-verify-promo-code"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"403": {
"$ref": "#/components/responses/Promotions_403-auth-header"
},
"404": {
"$ref": "#/components/responses/Promotions_404-verify-promo-code"
},
"422": {
"$ref": "#/components/responses/Promotions_422-verify-promo-code"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Aktionscode überprüfen",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/clan/contributors/{reward_chain_id}/top": {
"get": {
"description": "Retrieves the list of top 10 contributors to the specific reward chain under the current user's clan. If a user doesn't belong to a clan, the call returns an empty array.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-user-clan-top-contributors",
"parameters": [
{
"description": "Projekt-ID.",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"example": 44056,
"type": "integer"
}
},
{
"description": "Belohnungsketten-ID.",
"in": "path",
"name": "reward_chain_id",
"required": true,
"schema": {
"example": 101,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"clan": {
"summary": "Der Nutzer gehört einem Clan an",
"value": [
{
"contributed_amount": 555,
"name": "winner"
},
{
"contributed_amount": 398,
"name": "Rocket"
},
{
"contributed_amount": 201,
"name": "MrJoe"
},
{
"contributed_amount": 1,
"name": "beginner"
}
]
},
"without-clan": {
"summary": "Der Nutzer gehört keinem Clan an",
"value": []
}
},
"schema": {
"items": {
"properties": {
"contributed_amount": {
"description": "Die Anzahl der vom Nutzer beigesteuerten Wertpunkte.",
"example": 100,
"type": "integer"
},
"name": {
"description": "Benutzer-ID. Die ID, die während der Autorisierung an Xsolla gesendet wird und über die der Nutzer Ihrem Xsolla-Login-Projekt zugeordnet ist.",
"example": "Rocket",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "Die Top-10-Liste der Personen, die am meisten zur Clan-Belohnungskette beigetragen haben."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Top-10-Liste der Personen abrufen, die am meisten zur Clan-Belohnungskette beigetragen haben",
"tags": [
"clan-reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/clan/update": {
"put": {
"description": "Updates a current user's clan via user attributes. Claims all rewards from reward chains that were not claimed for a previous clan and returns them in the response. If the user was in a clan and now is not — their inclusion in the clan will be revoked. If the user changed the clan — the clan will be changed.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "user-clan-update",
"parameters": [
{
"description": "Projekt-ID.",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"default": 44056,
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-update-user-clan"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Den Clan des aktuellen Nutzers aktualisieren",
"tags": [
"clan-reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/daily_chain": {
"get": {
"description": "Client endpoint. Gets the current user's daily rewards.\nNotice
A method returns a paginated list of items. The maximum and default value is 50 items per response. To get more items from the list, use the limit and offset parameters and fetch more pages. For example, when calling a method with limit = 25 and offset = 100, the response returns 25 items starting from the 101st item in the overall list.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-daily-chains-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-daily-chains-list"
},
"401": {
"$ref": "#/components/responses/401-client-auth-error"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Tägliche Belohnungen des aktuellen Nutzers abrufen",
"tags": [
"daily-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/daily_chain/{daily_chain_id}": {
"get": {
"description": "Client endpoint. Gets the current user’s daily reward by its ID.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-user-daily-chain-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-daily-chain"
}
},
"schema": {
"$ref": "#/components/schemas/client-daily-chain-model"
}
}
},
"description": "Die tägliche Belohnung des Nutzers wurde erfolgreich abgerufen."
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Tägliche Belohnung des aktuellen Nutzers anhand der Belohnungs-ID abrufen",
"tags": [
"daily-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/daily_chain/{daily_chain_id}/step/number/{step_number}/claim": {
"post": {
"description": "Client endpoint. Claims the current user's step reward from a daily reward. All steps can only be claimed in sequential order. The reward for a missed step cannot be obtained for virtual or real currency, or by watching an ad
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "claim-user-daily-chain-step-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_id-path-param"
},
{
"$ref": "#/components/parameters/daily_chain_step_number-path-param"
}
],
"responses": {
"204": {
"description": "Schrittbelohnung des täglichen Belohnungsschritt wurde erfolgreich für den aktuellen Nutzer beansprucht."
},
"401": {
"$ref": "#/components/responses/401-client-auth-error"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-step-not-found"
},
"422": {
"content": {
"application/json": {
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-daily-chain-claim-error-invalid-step"
}
},
"schema": {
"$ref": "#/components/schemas/daily-chain-error-model"
}
}
},
"description": "Der Schritt kann nicht beansprucht werden."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Täglichen Belohnungsschritt beanspruchen",
"tags": [
"daily-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/offer_chain": {
"get": {
"description": "Gets the current user’s offer chains.\nNotice
All projects have a limit on the number of items that can be returned in a single response. The default and maximum value is 30 items per response. To get more data, use the limit and offset query parameters for pagination.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-offer-chains-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-offer-chains-list"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Angebotsketten des aktuellen Nutzers abrufen",
"tags": [
"offer-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}": {
"get": {
"description": "Gets the current user’s offer chain by the offer chain's ID.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-user-offer-chain-by-id",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-client-offer-chain"
}
},
"schema": {
"$ref": "#/components/schemas/client-offer-chain-model"
}
}
},
"description": "Die Angebotskette des Nutzers wurde erfolgreich abgerufen."
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Angebotskette des aktuellen Nutzers anhand der ID abrufen",
"tags": [
"offer-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/claim": {
"post": {
"description": "Completes the current user’s progression through the offer chain step and grants the associated reward.\n
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "claim-user-offer-chain-step-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_step_number-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"order_id": 641
}
}
},
"schema": {
"properties": {
"order_id": {
"description": "Bestell-ID.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Der kostenlose Schritt wurde erfolgreich in Anspruch genommen und die Belohnung gewährt."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-step-not-found"
},
"422": {
"content": {
"application/json": {
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-offer-chain-claim-error-invalid-step"
}
},
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
}
}
},
"description": "Der Schritt kann nicht in Anspruch genommen werden. Stellen Sie sicher, dass alle vorherigen Schritte abgeschlossen sind und der Schritt als kostenlos gekennzeichnet ist."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Kostenlosen Angebotskettenschritt sichern",
"tags": [
"offer-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/offer_chain/{offer_chain_id}/step/number/{step_number}/order": {
"post": {
"description": "Creates an order for the item associated with the specified paid offer chain step. The created order gets the `new` order status.\n\nTo open the payment UI in a new window, use the following link: `https://secure.xsolla.com/paystation4/?token={token}`, where `{token}` is the received token.\n\nFor testing purposes, use this URL: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\n\n
Notice \n This method must be used on the client side. The user's IP address is used to determine the country, which affects the currency and available payment methods. Using this method from the server side may result in incorrect currency detection and affect payment methods in
Pay Station.\n
\n\n\n
\n\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "order-user-offer-chain-step-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_id-path-param"
},
{
"$ref": "#/components/parameters/offer_chain_step_number-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Cart-Payment_200-order-created"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-step-not-found"
},
"422": {
"content": {
"application/json": {
"examples": {
"invalid-step": {
"$ref": "#/components/examples/422-offer-chain-claim-error-invalid-step"
}
},
"schema": {
"$ref": "#/components/schemas/offer-chain-error-model"
}
}
},
"description": "Der Schritt kann nicht erworben werden."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Bestellung für kostenpflichtigen Angebotskettenschritt anlegen",
"tags": [
"offer-chain-client",
"payment-client-side"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/reward_chain": {
"get": {
"description": "Client endpoint. Gets the current user’s reward chains.\n\n Attention
\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-reward-chains-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-reward-chains-list"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Belohnungsketten des aktuellen Nutzers abrufen",
"tags": [
"reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/balance": {
"get": {
"description": "Client endpoint. Gets the current user’s value point balance.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "get-user-reward-chain-balance",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-client-get-user-reward-chain-balance"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Wertpunktestand des aktuellen Nutzers abrufen",
"tags": [
"reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/step/{step_id}/claim": {
"post": {
"description": "Client endpoint. Claims the current user’s step reward from a reward chain.
\n Note
\n This API call uses a user JWT for authorization.
\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
",
"operationId": "claim-user-reward-chain-step-reward",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_step_id-path-param"
}
],
"responses": {
"204": {
"description": "Dem aktuellen Nutzer wurde die Schrittbelohnung aus einer Belohnungskette erfolgreich gewährt."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
},
"404": {
"$ref": "#/components/responses/404-reward-chain-step-not-found"
},
"422": {
"$ref": "#/components/responses/422-reward-chain-step-reward-can-not-claimed"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Schrittbelohnung gewähren",
"tags": [
"reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v3/project/{project_id}/admin/coupon": {
"get": {
"description": "Ruft die Liste der Gutscheinaktionen eines Projekts ab.",
"operationId": "get-coupons",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-coupons"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Gutscheinaktionen abrufen",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt eine Gutscheinaktion.",
"operationId": "admin-create-coupon",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_coupon-create"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
},
"schema": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
},
"type": "object"
}
}
},
"description": "Gutschein wurde erfolgreich erstellt."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Gutscheinaktionen erstellen",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/coupon/{external_id}": {
"delete": {
"description": "Löscht eine [Gutscheinaktion](https://developers.xsolla.com/de/doc/shop-builder/features/coupons/). Die gelöschte Werbeaktion:\n * verschwindet aus der Liste der in Ihrem Projekt eingerichteten Werbeaktionen.\n * wird nicht mehr auf den Artikelkatalog angewendet. Nutzer können im Rahmen dieser Werbeaktion keine Bonusartikel erhalten.\n\n Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.\n Gutscheincodes aus der gelöschten Werbeaktion können bestehenden Aktionen [hinzugefügt](https://developers.xsolla.com/de/api/shop-builder/operation/create-coupon-code/) werden.",
"operationId": "delete-coupon-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Gutscheinaktion wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Gutscheinaktion löschen",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft eine angegebene Gutscheinaktion ab.",
"operationId": "get-coupon",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"bonus": [
{
"quantity": 100,
"sku": "com.xsolla.diamonds_1"
}
],
"external_id": "summer20221",
"is_enabled": true,
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{
"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"redeem_code_limit": null,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
}
},
"schema": {
"$ref": "#/components/schemas/admin-promotions_200-get-coupon-promotion-model"
}
}
},
"description": "Gutschein wurde erfolgreich empfangen."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Gutscheinaktion abrufen",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert eine Gutscheinaktion.",
"operationId": "update-coupon-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_coupon-update"
},
"responses": {
"204": {
"description": "Gutschein wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Gutscheinaktion aktualisieren",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promocode": {
"get": {
"description": "Ruft die Liste der Promocodes eines Projekts ab.",
"operationId": "get-promo-codes",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-promocodes"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Promocode-Aktionen abrufen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt eine Promocode-Aktion.",
"operationId": "create-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_promocode-create"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
},
"schema": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
},
"type": "object"
}
}
},
"description": "Promocode wurde erfolgreich erstellt."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Promocode-Aktion erstellen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promocode/{external_id}": {
"delete": {
"description": "Löscht eine [Promocode-Aktion](https://developers.xsolla.com/de/doc/shop-builder/features/promo-codes/). Die gelöschte Werbeaktion:\n * verschwindet aus der Liste der in Ihrem Projekt eingerichteten Werbeaktionen.\n * wird nicht mehr auf den Artikelkatalog und den Warenkorb angewendet. Nutzer können im Rahmen dieser Werbeaktion keine Bonusartikel erhalten oder Artikel kaufen.\n\n Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.\n Promocodes aus der gelöschten Aktion können bestehenden Aktionen [hinzugefügt](https://developers.xsolla.com/de/api/shop-builder/operation/create-promo-code-code/) werden.",
"operationId": "delete-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Die Promocode-Aktion wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Promocode löschen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft eine angegebene Promocode-Aktion ab.",
"operationId": "get-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"simple": {
"value": {
"bonus": [
{
"quantity": 100,
"sku": "com.xsolla.diamonds_1"
}
],
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"excluded_promotions": [
23,
45
],
"external_id": "summer20221",
"is_enabled": true,
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{
"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
},
"with item price conditions": {
"value": {
"bonus": [
{
"quantity": 100,
"sku": "com.xsolla.diamonds_3"
}
],
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"excluded_promotions": [
23,
45
],
"external_id": "summer20221",
"is_enabled": true,
"item_price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "50.0000"
}
],
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
},
"with price conditions": {
"value": {
"bonus": [
{
"quantity": 100,
"sku": "com.xsolla.diamonds_2"
}
],
"discount": {
"percent": "10.99"
},
"discounted_items": null,
"external_id": "summer20221",
"is_enabled": true,
"name": {
"en-US": "Coupon name",
"ru-RU": "Название купона"
},
"price_conditions": [
{
"operator": "gt",
"value": "10.0000"
},
{
"operator": "lt",
"value": "50.0000"
}
],
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": null,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Promotions_200-get-promocode-promotion-model"
}
}
},
"description": "Promocode wurde erfolgreich empfangen."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Promocode-Aktion abrufen",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert eine Promocode-Aktion.",
"operationId": "update-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_promocode-update"
},
"responses": {
"204": {
"description": "Promocode wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Promocode-Aktion aktualisieren",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion": {
"get": {
"description": "Ruft die Liste der Werbeaktionen eines Projekts ab.",
"operationId": "get-promotion-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-promotions"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste aller Werbeaktionen abrufen",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/bonus": {
"get": {
"description": "Ruft die Liste der Bonusaktionen eines Projekts ab.\n\nDie Werbeaktion gewährt dem Nutzer beim Kauf zusätzlich kostenlose Bonusartikel.\nDie Werbeaktion kann bei jedem Kauf innerhalb eines Projekts oder bei einem Kauf, der bestimmte Artikel umfasst, gelten.",
"operationId": "get-bonus-promotion-list",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-bonus-promotions"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Bonusaktionen abrufen",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt die Bonusaktion.\n\nDie Werbeaktion gewährt dem Nutzer beim Kauf zusätzlich kostenlose Bonusartikel.\nDie Werbeaktion kann bei jedem Kauf innerhalb eines Projekts oder bei einem Kauf, der bestimmte Artikel umfasst, gelten.",
"operationId": "create-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-bonus-promotion"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-create-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Bonusaktion erstellen",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/item": {
"get": {
"description": "Ruft die Liste der Artikelaktionen eines Projekts ab.\n\nWerbeaktionen gewähren einen Rabatt (in %) auf Artikel.\nDer Rabatt wird auf alle Preise der angegebenen Artikel angewendet.",
"operationId": "get-item-promotion-list",
"parameters": [
{
"description": "Projekt-ID.",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"default": 59080,
"type": "integer"
}
},
{
"description": "Begrenzung der Elementanzahl auf der Seite.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).",
"in": "query",
"name": "offset",
"required": false,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-item-promotions"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Artikelaktionen abrufen",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt eine Rabattaktion für einen Artikel.\n\nWerbeaktionen gewähren einen Rabatt (in %) auf Artikel.\nDer Rabatt wird auf alle Preise der angegebenen Artikel angewendet.",
"operationId": "create-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-item-promotion"
},
"responses": {
"201": {
"$ref": "#/components/responses/Promotions_201-create-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-items-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Rabattaktion für Artikel erstellen",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/redeemable/code/{code}": {
"get": {
"description": "Ruft die Werbeaktion anhand eines Promocodes oder Gutscheincodes ab.",
"operationId": "get-redeemable-promotion-by-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/code-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-redeemable-by-code"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-code-not-found"
},
"405": {
"$ref": "#/components/responses/405-method-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Werbeaktion anhand von einlösbarem Code abrufen",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/{promotion_id}/bonus": {
"delete": {
"description": "Löscht [Bonusaktion](https://developers.xsolla.com/de/doc/shop-builder/features/bonuses/). Die gelöschte Werbeaktion:\n * verschwindet aus der Liste der in Ihrem Projekt eingerichteten Werbeaktionen.\n * wird nicht mehr auf den Artikelkatalog und den Warenkorb angewendet. Nutzer können im Rahmen dieser Werbeaktion keine Bonusartikel erhalten.\n\n Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.",
"operationId": "delete-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Die Werbeaktion wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Bonusaktion löschen",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft die Bonusaktion ab.\n\nDie Werbeaktion gewährt dem Nutzer beim Kauf zusätzlich kostenlose Bonusartikel.\nDie Werbeaktion kann bei jedem Kauf innerhalb eines Projekts oder bei einem Kauf, der bestimmte Artikel umfasst, gelten.",
"operationId": "get-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-admin-get-bonus-promotion"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Bonusaktion abrufen",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert die Werbeaktion.\n\nHinweis
Neue Daten ersetzen alte Daten. Auch wenn Sie nur einen Teil einer Werbeaktion aktualisieren möchten, sollten Sie alle erforderlichen Daten in der Anfrage übermitteln.
\n\nDie Werbeaktion gewährt dem Nutzer beim Kauf zusätzlich kostenlose Bonusartikel.\nDie Werbeaktion kann bei jedem Kauf innerhalb eines Projekts oder bei einem Kauf, der bestimmte Artikel umfasst, gelten.",
"operationId": "update-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-bonus-promotion"
},
"responses": {
"204": {
"description": "Die Werbeaktion wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Bonusaktion aktualisieren",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/{promotion_id}/item": {
"delete": {
"description": "Löscht eine [Rabattaktion](https://developers.xsolla.com/de/doc/shop-builder/features/discounts/). Die gelöschte Aktion:\n * verschwindet aus der Liste der in Ihrem Projekt eingerichteten Werbeaktionen.\n * wird nicht mehr auf den Artikelkatalog und den Warenkorb angewendet. Nutzer können im Rahmen dieser Werbeaktion keine Artikel kaufen.\n\n Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.",
"operationId": "delete-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Die Werbeaktion wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Artikelaktion löschen",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft die für einen bestimmten Artikel geltende Werbeaktion ab.\n\nWerbeaktionen gewähren einen Rabatt (in %) auf Artikel.\nDer Rabatt wird auf alle Preise der angegebenen Artikel angewendet.",
"operationId": "get-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"discount": {
"percent": "20.00"
},
"excluded_promotions": [
23,
45
],
"id": 1,
"is_enabled": true,
"items": [
{
"sku": "com.xsolla.elven_helmet_1"
},
{
"sku": "com.xsolla.elven_armor_1"
}
],
"limits": {
"per_item": null,
"per_user": {
"total": 10
},
"recurrent_schedule": {
"per_user": {
"day_of_month": null,
"day_of_week": null,
"displayable_reset_next_date": "2023-02-28T11:00:00+08:00",
"displayable_reset_start_date": "2023-02-28T11:00:00+08:00",
"interval_type": "daily",
"reset_next_date": 1677553200,
"time": "11:00:00+08:00"
}
}
},
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"price_conditions": [
{
"operator": "ge",
"value": "10.0000"
},
{
"operator": "le",
"value": "50.0000"
}
],
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
}
}
},
"schema": {
"example": {
"discount": {
"percent": "15.00"
},
"id": 1,
"is_enabled": true,
"items": [
{
"sku": "com.xsolla.elven_sword_1"
},
{
"sku": "com.xsolla.elven_helmet_1"
},
{
"sku": "com.xsolla.elven_armor_1"
}
],
"name": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
}
]
},
"properties": {
"attribute_conditions": {
"$ref": "#/components/schemas/promotion_user-attribute_conditions_model-get"
},
"discount": {
"properties": {
"percent": {
"default": "10.00",
"description": "Prozentualer Rabatt.\nDer Preis des Artikels wird um einen Wert verringert, der anhand dieses Prozentsatzes berechnet wird.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
},
"id": {
"description": "Werbeaktions-ID. Eindeutige Werbeaktionskennung innerhalb des Projekts.",
"type": "integer"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_is_enabled"
},
"items": {
"items": {
"description": "Die Liste der Artikel, bei denen der Rabatt greift.",
"properties": {
"sku": {
"default": "elven_sword",
"description": "Artikel-SKU.",
"type": "string"
}
},
"type": "object"
},
"type": [
"array",
"null"
]
},
"limits": {
"$ref": "#/components/schemas/Promotions_promotion_limits_response"
},
"name": {
"additionalProperties": {
"example": {
"en-US": "Promotion",
"ru-RU": "Акция"
},
"type": "string"
},
"description": "Name der Werbeaktion. Sollte Schlüssel-Wert-Paare enthalten,\nwobei der Schlüssel ein Gebietsschema im Format \"^[a–z]{2}-[A–Z]{2}$\" und der Wert ein String ist.",
"type": "object"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_discount"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
}
},
"type": "object"
}
}
},
"description": "Die Artikelaktion wurde erfolgreich empfangen."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 9502,
"errorMessage": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080",
"statusCode": 404
}
}
},
"schema": {
"properties": {
"errorCode": {
"example": 9502,
"type": "integer"
},
"errorMessage": {
"example": "[0401-9502]: Can not find promotion with ID = 111425 in project 59080",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Werbeaktion nicht gefunden. Prüfen Sie, ob die `promotion_id` korrekt ist."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Artikelaktion abrufen",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert die Werbeaktion.\n\nHinweis
Neue Daten ersetzen alte Daten. Auch wenn Sie nur einen Teil einer Werbeaktion aktualisieren möchten, sollten Sie alle erforderlichen Daten in der Anfrage übermitteln.
\n\nWerbeaktionen gewähren einen Rabatt (in %) auf Artikel.\nDer Rabatt wird auf alle Preise der angegebenen Artikel angewendet.",
"operationId": "update-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_create-update-item-promotion"
},
"responses": {
"204": {
"description": "Die Werbeaktion wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-items-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Artikelaktion aktualisieren",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain": {
"get": {
"description": "Ruft die Liste der Belohnungsketten ab.\n\nAchtung
Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 10 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.
",
"operationId": "admin-get-reward-chains",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/enabled-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-list-reward-chains"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste der Belohnungsketten abrufen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt eine Belohnungskette.",
"operationId": "admin-create-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-reward-chain"
},
"responses": {
"201": {
"$ref": "#/components/responses/201-admin-create-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Belohnungskette erstellen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}": {
"delete": {
"description": "Löscht eine bestimmte Belohnungskette.",
"operationId": "admin-delete-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-delete-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Belohnungskette löschen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft eine bestimmte Belohnungskette ab.",
"operationId": "admin-get-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/200-admin-get-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-admin-reward-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Belohnungskette abrufen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert eine bestimmte Belohnungskette.",
"operationId": "admin-update-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/update-reward-chain"
},
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-update-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-admin-reward-chain-not-found"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Belohnungskette aktualisieren",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/reset": {
"post": {
"description": "Resets the value points balance and progress of all users in the reward chain.
The balance is tied to the value points type, not to a specific reward chain. If these value points are used in other chains, the balance will be reset in all chains that use these value points.
After the reset, you can update the reward chain’s validity period, and users will be able to progress through it again.
The clan balance is calculated as the sum of its members’ balances. Therefore, after the reset, the clan balance is also reset.
This request is irreversible and applies to all users of the project.\n\nNotice\n
\n You should not reset the reward chain during its validity period. In this case, users may lose earned value points before they claim their reward.\n
",
"operationId": "admin-reset-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-reset-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Belohnungskette zurücksetzen",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain/id/{reward_chain_id}/toggle": {
"put": {
"description": "Aktiviert/deaktiviert die Belohnungskette.",
"operationId": "admin-toggle-reward-chain",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/reward_chain_id-path-param"
}
],
"responses": {
"204": {
"$ref": "#/components/responses/204-admin-toggle-reward-chain"
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Belohnungskette aktivieren/deaktivieren",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/unique_catalog_offer": {
"get": {
"description": "Ruft die Liste der Katalogsonderangebote eines Projekts ab.",
"operationId": "get-unique-catalog-offers",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/Promotions_200-get-unique-catalog-offers"
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Liste von Katalogsonderangeboten abrufen",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Erstellt ein Katalogsonderangebot.",
"operationId": "admin-create-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_unique_catalog_offer-create"
},
"responses": {
"201": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"external_id": "coupon_external_id"
}
}
},
"schema": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Promotions_coupon-external_id"
}
},
"type": "object"
}
}
},
"description": "Katalogsonderangebot wurde erfolgreich erstellt."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogsonderangebot erstellen",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/unique_catalog_offer/{external_id}": {
"delete": {
"description": "Löscht eine [einmalige Katalogsonderangebotsaktion](https://developers.xsolla.com/de/doc/shop-builder/features/unique-offer/). Die gelöschte Werbeaktion:\n * verschwindet aus der Liste der in Ihrem Projekt eingerichteten Werbeaktionen.\n * wird nicht mehr auf den Artikelkatalog und den Warenkorb angewendet. Der Nutzer können im Rahmen dieser Werbeaktion keine Artikel kaufen.\n\n Nach der Löschung kann die Werbeaktion nicht wiederhergestellt werden.",
"operationId": "delete-unique-catalog-offer-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Katalogsonderangebot wurde erfolgreich gelöscht."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogsonderangebotsaktion löschen",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Ruft das angegebene Katalogsonderangebot ab.",
"operationId": "get-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"external_id": "secret_shop",
"is_enabled": true,
"items": [
"helmet",
"sword",
"shield"
],
"name": {
"en-US": "Secret shop",
"ru-RU": "Секретный магазин"
},
"promotion_periods": [
{
"date_from": "2020-04-15T18:16:00+05:00",
"date_until": "2020-04-25T18:16:00+05:00"
},
{
"date_from": "2020-05-15T18:16:00+05:00",
"date_until": "2020-05-25T18:16:00+05:00"
}
],
"redeem_code_limit": 1,
"redeem_total_limit": 100,
"redeem_user_limit": 1,
"total_limit_state": {
"available": 50,
"reserved": 10,
"used": 40
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Promotions_200-get-unique-catalog-offer-promotion-model"
}
}
},
"description": "Das Katalogsonderangebot wurde erfolgreich abgerufen."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogsonderangebot abrufen",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Aktualisiert das Katalogsonderangebot.",
"operationId": "update-unique-catalog-offer-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/Promotions_unique_catalog_offer-update"
},
"responses": {
"204": {
"description": "Das Katalogsonderangebot wurde erfolgreich aktualisiert."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Katalogsonderangebot aktualisieren",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
}
},
"servers": [
{
"url": "https://store.xsolla.com/api"
}
],
"tags": [
{
"description": "Promotions are marketing tools designed to attract new users and increase sales. Using Xsolla API, you can configure the following promotions:\n\n* Discounts — reduced prices on selected items.\n* Bonuses — items granted to users along with their purchase.\n* Coupons — codes that allow users to receive one or more bonus items when redeeming.\n* Promo codes — codes that allow users to receive bonus items, a discount on a specific item, or a discount on the entire cart. Unlike coupons that are redeemed after the user enters them, promo codes are redeemed during a purchase (at checkout).\n* Unique offers — hidden items displayed in the catalog to users who have entered a unique offer code. If the code is not entered, the items are not displayed.\n\nExample flow for configuring a discount promotion:\n1. Create items using the calls from the **Admin** subsection of the [Virtual items and currency](/de/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/de/api/catalog/bundles-admin/admin-create-bundle), or [Game keys](/de/api/catalog/game-keys-admin) groups.\n2. Create a promotion using the [Create discount promotion for item](/de/api/liveops/promotions-discounts/create-item-promotion/) call. In the `items` array, pass the necessary item SKUs.\n3. Set up promotion validity periods. To do this, call the [Create discount promotion for item](/de/api/liveops/promotions-discounts/create-item-promotion/) or [Update item promotion](/de/api/liveops/promotions-discounts/update-item-promotion/) methods, and pass the `promotion_periods` field as an array of objects where `date_from` defines the start, and `date_until` defines the end date of the validity period.\n4. Activate a promotion using the [Update item promotion](/de/api/liveops/promotions-discounts/update-item-promotion/) call. Pass the `\"is_enabled\": true` parameter.\n5. To get information about item prices, including discounted prices, call the client API methods for getting an item catalog from the [Common > Catalog](/de/api/catalog/tag/common-catalog/), [Virtual Items and Currency > Catalog](/de/api/catalog/virtual-items-currency-catalog/get-virtual-items/), and [Bundles > Catalog](/de/api/catalog/bundles-catalog/get-bundle-list/) subsections.\n\n\n\nRefer to our documentation for detailed information about configuring promotions:\n* [Discounts](https://developers.xsolla.com/de/liveops/promotion-tools/discounts/)\n* [Bonuses](https://developers.xsolla.com/de/liveops/promotion-tools/bonuses/)\n* [Coupons](https://developers.xsolla.com/de/liveops/promotion-tools/coupons/)\n* [Promo codes](https://developers.xsolla.com/de/liveops/promotion-tools/promo-codes/)\n* [Unique catalog offers](https://developers.xsolla.com/de/liveops/promotion-tools/unique-offer/)",
"name": "promotions-overview",
"x-displayName": "Overview"
},
{
"description": "You can call API methods from this subsection to manage different types of promotions.",
"name": "promotions-common",
"x-displayName": "Common API calls"
},
{
"description": "Call API methods from this subsection to configure and manage coupon promotions.\n\n\n
Note
\n
Refer to our documentation for detailed information about coupons.
\n
\n
Note
\n
Refer to our documentation for detailed information about promo codes.
\n
\n
Note
\n
Refer to our documentation for detailed information about unique offers.
\n
\n
Note
\n
Refer to our documentation for detailed information about discounts.
\n
\n
Note
\n
Refer to our documentation for detailed information about bonuses.
\n
\n
Note\n You can use only one personalization type. To change it, follow the\n
instructions.\n
\n
Note\nDetailed information is provided:\n
\n