` 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](/pt/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](/pt/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/pt/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/pt/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/pt/api/catalog/)\n- [API keys](https://developers.xsolla.com/pt/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](/pt/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](/pt/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](/pt/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/pt/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/pt/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](/pt/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/pt/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/pt/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](/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/pt/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/pt/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/pt/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](/pt/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](/pt/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/pt/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](/pt/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](/pt/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](/pt/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/pt/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](/pt/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](/pt/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](/pt/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](/pt/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
Aviso
Um método retorna uma lista paginada de itens. O valor máximo e padrão é de 50 itens por resposta. Para obter mais itens da lista, use os parâmetros `limit` e `offset`, e busque mais páginas. Por exemplo, ao chamar um método com 'limit = 25' e 'offset = 100', a resposta retorna 25 itens a partir do 101º item na lista geral.
",
"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": "Obter lista de recompensas diárias",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria uma recompensa diária.",
"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": "Criar recompensa diária",
"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": "Exclui uma recompensa diária específica.",
"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": "Recompensa diária excluída com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir recompensa diária",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém uma cadeia de recompensas específica para administração.",
"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": "Obter recompensa diária",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza uma recompensa diária específica.",
"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": "Recompensa diária atualizada com sucesso."
},
"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": "Atualizar recompensa diária",
"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": "Redefine o progresso para todos os usuários na recompensa diária. Aplica-se apenas a recompensas diárias do tipo `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": "A recompensa diária foi redefinida."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Redefinir recompensa diária",
"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": "Ativa ou desativa uma recompensa diária.",
"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": "A recompensa diária foi desativada ou ativada."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Alternar recompensa diária",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/upsell": {
"get": {
"description": "Recupera as informações sobre a venda cruzada no projeto: se está habilitado, o tipo de venda cruzada e a lista de SKUs de itens que fazem parte dessa venda cruzada.",
"operationId": "get-upsell-configurations-for-project-admin",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"upsell": {
"summary": "Projeto tem venda cruzada",
"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": "Se a venda cruzada está habilitada para o projeto.",
"example": true,
"type": "boolean"
},
"items": {
"description": "A lista de SKUs de itens que fazem parte da venda cruzada no projeto.",
"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": "Chaves de jogo para diferentes DRMs.",
"items": {
"description": "Item de chave de jogo. Ele representa o jogo em uma determinada plataforma (Steam, GOG, etc.).",
"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": "O tipo de venda cruzada.",
"enum": [
"fixed_list",
"most_sellable",
"only_promotions"
],
"example": "fixed_list",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "A lista de detalhes de configuração e itens usados para venda cruzada no projeto."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Obter informações sobre venda cruzada no projeto",
"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": "A venda cruzada foi criada para o projeto."
},
"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": "Criar venda cruzada",
"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": "A venda cruzada foi atualizada para o projeto."
},
"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": "Atualizar venda cruzada",
"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": "Status de ativação.",
"in": "path",
"name": "toggle",
"required": true,
"schema": {
"example": "activate",
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Uma venda cruzada em um projeto foi ativada ou desativada."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Ativar/desativar a venda cruzada do projeto",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/value_points": {
"get": {
"description": "Obtém a lista de pontos de valor dentro de um projeto para administração.",
"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": "Obter lista de pontos de valor",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria um ponto de valor.",
"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": "Criar ponto de valor",
"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": "Exclui um ponto de valor identificado por um SKU.",
"operationId": "admin-delete-value-point",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Ponto de valor excluído com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir pontos de valor",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém um ponto de valor pelo SKU dentro de um projeto para administração.",
"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": "Obter ponto de valor",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza um ponto de valor identificado por um SKU.",
"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": "Ponto de valor atualizado com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Atualizar ponto de valor",
"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": "Remove recompensas de pontos de valor de TODOS os itens.",
"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": "As recompensas de pontos de valor para itens foram excluídas com êxito."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir pontos de valor de itens",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém a lista de todos os itens com pontos de valor dentro de um projeto para administração.",
"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": "Obter lista de itens com pontos de valor",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"patch": {
"description": "Atualiza parcialmente o número de pontos de valor para um ou mais itens pelo SKU do item. Os usuários recebem esses pontos de valor após a compra dos itens especificados.\n\nPrincípios de atualização de pontos de valor:\n * Se um item ainda não tiver pontos de valor, enviar um valor diferente de zero no campo `amount` os criará.\n * Se um item já tiver pontos de valor, o envio de um valor diferente de zero no campo `amount` os atualizará.\n * Se `amount` for definido como 0, os pontos de valor existentes para esse item serão excluídos.\n\nAo contrário do método `PUT` ([Definir pontos de valor para itens](https://developers.xsolla.com/pt/api/shop-builder/operation/admin-set-items-value-point-reward/)), este método `PATCH` não sobrescreve todos os pontos de valor existentes dos itens no projeto, apenas atualiza os itens especificados.\n\nUma única solicitação pode atualizar até 100 itens. SKUs de itens duplicados não podem ser incluídos na mesma solicitação.",
"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": "As recompensas de pontos de valor para itens foram atualizadas com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Atualizar parcialmente os pontos de valor dos itens",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atribui pontos de valor a um ou vários itens por um SKU. Os usuários recebem pontos de valor depois de comprar esses itens.\n\nObserve que essa solicitação PUT substitui todos os pontos de valor definidos anteriormente para itens no projeto.\n\nPara evitar a exclusão não intencional de pontos de valor, inclua todos os itens e seus respectivos pontos de valor em cada solicitação PUT.\n\nSe desejar atualizar apenas os pontos de valor de um item específico, preservando os pontos de valor de outros itens, recupere o conjunto atual de pontos de valor usando uma solicitação GET, modifique os pontos de valor do item desejado e envie o conjunto modificado de pontos de valor de volta com os pontos de valor atualizados para o item específico.",
"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": "As recompensas de pontos de valor para itens foram atualizadas com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Definir pontos de valor para itens",
"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": "Obtém a lista de cadeias de ofertas para administração.\nAviso
Todos os projetos têm um limite no número de itens que podem ser retornados em uma única resposta. O valor padrão e máximo é de 10 itens por resposta. Para obter mais dados, use os parâmetros de consulta limit e offset para a paginação.
",
"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": "Obter lista de cadeias de ofertas",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria uma cadeia de ofertas.",
"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": "Criar cadeia de ofertas",
"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": "Exclui uma cadeia de ofertas específica.\n\nApós a exclusão:- Todas as recompensas já recebidas pelos usuários são retidas.
- Etapas não concluídas ficam indisponíveis e suas recompensas não podem mais ser obtidas.
\n\nAo contrário de desabilitar a cadeia de ofertas por meio da chamada da chamada Alternar cadeia de ofertas, a exclusão é irreversível e o progresso do usuário não é preservado.",
"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": "Cadeia de ofertas excluída com sucesso."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir cadeia de ofertas",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém uma cadeia de ofertas específica para administração.",
"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": "Obter cadeia de ofertas",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza uma cadeia de ofertas específica.",
"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": "A cadeia de ofertas foi atualizada com sucesso."
},
"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": "Atualizar cadeia de ofertas",
"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": "Habilita ou desabilita uma cadeia de ofertas.\n\nQuando a cadeia de ofertas é desativada, os usuários perdem temporariamente o acesso a ela, mas seu progresso é preservado.\n\nDepois que a cadeia de ofertas for reativada, os usuários poderão continuar da etapa de onde pararam.",
"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": "A cadeia de ofertas foi desativada/ativada."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Alternar cadeia de ofertas",
"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": "Ativa uma promoção de código promocional.\n\nA promoção de código promocional criada inicia desativada por padrão.\nEle não estará pronto para resgate até que você o ative.\nUse esse ponto de extremidade para habilitar e ativar uma promoção de código promocional.",
"operationId": "activate-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "O código promocional foi ativado com sucesso."
},
"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": "Ativar promoção de código promocional",
"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": "Obtém códigos de uma promoção de código promocional.",
"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": "Obter códigos de promoção de código promocional",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria código para uma promoção de código promocional.",
"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": "Criar código para promoção de código promocional",
"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": "Gera códigos para uma promoção de código promocional.",
"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": "Os códigos foram gerados com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Gerar códigos para promoção de código promocional",
"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": "Desativa uma promoção de código promocional.\n\nA promoção de código promocional criada inicia desativada por padrão.\nEle não estará pronto para resgate até que você o ative.\nUse esse ponto de extremidade para desabilitar e desativar uma promoção de código promocional.",
"operationId": "deactivate-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "O cupom foi desativado com sucesso."
},
"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": "Desativar promoção de código promocional",
"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": "Ativa uma promoção.",
"operationId": "activate-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "A promoção foi ativada com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Ativar promoção",
"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": "Desativa uma promoção.",
"operationId": "deactivate-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Promoção desativada com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Desativar promoção",
"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": "Ativa uma promoção de oferta de catálogo exclusiva.\nA promoção de oferta de catálogo exclusiva criada está desativada por padrão.\nEle não pode ser resgatado até que você o ative.\nUse esse ponto de extremidade para habilitar e ativar uma promoção de cupom.",
"operationId": "activate-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "A oferta de catálogo exclusiva foi ativada com êxito."
},
"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": "Ativar promoção de oferta de catálogo exclusiva",
"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": "Obtém códigos de oferta de catálogo exclusivos.",
"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": "Obtenha códigos de oferta de catálogo exclusivos",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria um código de oferta de catálogo exclusivo.",
"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": "Criar código de oferta de catálogo exclusivo",
"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": "Gera códigos de oferta de catálogo exclusivos.",
"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": "Os códigos foram gerados com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Gerar códigos de oferta de catálogo exclusivos",
"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": "Desativa uma promoção exclusiva de oferta de catálogo.\nA promoção exclusiva de oferta de catálogo criada está desativada por padrão.\nEla não pode ser resgatada até que você a ative.\nUse esse ponto de extremidade para desativar e desativar uma promoção de cupom.",
"operationId": "deactivate-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "A oferta de catálogo exclusiva foi desativada com êxito."
},
"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": "Desativar promoção exclusiva de oferta de catálogo",
"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": "Obtém todas as regras aplicadas aos atributos do usuário.",
"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": "Se existir outra página com regras.",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog"
},
"type": "array"
},
"total_items_count": {
"description": "Número total de regras.",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "As regras foram recebidas com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter lista de regras de filtro de catálogo",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Criar regra para atributos de usuário.",
"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": "ID da regra.",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "Regra criada com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Criar regra de filtro de catálogo",
"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": "Obtém uma lista de todas as regras de catálogo para pesquisa no lado do cliente.\nAtenção
Retorna apenas ID de regra, nome e is_enabled
",
"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": "As regras foram recebidas com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter todas as regras de catálogo para pesquisa no lado do cliente",
"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": "Exclui uma regra específica.",
"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": "Exclusão bem-sucedida."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Regra de filtro de exclusão de catálogo",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtenha regras específicas aplicáveis aos atributos do usuário.",
"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": "Regra recebida com sucesso."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter regra de filtro de catálogo",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"patch": {
"description": "Atualiza uma regra específica que se aplica aos atributos do usuário. O valor atual será usado para uma propriedade não especificada.",
"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": "Atualização bem-sucedida."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Regra de filtro do catálogo de atualizações",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza uma regra específica que se aplica aos atributos do usuário. O valor padrão será usado para uma propriedade não especificada (se a propriedade não for necessária).",
"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": "Atualização bem-sucedida."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Atualizar regra de filtro de catálogo",
"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": "Obtém o número restante de vezes que o usuário especificado pode usar o cupom.\n\nA API User limit permite limitar o número de vezes que os usuários podem usar um cupom. Para configurar o próprio limite de usuário, vá para a seção Admin:\n* [Cupons](https://developers.xsolla.com/pt/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": "Item não encontrado."
},
"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": "Solicitação inválida."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter limite de cupons de um usuário específico",
"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": "Obtém o número restante de vezes que o usuário especificado pode usar o código promocional.\n\nA API User limit permite limitar o número de vezes que os usuários podem usar um código promocional. Para configurar o limite de usuário em si, vá para a seção Admin:\n* [Códigos Promocionais](https://developers.xsolla.com/pt/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": "Item não encontrado."
},
"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": "Solicitação inválida."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter limite de código promocional para o usuário especificado",
"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": "Atualiza todos os limites em todas as promoções para o usuário especificado para que ele possa usar essas promoções novamente.\n\nA API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:\n* [Promoções de Desconto](https://developers.xsolla.com/pt/api/shop-builder/tag/promotions-discounts/)\n* [Promoções de Bônus](https://developers.xsolla.com/pt/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": "O limite da promoção foi atualizado com sucesso."
},
"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": "Item não encontrado."
},
"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": "Solicitação inválida."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Atualizar todos os limites de promoção para o usuário especificado",
"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": "Diminui o número restante de vezes que o usuário especificado pode usar uma promoção dentro do limite aplicado.\n\nA API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:\n* [Promoções de Desconto](https://developers.xsolla.com/pt/api/shop-builder/tag/promotions-discounts/)\n* [Promoções de Bônus](https://developers.xsolla.com/pt/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": "Item não encontrado."
},
"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": "Solicitação inválida."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Diminuir o limite de promoção para o usuário especificado",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém o número restante de vezes que o usuário especificado pode usar a promoção dentro do limite aplicado.\n\nA API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:\n* [Promoções de Desconto](https://developers.xsolla.com/pt/api/shop-builder/tag/promotions-discounts/)\n* [Promoções de Bônus](https://developers.xsolla.com/pt/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": "Item não encontrado."
},
"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": "Solicitação inválida."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter limite de promoção para o usuário especificado",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Aumenta o número restante de vezes que o usuário especificado pode usar a promoção dentro do limite aplicado.\n\nA API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:\n* [Promoções de Desconto](https://developers.xsolla.com/pt/api/shop-builder/tag/promotions-discounts/)\n* [Promoções de Bônus](https://developers.xsolla.com/pt/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": "Item não encontrado."
},
"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": "Solicitação inválida."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Aumentar o limite de promoção para o usuário especificado",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Define o número de vezes que o usuário especificado pode usar uma promoção dentro do limite aplicado depois que ela foi aumentada ou diminuída.\n\nA API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:\n* [Promoções de Desconto](https://developers.xsolla.com/pt/api/shop-builder/tag/promotions-discounts/)\n* [Promoções de Bônus](https://developers.xsolla.com/pt/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": "Item não encontrado."
},
"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": "Solicitação inválida."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Definir limite de promoção para o usuário especificado",
"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": "Atualiza o limite da promoção para que um usuário possa usar essa promoção novamente. Se o parâmetro *user* for `null`, essa chamada atualizará esse limite para todos os usuários.\n\nA API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:\n* [Promoções de Desconto](https://developers.xsolla.com/pt/api/shop-builder/tag/promotions-discounts/)\n* [Promoções de Bônus](https://developers.xsolla.com/pt/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": "O limite da promoção foi atualizado com sucesso."
},
"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": "Item não encontrado."
},
"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": "Solicitação inválida."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Atualizar limite de promoção para usuários",
"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": "Obter recompensas de cupom",
"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": "Resgatar código de cupom",
"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": "Obter lista de itens de venda cruzada no projeto",
"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": "Obter recompensas de código promocional",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/redeem": {
"post": {
"description": "Resgata um código promocional de promoção.\nDepois de resgatar um código promocional, o usuário receberá itens gratuitos e/ou o preço do carrinho e/ou itens específicos será diminuído.",
"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": "Resgatar código promocional",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/remove": {
"put": {
"description": "Remove um código promocional de um carrinho.\nDepois que o código promocional for removido, o preço total de todos os itens no carrinho será recalculado sem bônus e descontos fornecidos por um código promocional.",
"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": "Remover código promocional do carrinho",
"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": "Verificar o código promocional",
"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": "ID do projeto.",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"example": 44056,
"type": "integer"
}
},
{
"description": "ID da cadeia de recompensas.",
"in": "path",
"name": "reward_chain_id",
"required": true,
"schema": {
"example": 101,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"clan": {
"summary": "O usuário tem um clã",
"value": [
{
"contributed_amount": 555,
"name": "winner"
},
{
"contributed_amount": 398,
"name": "Rocket"
},
{
"contributed_amount": 201,
"name": "MrJoe"
},
{
"contributed_amount": 1,
"name": "beginner"
}
]
},
"without-clan": {
"summary": "O usuário não pertence a um clã",
"value": []
}
},
"schema": {
"items": {
"properties": {
"contributed_amount": {
"description": "A quantidade de pontos de valor contribuídos pelo usuário.",
"example": 100,
"type": "integer"
},
"name": {
"description": "ID de usuário. Este é o ID enviado à Xsolla durante a autorização e vincula o usuário ao seu projeto Xsolla Login.",
"example": "Rocket",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "A lista dos 10 principais contribuintes para a cadeia de recompensas do clã."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Obter os 10 maiores contribuintes da cadeia de recompensas no clã",
"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": "ID do projeto.",
"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": "Atualizar o clã do usuário atual",
"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": "Obter recompensas diárias do usuário atual",
"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": "As recompensa diária do usuário foi recuperada com sucesso."
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Obtém a recompensa diária do usuário atual por seu ID",
"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": "Resgatou a recompensa de etapa do usuário atual por uma etapa de recompensa diária com sucesso."
},
"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": "A etapa não pode ser resgatada."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Resgatar etapa da recompensa diária",
"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": "Obtenha as cadeias de ofertas do usuário atual",
"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": "A cadeia de ofertas do usuário foi recuperada com sucesso."
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Obter a cadeia de ofertas do usuário atual por ID",
"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": "ID de pedido.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "A etapa gratuita foi resgatada com sucesso e a recompensa concedida."
},
"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": "A etapa não pode ser resgatada. Certifique-se de que todas as etapas anteriores foram concluídas e que a etapa está marcada como gratuita."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Resgate a etapa da cadeia de oferta gratuita",
"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": "A etapa não pode ser comprada."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Criar ordem para a etapa da cadeia de ofertas pagas",
"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": "Obtenha as cadeias de recompensa do usuário atual",
"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": "Obter o saldo de pontos de valor do usuário atual",
"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": "Reivindicou com sucesso a recompensa de passo do usuário atual de uma cadeia de recompensas."
},
"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": "Resgatar recompensa por etapa",
"tags": [
"reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v3/project/{project_id}/admin/coupon": {
"get": {
"description": "Obtém a lista de promoções de cupons de um projeto.",
"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": "Obter lista de promoções de cupons",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria uma promoção de cupom.",
"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": "O cupom foi criado com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Criar promoção de cupom",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/coupon/{external_id}": {
"delete": {
"description": "Exclui a [promoção de cupom](https://developers.xsolla.com/pt/doc/shop-builder/features/coupons/). A promoção excluída:\n* Desaparece da lista de promoções configuradas em seu projeto.\n* Não é mais aplicada ao catálogo de itens. O usuário não pode obter itens bônus com esta promoção.\n\nApós a exclusão, a promoção não pode ser restaurada.\nOs códigos de cupom da promoção excluída podem ser [adicionados](https://developers.xsolla.com/pt/api/shop-builder/operation/create-coupon-code/) às promoções existentes.",
"operationId": "delete-coupon-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "A promoção do cupom foi excluída com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir promoção de cupom",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém uma promoção de cupom especificada.",
"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": "O cupom foi recebido com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Ganhe promoção de cupom",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza uma promoção de cupom.",
"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": "O cupom foi atualizado com sucesso."
},
"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": "Promoção de cupom de atualização",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promocode": {
"get": {
"description": "Obtém a lista de códigos promocionais de um projeto.",
"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": "Obter lista de promoções de códigos promocionais",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria uma promoção de código promocional.",
"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": "O código promocional foi criado com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Criar promoção de código promocional",
"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": "Exclui a [promoção de código promocional](https://developers.xsolla.com/pt/doc/shop-builder/features/promo-codes/). A promoção excluída:\n* Desaparece da lista de promoções configuradas em seu projeto.\n* Não é mais aplicada ao catálogo de itens e ao carrinho. O usuário não pode obter itens bônus ou comprar itens usando esta promoção.\n\nApós a exclusão, a promoção não pode ser restaurada.\nOs códigos promocionais da promoção excluída podem ser [adicionados](https://developers.xsolla.com/pt/api/shop-builder/operation/create-promo-code-code/) às promoções existentes.",
"operationId": "delete-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "A promoção do código promocional foi excluída com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir promoção de código promocional",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém uma promoção de código promocional especificada.",
"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": "O código promocional foi recebido com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter promoção de código promocional",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza uma promoção de código promocional.",
"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": "O código promocional foi atualizado com sucesso."
},
"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": "Atualizar promoção de código promocional",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion": {
"get": {
"description": "Obtém a lista de promoções de um projeto.",
"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": "Obter toda a lista de promoções",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/bonus": {
"get": {
"description": "Obtém a lista de promoções bônus de um projeto.\n\nA promoção adiciona itens bônus gratuitos à compra feita por um usuário.\nA promoção pode ser aplicada a cada compra dentro de um projeto ou a uma compra que inclua itens específicos.",
"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": "Obter lista de promoções de bônus",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria a promoção de bônus.\n\nA promoção adiciona itens bônus gratuitos à compra feita por um usuário.\nA promoção pode ser aplicada a cada compra dentro de um projeto ou a uma compra que inclua itens específicos.",
"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": "Criar promoção de bônus",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/item": {
"get": {
"description": "Obtenha a lista de promoções de itens de um projeto.\n\nAs promoções oferecem um desconto (%) nos itens.\nO desconto será aplicado a todos os preços dos itens especificados.",
"operationId": "get-item-promotion-list",
"parameters": [
{
"description": "ID do projeto.",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"default": 59080,
"type": "integer"
}
},
{
"description": "Limite da quantidade de elementos na página.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 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": "Obter lista de promoções de itens",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria uma promoção de desconto para um item.\n\nAs promoções oferecem um desconto (%) nos itens.\nO desconto será aplicado a todos os preços dos itens especificados.",
"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": "Criar promoção de desconto para item",
"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": "Obtém a promoção por um código promocional ou código de cupom.",
"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": "Obtenha promoção resgatável por código",
"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": "Exclui a [promoção bônus](https://developers.xsolla.com/pt/doc/shop-builder/features/bonuses/). A promoção excluída:\n* Desaparece da lista de promoções configuradas no seu projeto.\n* Não se aplica mais ao catálogo de itens e ao carrinho. O usuário não pode obter itens bônus com esta promoção.\n\nApós a exclusão, a promoção não poderá ser restaurada.",
"operationId": "delete-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "A promoção foi excluída com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir promoção bônus",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Recebe a promoção bônus.\n\nA promoção adiciona itens bônus gratuitos à compra feita por um usuário.\nA promoção pode ser aplicada a cada compra dentro de um projeto ou a uma compra que inclua itens específicos.",
"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": "Obter promoção bônus",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza a promoção.\n\nObservação
Novos dados substituirão dados antigos. Se você quiser atualizar apenas uma parte de uma promoção, você deve transferir todos os dados necessários na solicitação também.
\n\nA promoção adiciona itens bônus gratuitos à compra feita por um usuário.\nA promoção pode ser aplicada a cada compra dentro de um projeto ou a uma compra que inclua itens específicos.",
"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": "A promoção foi atualizada com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Atualizar promoção bônus",
"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": "Exclui a [promoção de desconto](https://developers.xsolla.com/pt/doc/shop-builder/features/discounts/). A promoção excluída:\n* Desaparece da lista de promoções configuradas no seu projeto.\n* Não se aplica mais ao catálogo de itens e ao carrinho. O usuário não pode comprar itens com esta promoção.\n\nApós a exclusão, a promoção não poderá ser restaurada.",
"operationId": "delete-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "A promoção foi excluída com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir promoção de item",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém a promoção aplicada a itens específicos.\n\nAs promoções oferecem um desconto (%) nos itens.\nO desconto será aplicado a todos os preços dos itens especificados.",
"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": "Percentual de desconto.\nO preço do item será diminuído usando um valor que foi calculado usando essa porcentagem.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
},
"id": {
"description": "ID de promoção. Identificador exclusivo da promoção dentro do projeto.",
"type": "integer"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_is_enabled"
},
"items": {
"items": {
"description": "A lista de itens que serão afetados pelo desconto.",
"properties": {
"sku": {
"default": "elven_sword",
"description": "SKU do item.",
"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": "Nome da promoção. Deve conter pares chave/valor,\nonde chave é a localidade com o formato \"^[a-z]{2}-[A-Z]{2}$\", e o valor é uma cadeia de caracteres.",
"type": "object"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_discount"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
}
},
"type": "object"
}
}
},
"description": "A promoção do item foi recebida com sucesso."
},
"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": "Promoção não encontrada. Certifique-se de que `promotion_id` está correto."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter promoção de itens",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza a promoção.\n\nObservação
Novos dados substituirão dados antigos. Se você quiser atualizar apenas uma parte de uma promoção, você deve transferir todos os dados necessários na solicitação também.
\n\nAs promoções oferecem um desconto (%) nos itens.\nO desconto será aplicado a todos os preços dos itens especificados.",
"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": "A promoção foi atualizada com sucesso."
},
"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": "Atualizar promoção de item",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain": {
"get": {
"description": "Obtém lista de cadeias de recompensa.\n\nAtenção
Todos os projetos têm a limitação do número de itens que você pode obter na resposta. O valor padrão e máximo é de 10 itens por resposta. Para obter mais dados página por página, use os campos limit e 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": "Obter lista de cadeias de recompensas",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria cadeias de recompensas.",
"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": "Criar cadeia de recompensas",
"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": "Exclui uma cadeia de recompensas específica.",
"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": "Excluir cadeia de recompensas",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém uma cadeia de recompensa específica.",
"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": "Obtenha a cadeia de recompensas",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza a cadeia de recompensas específica.",
"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": "Atualizar cadeia de recompensas",
"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": "Redefinir cadeia de recompensas",
"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": "Ativar/desativar a cadeia de recompensas.",
"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": "Alternar cadeia de recompensas",
"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": "Obtém a lista de promoções de ofertas de catálogo exclusivas de um projeto.",
"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": "Obter lista de promoções exclusivas de ofertas de catálogo",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Cria uma promoção exclusiva de oferta de catálogo.",
"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": "A oferta de catálogo exclusiva foi criada com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Criar promoção de oferta de catálogo exclusiva",
"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": "Exclui a [promoção de oferta de catálogo único](https://developers.xsolla.com/pt/doc/shop-builder/features/unique-offer/). A promoção excluída:\n* Desaparece da lista de promoções configuradas no seu projeto.\n* Não se aplica mais ao catálogo de itens e ao carrinho. O usuário não pode comprar itens com esta promoção.\n\nApós a exclusão, a promoção não poderá ser restaurada.",
"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": "Oferta de catálogo exclusiva excluída com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Excluir promoção de oferta de catálogo exclusiva",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Obtém a promoção de oferta de catálogo exclusiva especificada.",
"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": "Oferta de catálogo exclusiva recebida com sucesso."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Obter promoção de oferta de catálogo exclusiva",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Atualiza a promoção de oferta de catálogo exclusiva.",
"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": "A oferta de catálogo exclusiva foi atualizada com sucesso."
},
"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": "Atualiza a promoção de oferta de catálogo exclusiva",
"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](/pt/api/catalog/virtual-items-currency-admin/admin-get-virtual-items-list/), [Bundles](/pt/api/catalog/bundles-admin/admin-create-bundle), or [Game keys](/pt/api/catalog/game-keys-admin) groups.\n2. Create a promotion using the [Create discount promotion for item](/pt/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](/pt/api/liveops/promotions-discounts/create-item-promotion/) or [Update item promotion](/pt/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](/pt/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](/pt/api/catalog/tag/common-catalog/), [Virtual Items and Currency > Catalog](/pt/api/catalog/virtual-items-currency-catalog/get-virtual-items/), and [Bundles > Catalog](/pt/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/pt/liveops/promotion-tools/discounts/)\n* [Bonuses](https://developers.xsolla.com/pt/liveops/promotion-tools/bonuses/)\n* [Coupons](https://developers.xsolla.com/pt/liveops/promotion-tools/coupons/)\n* [Promo codes](https://developers.xsolla.com/pt/liveops/promotion-tools/promo-codes/)\n* [Unique catalog offers](https://developers.xsolla.com/pt/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