` 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](/fr/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](/fr/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/fr/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/fr/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/fr/api/catalog/)\n- [API keys](https://developers.xsolla.com/fr/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](/fr/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](/fr/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](/fr/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/fr/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/fr/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](/fr/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/fr/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/fr/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](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/fr/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/fr/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/fr/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](/fr/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](/fr/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/fr/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](/fr/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](/fr/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](/fr/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/fr/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](/fr/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](/fr/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](/fr/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](/fr/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
Remarque
La méthode renvoie une liste paginée d'objets. La valeur maximale et par défaut est de 50 objets par réponse. Pour obtenir d'autres objets de la liste, utilisez les paramètres `limit` et `offset`, et récupérez d'autres pages. Par exemple, avec `limit = 25` et `offset = 100`, la réponse renvoie 25 objets à partir du 101e objet de la liste globale.
",
"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": "Lire une liste de récompenses quotidiennes",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une récompense quotidienne.",
"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": "Créer une récompense quotidienne",
"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": "Supprime une récompense quotidienne spécifique.",
"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": "Récompense quotidienne supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer la récompense quotidienne",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère une récompense quotidienne spécifique pour administration.",
"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": "Lire une récompense quotidienne",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour une récompense quotidienne spécifique.",
"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": "Récompense quotidienne mise à jour avec succès."
},
"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": "Mettre à jour la récompense quotidienne",
"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": "Réinitialise la progression de tous les utilisateurs pour cette récompense quotidienne. Applicable uniquement aux récompenses de type `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": "Récompense quotidienne réinitialisée."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Réinitialiser la récompense quotidienne",
"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": "Active ou désactive une récompense quotidienne.",
"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": "Récompense quotidienne désactivée ou activée."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Basculer une récompense quotidienne",
"tags": [
"daily-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/upsell": {
"get": {
"description": "Récupère les informations relatives à la vente incitative dans le projet : si elle est activée, le type de vente incitative et la liste des UGS des objets concernés par cette vente.",
"operationId": "get-upsell-configurations-for-project-admin",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"upsell": {
"summary": "Le projet possède une vente incitative",
"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": "Détermine si la vente incitative est activée pour le projet.",
"example": true,
"type": "boolean"
},
"items": {
"description": "Liste des UGS des objets faisant partie de la vente incitative dans le projet.",
"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": "Clés de jeu pour différents DRM.",
"items": {
"description": "Clé de jeu. Elle représente un jeu sur une certaine plateforme (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": "Type de vente incitative.",
"enum": [
"fixed_list",
"most_sellable",
"only_promotions"
],
"example": "fixed_list",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "Liste des détails de configuration et des objets utilisés pour la vente incitative dans le projet."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Lire les informations sur les ventes incitatives dans le projet",
"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": "Vente incitative créée pour le projet."
},
"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": "Créer une vente incitative",
"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": "Vente incitative mise à jour pour le projet."
},
"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": "Mettre à jour une vente incitative",
"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": "Statut d'activation.",
"in": "path",
"name": "toggle",
"required": true,
"schema": {
"example": "activate",
"type": "string"
}
}
],
"responses": {
"202": {
"description": "Vente incitative activée ou désactivée dans le projet."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-client-auth"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Activer/désactiver la vente incitative d'un projet",
"tags": [
"upsell-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v2/project/{project_id}/admin/items/value_points": {
"get": {
"description": "Récupère la liste des points de valeur au sein d'un projet à des fins d'administration.e",
"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": "Lire la liste des points de valeur",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée un point de valeur.",
"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": "Créer un point de valeur",
"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": "Supprime un point de valeur spécifique par son UGS.",
"operationId": "admin-delete-value-point",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/item_sku-path-param"
}
],
"responses": {
"204": {
"content": {},
"description": "Le point de valeur a été supprimé avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer des points de valeur",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère des informations sur un point de valeur par son UGS au sein d'un projet à des fins d'administration.",
"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": "Lire un point de valeur",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour un point de valeur spécifique par son UGS.",
"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": "Le point de valeur a été mis à jour avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/422-admin-create-update-rc-vp-invalid-request"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Mettre à jour un point de valeur",
"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": "Supprime les récompenses en points de valeur de TOUS les objets.",
"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": "Les récompenses en points de valeur des objets ont été supprimées avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer les points de valeur des objets",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère la liste de tous les objets ayant des points de valeur au sein d'un projet à des fins d'administration.",
"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": "Lire la liste des objets ayant des points de valeur",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"patch": {
"description": "Met à jour partiellement le nombre de points de valeur pour un ou plusieurs objets par UGS. Les utilisateurs reçoivent ces points de valeur après l'achat des objets spécifiés.\n\nPrincipes de mise à jour des points de valeur :\n * Si un objet ne possède pas encore de points de valeur, l'envoi d'une valeur non nulle dans le champ `amount`en crée.\n * Si un objet possède déjà des points de valeur, l'envoi d'une valeur non nulle dans le champ `amount` les met à jour.\n * Si le champ `amount` est fixé à 0, les points de valeur existants pour cet objet sont supprimés.\n\nContrairement à la méthode `PUT` ([Définir des points de valeur pour les objets](https://developers.xsolla.com/fr/api/shop-builder/operation/admin-set-items-value-point-reward/)), cette méthode `PATCH` n'écrase pas tous les points de valeur existants du projet, elle met uniquement à jour les objets spécifiés.\n\nUne seule requête peut mettre à jour jusqu'à 100 objets. Les UGS en double ne sont pas autorisés dans la même requête.",
"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": "Les récompenses en points de valeur des objets ont été mises à jour avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Mettre à jour partiellement les points de valeur des objets",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Attribue des points de valeur à un ou plusieurs objets par UGS. Les utilisateurs reçoivent des points de valeur en achetant ces objets.\n\nNotez que cette requête PUT écrase tous les points de valeur précédemment définis pour les objets du projet.\n\nPour éviter la suppression involontaire de points de valeur, incluez tous les objets et leurs points de valeur respectifs dans chaque requête PUT.\n\nSi vous souhaitez uniquement mettre à jour les points de valeur d'un objet spécifique tout en préservant les points de valeur des autres objets, vous devez récupérer l'ensemble actuel des points de valeur à l'aide d'une requête GET, modifier les points de valeur de l'objet souhaité, puis renvoyer l'ensemble modifié des points de valeur avec les points de valeur mis à jour pour l'objet spécifique.",
"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": "Les récompenses en points de valeur des objets ont été mises à jour avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/sellable-item-by-sku_404"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Définir des points de valeur pour les objets",
"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": "Récupère une liste de chaînes d'offres à des fins d'administration.\nAttention
Tous les projets sont soumis à une limite de nombre d'objets pouvant être renvoyés dans une seule réponse. La valeur par défaut et la valeur maximale sont de 10 objets par réponse. Pour obtenir plus de données, utilisez les paramètres de requête limit et offset pour la pagination.
",
"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": "Lire une liste de chaînes d'offres",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une chaîne d'offres",
"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": "Créer une chaîne d'offres",
"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": "Supprime une chaîne d'offres spécifique.\n\nAprès la suppression :- Toutes les récompenses déjà reçues par les utilisateurs sont conservées.
- Les étapes non achevées deviennent indisponibles et les récompenses correspondantes ne peuvent plus être obtenues.
\n\nContrairement à la désactivation de la chaîne d'offres via l'appel Activer/désactiver une chaîne d'offres, la suppression est irréversible et la progression de l'utilisateur n'est pas préservée.",
"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": "Chaîne d'offres supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer une chaîne d'offres",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère une chaîne d'offres spécifique à des fin d'administration.",
"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": "Lire une chaîne d'offre",
"tags": [
"offer-chain-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour une chaîne d'offres spécifique.",
"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": "Chaîne d'offres mise à jour avec succès."
},
"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": "Mettre à jour une chaîne",
"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": "Active ou désactive une chaîne d'offres.\n\nLorsque la chaîne d'offres est désactivée, les utilisateurs n'y ont temporairement plus accès, mais leur progression est préservée.\n\nLorsque la chaîne d'offres est réactivée, les utilisateurs peuvent continuer à partir de l'étape où ils se sont arrêtés.",
"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": "Chaîne d'offres désactivée/activée."
},
"401": {
"$ref": "#/components/responses/401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Activer/désactiver une chaîne d'offres",
"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": "Active une promotion par code promo.\n\nPar défaut, une promotion par code promo créée est désactivée.\nPour permettre l'échange de coupons, vous devez l'activer.\nUtilisez cet endpoint pour activer une promotion par code promo.",
"operationId": "activate-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Le code promo a été activé avec succès."
},
"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": "Activer une promotion par code promo",
"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": "Récupère les codes d'une promotion par code promo.",
"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": "Lire les codes d'une promotion par code promo",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée un code pour une promotion par code promo.",
"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": "Créer un code pour une promotion par code promo",
"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": "Génère des codes pour une promotion par code promo.",
"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": "Les codes ont été générés avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Générer des codes pour une promotion par code promo",
"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": "Désactive une promotion par code promo.\n\nPar défaut, une promotion par code promo créée est désactivée.\nPour permettre l'échange de coupons, vous devez l'activer.\nUtilisez cet endpoint pour désactiver une promotion par code promo.",
"operationId": "deactivate-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Le coupon a été désactivé avec succès."
},
"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": "Désactiver une promotion par code promo",
"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": "Active une promotion.",
"operationId": "activate-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "La promotion a été activée avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Activer une promotion",
"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": "Désactive une promotion.",
"operationId": "deactivate-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "La promotion a été désactivée avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-activate-deactivate-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Désactiver une promotion",
"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": "Active une offre promotionnelle unique du catalogue.\nUne offre promotionnelle unique créée dans le catalogue est désactivée par défaut.\nElle ne peut pas être utilisée tant que vous ne l'avez pas activée.\nUtilisez cet endpoint pour activer une promotion par coupon.",
"operationId": "activate-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "L'offre unique du catalogue a été activée avec succès."
},
"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": "Activer une offre promotionnelle unique du catalogue",
"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": "Récupère les codes d'une offre unique du catalogue.",
"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": "Lire les codes d'une offre unique du catalogue",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée un code pour une offre unique du catalogue",
"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": "Créer un code pour une offre unique du catalogue",
"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": "Génère des codes pour une offre unique du catalogue.",
"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": "Les codes ont été générés avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Générer des codes pour une offre unique du catalogue",
"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": "Désactive une offre promotionnelle unique du catalogue.\nUne offre promotionnelle unique créée dans le catalogue est désactivée par défaut.\nElle ne peut pas être utilisée tant que vous ne l'avez pas activée.\nUtilisez cet endpoint pour désactiver une promotion par coupon.",
"operationId": "deactivate-unique-catalog-offer",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "L'offre unique du catalogue a été désactivée avec succès."
},
"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": "Désactiver une offre promotionnelle unique du catalogue",
"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": "Récupère toutes les règles s'appliquant aux attributs utilisateur.",
"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": "S'il existe une autre page avec des règles.",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/user-attribute_personalized-catalog"
},
"type": "array"
},
"total_items_count": {
"description": "Nombre total de règles.",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "Les règles ont été reçues avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire la liste des règles de filtrage du catalogue",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une règle pour les attributs utilisateur.",
"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 de règle.",
"type": "number"
}
},
"type": "object"
}
}
},
"description": "La règle a été créée avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Créer une règle de filtrage du catalogue",
"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": "Récupère une liste de toutes les règles du catalogue pour la recherche côté client.\nAttention
Renvoie uniquement l'ID et le nom de la règle et 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": "Les règles ont été reçues avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"403": {
"$ref": "#/components/responses/403-auth-header-not-sent"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire toutes les règles du catalogue pour une recherche côté client",
"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": "Supprime une règle spécifique.",
"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": "La suppression a été effectuée avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer une règle de filtrage du catalogue",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère des informations sur une règle spécifique s'appliquant aux attributs utilisateur.",
"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": "La règle a été reçue avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire une règle de filtrage du catalogue",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"patch": {
"description": "Met à jour une règle spécifique s'appliquant aux attributs utilisateur. La valeur actuelle sera utilisée pour une propriété non spécifiée.",
"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": "La mise à jour a été effectuée avec succès."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Appliquer une règle de filtrage de catalogue",
"tags": [
"personalized-catalog"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour une règle spécifique s'appliquant aux attributs utilisateur. La valeur par défaut sera utilisée pour une propriété non spécifiée (si la propriété n'est pas requise).",
"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": "Mise à jour réussie."
},
"401": {
"$ref": "#/components/responses/Common_401-complex"
},
"422": {
"$ref": "#/components/responses/Common_422-body-validation"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Mettre à jour une règle de filtrage du catalogue",
"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": "Récupère le nombre restant de fois qu'un utilisateur spécifique peut utiliser le coupon.\n\nL'API des limites utilisateur vous permet de limiter le nombre de fois que les utilisateurs peuvent utiliser un coupon. Pour configurer les limites utilisateur, référez-vous à la section Administrateur :\n* [Coupons](https://developers.xsolla.com/fr/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": "Objet non trouvé."
},
"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": "Demande non valide."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire la limite de coupon pour un utilisateur spécifique",
"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": "Récupère le nombre de fois restant qu'un utilisateur spécifique peut utiliser le code promo.\n\nL'API des limites utilisateur vous permet de limiter le nombre de fois que les utilisateurs peuvent utiliser un code promo. Pour configurer les limites utilisateur, référez-vous à la section Administrateur :\n* [Codes promo](https://developers.xsolla.com/fr/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": "Objet non trouvé."
},
"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": "Demande non valide."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire la limite de code promo pour un utilisateur spécifique",
"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": "Actualise toutes les limites de toutes les promotions pour un utilisateur spécifique afin qu'il puisse à nouveau utiliser ces promotions.\n\nL'API des limites utilisateur vous permet de limiter le nombre de fois qu'un utilisateur peut utiliser une promotion. Pour configurer les limites utilisateur, accédez à la section Administrateur du type de promotion souhaité :\n* [Promotions par réduction](https://developers.xsolla.com/fr/api/shop-builder/tag/promotions-discounts/)\n* [Promotions par bonus](https://developers.xsolla.com/fr/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": "La limite de la promotion a été actualisée avec succès."
},
"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": "Objet non trouvé."
},
"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": "Demande non valide."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Actualiser toutes les limites de promotion pour un utilisateur spécifique",
"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": "Réduit le nombre de fois qu'un utilisateur spécifique peut utiliser une promotion dans la limite appliquée.\n\nL'API des limites utilisateur vous permet de limiter le nombre de fois qu'un utilisateur peut utiliser une promotion. Pour configurer les limites utilisateur, accédez à la section Administrateur du type de promotion souhaité :\n* [Promotions par réduction](https://developers.xsolla.com/fr/api/shop-builder/tag/promotions-discounts/)\n* [Promotions par bonus](https://developers.xsolla.com/fr/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": "Objet non trouvé."
},
"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": "Demande non valide."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Réduire la limite de promotion pour un utilisateur spécifique",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère le nombre de fois qu'un utilisateur spécifique peut utiliser la promotion dans la limite appliquée.\n\nL'API des limites utilisateur vous permet de limiter le nombre de fois qu'un utilisateur peut utiliser une promotion. Pour configurer les limites utilisateur, accédez à la section Administrateur du type de promotion souhaité :\n* [Promotions par réduction](https://developers.xsolla.com/fr/api/shop-builder/tag/promotions-discounts/)\n* [Promotions par bonus](https://developers.xsolla.com/fr/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": "Objet non trouvé."
},
"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": "Demande non valide."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire la limite de promotion pour un utilisateur spécifique",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Augmente le nombre de fois qu'un utilisateur spécifique peut utiliser la promotion dans la limite appliquée.\n\nL'API des limites utilisateur vous permet de limiter le nombre de fois qu'un utilisateur peut utiliser une promotion. Pour configurer les limites utilisateur, accédez à la section Administrateur du type de promotion souhaité :\n* [Promotions par réduction](https://developers.xsolla.com/fr/api/shop-builder/tag/promotions-discounts/)\n* [Promotions par bonus](https://developers.xsolla.com/fr/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": "Objet non trouvé."
},
"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": "Demande non valide."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Augmenter la limite de promotion pour un utilisateur spécifique",
"tags": [
"user-limits-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Définit le nombre de fois qu'un utilisateur spécifique peut utiliser une promotion dans la limite appliquée après une augmentation ou une diminution.\n\nL'API des limites utilisateur vous permet de limiter le nombre de fois qu'un utilisateur peut utiliser une promotion. Pour configurer les limites utilisateur, accédez à la section Administrateur du type de promotion souhaité :\n* [Promotions par réduction](https://developers.xsolla.com/fr/api/shop-builder/tag/promotions-discounts/)\n* [Promotions par bonus](https://developers.xsolla.com/fr/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": "Objet non trouvé."
},
"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": "Demande non valide."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Définir la limite de promotion pour un utilisateur spécifique",
"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": "Actualise la limite de la promotion afin que l'utilisateur puisse à nouveau utiliser cette promotion. Si le paramètre *user* est défini sur `null`, cet appel actualise cette limite pour tous les utilisateurs.\n\nL'API des limites utilisateur vous permet de limiter le nombre de fois qu'un utilisateur peut utiliser une promotion. Pour configurer les limites utilisateur, accédez à la section Administrateur du type de promotion souhaité :\n* [Promotions par réduction](https://developers.xsolla.com/fr/api/shop-builder/tag/promotions-discounts/)\n* [Promotions par bonus](https://developers.xsolla.com/fr/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": "La limite de la promotion a été actualisée avec succès."
},
"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": "Objet non trouvé."
},
"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": "Demande non valide."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Actualiser la limite d'une promotion pour les utilisateurs",
"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": "Lire les récompenses d'un coupon",
"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": "Échanger un code de coupon",
"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": "Lire la liste des objets de vente incitative dans le projet",
"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": "Lire les récompenses d'un code promo",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/redeem": {
"post": {
"description": "Échange un code d'une promotion par code promo.\nAprès avoir échangé un code de promo, l'utilisateur reçoit des biens gratuits et/ou le prix du panier et/ou des objets spécifiques sera réduit.",
"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": "Échanger un code promo",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v2/project/{project_id}/promocode/remove": {
"put": {
"description": "Supprime un code promo d'un panier.\nAprès la suppression du code promo, le prix total de tous les objets du panier sera recalculé sans les bonus et les remises accordés par un code promo.",
"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": "Supprimer un code promo du panier",
"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": "Vérifier un code promotionnel",
"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 de projet.",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"example": 44056,
"type": "integer"
}
},
{
"description": "ID de la chaîne de récompenses.",
"in": "path",
"name": "reward_chain_id",
"required": true,
"schema": {
"example": 101,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"clan": {
"summary": "L'utilisateur appartient à un clan",
"value": [
{
"contributed_amount": 555,
"name": "winner"
},
{
"contributed_amount": 398,
"name": "Rocket"
},
{
"contributed_amount": 201,
"name": "MrJoe"
},
{
"contributed_amount": 1,
"name": "beginner"
}
]
},
"without-clan": {
"summary": "L'utilisateur n'appartient pas à un clan",
"value": []
}
},
"schema": {
"items": {
"properties": {
"contributed_amount": {
"description": "Nombre de points de valeur apportés par l'utilisateur.",
"example": 100,
"type": "integer"
},
"name": {
"description": "ID de l'utilisateur. Il s'agit de l'ID envoyé à Xsolla lors de l'autorisation. Cet ID lie l'utilisateur à votre projet Xsolla Login.",
"example": "Rocket",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
}
},
"description": "Liste des 10 premiers contributeurs à la chaîne de récompenses de clan."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Lire les 10 premiers contributeurs à la chaîne de récompense au sein du clan",
"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 de projet.",
"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": "Mise à jour du clan de l'utilisateur actuel",
"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": "Lire les récompenses quotidiennes de l'utilisateur actuel",
"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": "Récompense quotidienne de l'utilisateur récupérée avec succès."
},
"404": {
"$ref": "#/components/responses/404-daily-chain-not-found"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Lire la récompense quotidienne de l'utilisateur actuel par son 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": "Récompense de l'utilisateur actuel pour l'étape de la récompense quotidienne réclamée avec succès."
},
"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": "Impossible de réclamer l'étape."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Réclamer une étape de récompense quotidienne",
"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": "Lire les chaînes d'offres de l'utilisateur actuel",
"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": "Chaîne d'offres de l'utilisateur récupérée avec succès."
},
"404": {
"$ref": "#/components/responses/404-offer-chain-not-found"
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Lire une chaîne d'offres de l'utilisateur actuel par 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 commande.",
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "Étape gratuite réclamée avec succès et récompense attribuée."
},
"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": "Impossible de réclamer l'étape. Assurez-vous que toutes les étapes précédentes sont terminées et que l'étape est bien marquée comme gratuite."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Réclamer une étape de chaîne d'offres gratuite",
"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": "Impossible d'acheter l'étape."
}
},
"security": [
{
"XsollaLoginUserJWT": []
}
],
"summary": "Créer une commande pour une étape payante de la chaîne d'offres",
"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": "Lire les chaînes de récompenses de l'utilisateur actuel",
"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": "Lire le solde de points de valeur de l'utilisateur actuel",
"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": "Récompense de l'utilisateur actuel pour l'étape de la chaîne de récompenses réclamée avec succès."
},
"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": "Réclamer la récompense d'une étape",
"tags": [
"reward-chain-client"
],
"x-badges": [
{
"color": "#80eaff",
"name": "Client-side"
}
]
}
},
"/v3/project/{project_id}/admin/coupon": {
"get": {
"description": "Récupère la liste des promotions par coupon d'un projet.",
"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": "Lire la liste des promotions par coupon",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une promotion par coupon.",
"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": "Le coupon a été créé avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Créer une promotion par coupon",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/coupon/{external_id}": {
"delete": {
"description": "Supprime la [promotion par coupon](https://developers.xsolla.com/fr/doc/shop-builder/features/coupons/). Les conséquences suivantes s'en suivent :\n* La promotion disparaît de la liste des promotions configurées dans votre projet ;\n* Elle n'est plus appliquée au catalogue des objets. L'utilisateur ne peut plus obtenir d'objets bonus à travers cette promotion.\n\nAprès la suppression, la promotion ne peut pas être restaurée.\nLes coupons de la promotion supprimée peuvent être [ajoutés](https://developers.xsolla.com/fr/api/shop-builder/operation/create-coupon-code/) à des promotions existantes.",
"operationId": "delete-coupon-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Promotion par coupon supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer une promotion par coupon",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère des informations sur une promotion par coupon spécifique.",
"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": "Le coupon a été reçu avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire une promotion par coupon",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour une promotion par coupon",
"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": "Le coupon a été mis à jour avec succès."
},
"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": "Mettre à jour une promotion par coupon",
"tags": [
"promotions-coupons"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promocode": {
"get": {
"description": "Récupère la liste des codes promo d'un projet.",
"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": "Lire la liste des promotions par code promo",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une promotion par code promo.",
"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": "Le code promo a été créé avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Créer une promotion par code promo",
"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": "Supprime la [promotion par code promo](https://developers.xsolla.com/fr/doc/shop-builder/features/promo-codes/). Les conséquences suivantes s'en suivent :\n* La promotion disparaît de la liste des promotions configurées dans votre projet ;\n* Elle n'est plus appliquée au catalogue des objets ni au panier. L'utilisateur ne peut plus obtenir d'objets bonus ou acheter des objets à travers cette promotion.\n\nAprès la suppression, la promotion ne peut pas être restaurée.\nLes codes promo de la promotion supprimée peuvent être [ajoutés](https://developers.xsolla.com/fr/api/shop-builder/operation/create-promo-code-code/) à des promotions existantes.",
"operationId": "delete-promo-code",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/external_id-promotion-path-param"
}
],
"responses": {
"204": {
"description": "Code promo supprimé avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer une promotion par code promo",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère des informations sur une promotion par code promo spécifique.",
"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": "Le code promo a été reçu avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promocode"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire une promotion par code promo",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour une promotion par code promo.",
"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": "Le code promo a été mis à jour avec succès."
},
"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": "Mettre à jour une promotion par code promo",
"tags": [
"promotions-promo-codes"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion": {
"get": {
"description": "Récupère la liste des promotions d'un projet.",
"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": "Lire la liste de toutes les promotions",
"tags": [
"promotions-common"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/bonus": {
"get": {
"description": "Récupère la liste des promotions par bonus au sein d'un projet.\n\nLa promotion ajoute des objets bonus gratuits à l'achat effectué par l'utilisateur.\nLa promotion peut être appliquée à chaque achat au sein d'un projet ou à un achat comprenant des objets particuliers.",
"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": "Lire la liste des promotions par bonus",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une promotion par bonus.\n\nLa promotion ajoute des objets bonus gratuits à l'achat effectué par l'utilisateur.\nLa promotion peut être appliquée à chaque achat au sein d'un projet ou à un achat comprenant des objets particuliers.",
"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": "Créer une promotion par bonus",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/promotion/item": {
"get": {
"description": "Récupère la liste des promotions sur les objets d'un projet.\n\nLes promotions offrent une remise (%) sur les objets.\nLa remise s'applique à tous les prix des objets spécifiés.",
"operationId": "get-item-promotion-list",
"parameters": [
{
"description": "ID de projet.",
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"default": 59080,
"type": "integer"
}
},
{
"description": "Nombre maximal d'éléments sur une page.",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "integer"
}
},
{
"description": "Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 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": "Lire la liste des promotions sur des objets",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une promotion par réduction pour un objet.\n\nLes promotions offrent une remise (%) sur les objets.\nLa remise s'applique à tous les prix des objets spécifiés.",
"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": "Créer une promotion par réduction pour un objet",
"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": "Récupère des informations sur la promotion par un code promo ou un code de coupon.",
"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": "Lire une promotion utilisable par code",
"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": "Supprime la [promotion par bonus](https://developers.xsolla.com/fr/doc/shop-builder/features/bonuses/). Les conséquences suivantes s'en suivent :\n* La promotion disparaît de la liste des promotions configurées dans votre projet ;\n* Elle n'est plus appliquée au catalogue des objets ni au panier. L'utilisateur ne peut plus obtenir d'objets bonus à travers cette promotion.\n\nAprès la suppression, la promotion ne peut pas être restaurée.",
"operationId": "delete-bonus-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Promotion supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer une promotion par bonus",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère des informations sur une promotion par bonus.\n\nLa promotion ajoute des objets bonus gratuits à l'achat effectué par l'utilisateur.\nLa promotion peut être appliquée à chaque achat au sein d'un projet ou à un achat comprenant des objets particuliers.",
"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": "Lire une promotion par bonus",
"tags": [
"promotions-bonuses"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour une promotion.\n\nNote
Les nouvelles données remplaceront les anciennes. Si vous souhaitez mettre à jour une promotion partiellement, assurez-vous de passer toutes les données requises dans la requête.
\n\nLa promotion ajoute des objets bonus gratuits à l'achat effectué par l'utilisateur.\nLa promotion peut être appliquée à chaque achat au sein d'un projet ou à un achat comprenant des objets particuliers.",
"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": "La promotion a été mise à jour avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-admin-promotion-missed-bonus-property"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Mettre à jour une promotion par bonus",
"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": "Supprime la [promotion par réduction](https://developers.xsolla.com/fr/doc/shop-builder/features/discounts/). Les conséquences suivantes s'en suivent :\n* La promotion disparaît de la liste des promotions configurées dans votre projet ;\n* Elle n'est plus appliquée au catalogue des objets ni au panier. L'utilisateur ne peut plus acheter d'objets à travers cette promotion.\n\nAprès la suppression, la promotion ne peut pas être restaurée.",
"operationId": "delete-item-promotion",
"parameters": [
{
"$ref": "#/components/parameters/project_id-path-param"
},
{
"$ref": "#/components/parameters/promotion_id-path-param"
}
],
"responses": {
"204": {
"description": "Promotion supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-promotion"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer une promotion sur les objets",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère des informations sur les promotions qui s'appliquent à des objets spécifiques.\n\nLes promotions offrent une remise (%) sur des objets.\nLa remise s'applique à tous les prix des objets spécifiés.",
"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": "Pourcentage de la remise.\nLe prix de l'objet sera diminué d'une valeur calculée à l'aide de ce pourcentage.",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"excluded_promotions": {
"$ref": "#/components/schemas/excluded_promotions"
},
"id": {
"description": "ID de la promotion. Identifiant unique de la promotion au sein du projet.",
"type": "integer"
},
"is_enabled": {
"$ref": "#/components/schemas/Promotions_is_enabled"
},
"items": {
"items": {
"description": "Liste des objets qui seront concernés par la remise.",
"properties": {
"sku": {
"default": "elven_sword",
"description": "UGS de l'objet.",
"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": "Nom de la promotion. Doit comprendre des paires clé/valeur,\noù la clé est une région au format \"^[a-z]{2}-[A-Z]{2}$\", la valeur est une chaîne.",
"type": "object"
},
"price_conditions": {
"$ref": "#/components/schemas/price_conditions_discount"
},
"promotion_periods": {
"$ref": "#/components/schemas/promotion_periods"
}
},
"type": "object"
}
}
},
"description": "La promotion sur les objets a été reçu avec succès."
},
"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": "Promotion non trouvée. Assurez-vous que le paramètre `promotion_id` est correct."
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire une promotion sur les objets",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour la promotion.\n\nNote
Les nouvelles données remplaceront les anciennes. Si vous souhaitez mettre à jour une promotion partiellement, assurez-vous de passer toutes les données requises dans la requête.
\n\nLes promotions offrent une remise (%) sur les objets.\nLa remise s'applique à tous les prix des objets spécifiés.",
"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": "La promotion a été mise à jour avec succès."
},
"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": "Mettre à jour une promotion sur les objets",
"tags": [
"promotions-discounts"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
}
},
"/v3/project/{project_id}/admin/reward_chain": {
"get": {
"description": "Récupère une liste de chaînes de récompenses.\n\nAttention
Tous les projets sont soumis à une limite de nombre d'objets que vous pouvez obtenir dans la réponse. La valeur par défaut et la valeur maximale sont 10 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et 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": "Lire une liste de chaînes de récompenses",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une chaîne de récompenses.",
"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": "Créer une chaîne de récompenses",
"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": "Supprime une chaîne de récompenses spécifique.",
"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": "Supprimer une chaîne de récompenses",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère des informations sur une chaîne de récompenses spécifique.",
"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": "Lire une chaîne de récompenses",
"tags": [
"reward-chain-value-points-admin"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour une chaîne de récompenses spécifique.",
"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": "Mettre à jour une chaîne de récompenses",
"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": "Réinitialiser la chaîne de récompenses",
"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": "Active/désactive la chaîne de récompenses.",
"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": "Basculer une chaîne de récompenses",
"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": "Récupère la liste des offres promotionnelles uniques d'un projet.",
"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": "Lire la liste des offres promotionnelles uniques du catalogue",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"post": {
"description": "Crée une offre promotionnelle unique dans le catalogue.",
"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": "L'offre unique a été créée avec succès dans le catalogue."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"422": {
"$ref": "#/components/responses/Promotions_422-invalid-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Créer une offre promotionnelle unique dans le catalogue",
"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": "Supprime la [promotion par offre unique du catalogue](https://developers.xsolla.com/fr/doc/shop-builder/features/unique-offer/). Les conséquences suivantes s'en suivent :\n* La promotion disparaît de la liste des promotions configurées dans votre projet ;\n* Elle n'est plus appliquée au catalogue des objets ni au panier. L'utilisateur ne peut plus acheter d'objets à travers cette promotion.\n\nAprès la suppression, la promotion ne peut pas être restaurée.",
"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": "Offre unique du catalogue supprimée avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Supprimer une promotion par offre unique du catalogue",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"get": {
"description": "Récupère une promotion par offre unique du catalogue spécifique.",
"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": "Offre unique du catalogue reçue avec succès."
},
"401": {
"$ref": "#/components/responses/Promotions_401-invalid-basic-auth"
},
"404": {
"$ref": "#/components/responses/Promotions_404-admin-coupon"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "Lire une promotion par offre unique du catalogue",
"tags": [
"promotions-unique-catalog-offers"
],
"x-badges": [
{
"color": "#95ff80",
"name": "Server-side"
},
{
"color": "#d7dee0",
"name": "Admin"
}
]
},
"put": {
"description": "Met à jour une promotion par offre unique du catalogue.",
"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": "Offre unique du catalogue mise à jour avec succès."
},
"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": "Mettre à jour une promotion par offre unique du catalogue",
"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": "Promotion usage limits allow you to restrict the number of times a specific user can use a promotion. You can also configure scheduled limit resets.\n\nLimits are stored on the Xsolla side and are configured in the promotion settings in [Publisher Account](https://publisher.xsolla.com/0/projects/0/storefront/promotions) or via the `limits` object in the following API calls:\n* [Create discount promotion for item](/fr/api/liveops/promotions-discounts/create-item-promotion/) or [Update discount promotion](/fr/api/liveops/promotions-discounts/update-item-promotion)\n* [Create bonus promotion](/fr/api/liveops/promotions-bonuses/create-bonus-promotion/) or [Update bonus promotion](/fr/api/liveops/promotions-bonuses/update-bonus-promotion)\n\nLimit information is returned in the `items.promotions.limits` object in the following API calls for retrieving the items catalog:\n* [Get virtual items list](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-items/)\n* [Get virtual currency list](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-currency/)\n* [Get virtual currency packages list](/fr/api/catalog/virtual-items-currency-catalog/get-virtual-currency-package/)\n* [Get bundles list](/fr/api/catalog/bundles-catalog/get-bundle-list/)\n* [Get games list](/fr/api/catalog/game-keys-catalog/get-games-list/)\n\nThe API calls in the **Management** subsection of the **Limits** group allow you to retrieve the current state of limits and update them for a specific user — for example, reset the counter after a quest is completed or manually adjust the remaining quantity.\n\n\n
Note\n For detailed information on configuring limits in the catalog, refer to the
Promotion usage limits section.\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