{ "openapi": "3.0.0", "info": { "description": "# Aperçu\n\nDigital Distribution Hub est une nouvelle solution Xsolla qui comble le fossé entre les paiements numériques et les paiements en espèces via la technologie des paiements push et le e-commerce.\n\nCette référence décrit les endpoints API de deux produits Xsolla : [In-Game Store](https://developers.xsolla.com/fr/doc/in-game-store/) et [Pay Station](https://developers.xsolla.com/fr/doc/pay-station/). Deux URL de base sont utilisées :\n\n* `https://store.xsolla.com/api` pour les groupes **Communs**, **Catalogue**, **Panier**, et **Commande**.\n* `https://ps.xsolla.com` pour le groupe **Notifications**.\n\nLes endpoints API dans le groupe **Catalogue** ne requièrent pas d'autorisation. \n\nPour utiliser les opérations des groupes **Panier** et **Commande**, vous devez générer un jeton via [Create user token](https://developers.xsolla.com/fr/digital-distribution-hub/common/user-token/create-user-token).\n\n
Note

Cette référence présente un projet d'une future API et non une interface entièrement fonctionnelle. Actuellement, vous ne pouvez essayer que les endpoints des groupes Catalogue et Notifications. Si vous souhaitez nous faire part de vos commentaires, envoyez-nous un e-mail à l'adresse suivante : techdoc@xsolla.com.
", "title": "Digital Distribution Hub", "version": "1.0.0" }, "servers": [ { "url": "https://store.xsolla.com/api" } ], "tags": [ { "name": "cart", "x-displayName": "Panier" }, { "name": "game keys", "x-displayName": "Clés de jeu" }, { "name": "virtual items & currency", "x-displayName": "Objets et monnaie virtuels" }, { "name": "bundles", "x-displayName": "Lots" }, { "name": "user token", "x-displayName": "Jeton d'utilisateur" }, { "name": "notifications", "x-displayName": "Notifications" }, { "name": "order", "x-displayName": "Commande" } ], "paths": { "/push-payments/cancel": { "post": { "description": "Envoyez une notification d'annulation de paiement dans les cas suivants :\n - le paiement n'a pas été effectué ;\n - le paiement a été remboursé.", "operationId": "cancel-notification", "requestBody": { "content": { "application/json": { "example": { "payment_id": 784998479 }, "schema": { "properties": { "payment_id": { "type": "integer" } }, "required": [ "payment_id" ], "type": "object" } } } }, "responses": { "200": { "description": "OK." }, "400": { "description": "Bad Request." }, "403": { "description": "Accès refusé." }, "404": { "description": "Paiement non trouvé." }, "409": { "description": "Le paiement est déjà annulé." }, "422": { "description": "Erreur lors de l'annulation du paiement." }, "500": { "description": "Erreur interne du serveur." } }, "servers": [ { "url": "https://ps.xsolla.com" } ], "summary": "Notification d'annulation", "tags": [ "notifications" ] } }, "/push-payments/pay": { "post": { "description": "Envoyez cette notification après avoir facturé l'utilisateur avec succès.", "operationId": "pay-notification", "requestBody": { "content": { "application/json": { "example": { "payment": { "amount": 10, "currency": "USD", "geotype_id": 13038, "ps_transaction_id": "ps_transaction_id" }, "project_id": 18404, "purchase": { "order_id": 1334430 }, "user": { "id": "s.ivanov" } }, "schema": { "properties": { "payment": { "properties": { "amount": { "description": "Montant du paiement.", "type": "number" }, "currency": { "description": "Devise de la commande. L'UGS de la monnaie virtuelle ou code de devise à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "type": "string" }, "geotype_id": { "description": "ID du partenaire distributeur du côté de Xsolla.", "type": "integer" }, "project_transaction_id": { "description": "ID de transaction du côté du développeur du jeu.", "type": "string" }, "ps_transaction_id": { "description": "ID de transaction du côté du partenaire de distribution.", "type": "string" } }, "required": [ "geotype_id", "amount" ], "type": "object" }, "project_id": { "description": "ID de projet.", "type": "integer" }, "purchase": { "properties": { "order_id": { "description": "ID de commande.", "type": "integer" } }, "required": [ "order_id" ], "type": "object" }, "user": { "properties": { "email": { "description": "Adresse e-mail de l'utilisateur.", "type": "string" }, "id": { "description": "Identifiant unique de l'utilisateur dans le jeu.", "type": "string" }, "phone": { "description": "Numéro de téléphone de l'utilisateur.", "type": "string" }, "ps_account_id": { "description": "ID du compte de paiement de l'utilisateur du côté du partenaire de distribution.", "type": "string" } }, "required": [ "id" ], "type": "object" } }, "required": [ "project_id", "payment", "purchase", "user" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "example": { "payment_id": 784998484 }, "schema": { "properties": { "payment_id": { "type": "integer" } }, "type": "object" } } }, "description": "OK." }, "400": { "description": "Bad Request." }, "403": { "description": "Accès refusé." }, "404": { "description": "Commande non trouvée." }, "409": { "description": "La commande est déjà payée." }, "422": { "description": "Erreur lors de la création du paiement." }, "500": { "description": "Erreur interne du serveur." } }, "servers": [ { "url": "https://ps.xsolla.com" } ], "summary": "Notification de paiement", "tags": [ "notifications" ] } }, "/v2/project/{project_id}/cart": { "get": { "description": "Renvoie le panier de l'utilisateur actuel.", "operationId": "get-user-cart", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" } } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_200" } } }, "description": "Le panier contenant des objets a été renvoyé avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire le panier de l'utilisateur actuel", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/clear": { "put": { "description": "Supprime tous les objets du panier.", "operationId": "cart-clear", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "responses": { "204": { "description": "Le panier a été vidé avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Supprimer tous les objets du panier actuel", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/fill": { "put": { "description": "Remplit d'objets le panier. Si le panier contient déjà un objet avec la même UGS, l'objet existant sera remplacé par la valeur passée.", "operationId": "cart-fill", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/fill-cart-json-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found", "quantity": 1, "sku": "booster_mega_21" } ] } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_200_1" } } }, "description": "Le panier contenant des objets a été renvoyé avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Remplir le panier d'objets", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/item/{item_sku}": { "delete": { "description": "Supprime un objet du panier.", "operationId": "delete-item", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "responses": { "204": { "description": "L'objet a été supprimé du panier avec succès." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart_inline_response_404" } } }, "description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_sku` sont corrects." } }, "security": [ { "AuthForClient": [] } ], "summary": "Supprimer un objet du panier actuel", "tags": [ "cart" ] }, "put": { "description": "Met à jour un objet de panier existant ou en crée un nouveau dans le panier.", "operationId": "put-item", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/put-item-by-cart-id-json-model" }, "responses": { "204": { "description": "Le panier a été mis à jour avec succès." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart_inline_response_404" } } }, "description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_sku` sont corrects." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1421, "errorMessage": "Only Virtual Good Supported", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_422_1" } } }, "description": "Ce type d'objet ne peut pas être mis dans le panier. Sélectionnez un autre type d'objet." } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour un objet du panier actuel", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/{cart_id}": { "get": { "description": "Renvoie le panier de l'utilisateur par son ID de panier.", "operationId": "get-cart-by-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" } } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_200" } } }, "description": "Le panier contenant des objets a été renvoyé avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire le panier par ID de panier", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/{cart_id}/clear": { "put": { "description": "Supprime tous les objets du panier.", "operationId": "cart-clear-by-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" } ], "responses": { "204": { "description": "Le panier a été vidé avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Supprimer tous les objets du panier par ID de panier", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "Remplit d'objets un panier spécifique. Si le panier contient déjà un objet avec la même UGS, l'objet existant sera remplacé par la valeur passée.", "operationId": "cart-fill-by-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/fill-cart-json-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found", "quantity": 1, "sku": "booster_mega_21" } ] } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_200_1" } } }, "description": "Le panier contenant des objets a été renvoyé avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Remplir un panier spécifique d'objets", "tags": [ "cart" ] } }, "/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}": { "delete": { "description": "Supprime un objet du panier.", "operationId": "delete-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "responses": { "204": { "description": "L'objet a été supprimé du panier avec succès." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart_inline_response_404" } } }, "description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_sku` sont corrects." } }, "security": [ { "AuthForClient": [] } ], "summary": "Supprimer un objet du panier par ID de panier", "tags": [ "cart" ] }, "put": { "description": "Met à jour un objet de panier existant ou en crée un nouveau dans le panier.", "operationId": "put-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/put-item-by-cart-id-json-model" }, "responses": { "204": { "description": "Le panier a été mis à jour avec succès." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cart_inline_response_404" } } }, "description": "Objet non trouvé. Assurez-vous que les paramètres `project_id` et `item_sku` sont corrects." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Item quantity must be non-negative integer", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Cart_inline_response_422" } } }, "description": "La quantité de l'objet doit être un nombre entier non négatif." } }, "security": [ { "basicAuth": [] } ], "summary": "Mettre à jour un objet du panier par ID de panier", "tags": [ "cart" ] } }, "/v2/project/{project_id}/distribution_hub/order/{order_id}": { "get": { "description": "Récupère des informations sur une commande spécifique.", "operationId": "get-order", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/order-id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "content": { "is_free": "false", "items": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "some_sku" } ], "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" } }, "order_id": 1, "status": "paid" } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_200_1" } } }, "description": "Requête de commande acceptée." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9001, "errorMessage": "[0401-9001]: Order not found", "statusCode": 404 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_404" } } }, "description": "Commande non trouvée. Assurez-vous que les paramètres `project_id` et `order_id` sont corrects." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une commande", "tags": [ "order" ] } }, "/v2/project/{project_id}/distribution_hub/payment/cart": { "post": { "description": "Crée une commande à partir de tous les objets d'un panier. La commande créée aura le statut `new`.", "operationId": "create-order", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-order-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "billing_info": { "direct_taxes": [ { "amount": 150, "name": "TAX", "rate": 10 } ], "indirect_taxes": [ { "amount": 246.75, "name": "VAT", "rate": 20 } ], "price": { "amount": 1480.45, "currency": "USD" } }, "order_id": 641 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_200" } } }, "description": "La commande a été créée avec succès." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_422" } } }, "description": "Panier non valide. Vérifiez que le panier existe, qu'il n'est pas vide et que tous les objets qu'il contient ne sont pas gratuits." } }, "security": [ { "AuthForClient": [] } ], "summary": "Créer une commande à partir de tous les objets du panier actuel", "tags": [ "order" ] } }, "/v2/project/{project_id}/distribution_hub/payment/cart/{cart_id}": { "post": { "description": "Crée une commande à partir de tous les objets d'un panier spécifique. La commande créée aura le statut `new`.", "operationId": "create-order-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/cart-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-order-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "billing_info": { "direct_taxes": [ { "amount": 150, "name": "TAX", "rate": 10 } ], "indirect_taxes": [ { "amount": 246.75, "name": "VAT", "rate": 20 } ], "price": { "amount": 1480.45, "currency": "USD" } }, "order_id": 641 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_200" } } }, "description": "La commande a été créée avec succès." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_422" } } }, "description": "Panier non valide. Vérifiez que le panier existe, qu'il n'est pas vide et que tous les objets qu'il contient ne sont pas gratuits." } }, "security": [ { "AuthForClient": [] } ], "summary": "Créer une commande à partir de tous les objets d'un panier spécifique", "tags": [ "order" ] } }, "/v2/project/{project_id}/distribution_hub/payment/item/{item_sku}": { "post": { "description": "Crée une commande à partir d'un objet spécifique. La commande créée aura le statut `new`.", "operationId": "create-order-with-item", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-order-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "billing_info": { "direct_taxes": [ { "amount": 150, "name": "TAX", "rate": 10 } ], "indirect_taxes": [ { "amount": 246.75, "name": "VAT", "rate": 20 } ], "price": { "amount": 1480.45, "currency": "USD" } }, "order_id": 641 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_200" } } }, "description": "La commande a été créée avec succès." }, "422": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1411, "errorMessage": "[0401-1411]: Invalid item", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/Order_inline_response_422_1" } } }, "description": "Objet non valide. Vérifiez que l'objet existe, qu'il n'est pas désactivé, qu'il n'est pas supprimé et qu'il n'est pas gratuit." } }, "security": [ { "AuthForClient": [] } ], "summary": "Créer une commande à partir d'un objet spécifique", "tags": [ "order" ] } }, "/v2/project/{project_id}/distribution_hub/user/auth": { "post": { "description": "Vérifie qu'un utilisateur existe dans le jeu et crée un jeton utilisateur.", "operationId": "create-user-token", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/post-user-token-json-model" }, "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" } } }, "schema": { "$ref": "#/components/schemas/Common_inline_response_200_1" } } }, "description": "Jeton utilisateur reçu avec succès." } }, "security": [ { "basicAuth": [] } ], "summary": "Créer un jeton utilisateur", "tags": [ "user token" ] } }, "/v2/project/{project_id}/items/bundle": { "get": { "description": "Récupère une liste de lots pour la constitution d'un catalogue.\n\n
Attention. 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 50 éléments par réponse.
", "operationId": "get-bundle-list", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-get-bundle-list" } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_10" } } }, "description": "La liste de lots a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste de lots", "tags": [ "bundles" ] } }, "/v2/project/{project_id}/items/bundle/sku/{sku}": { "get": { "description": "Récupère des informations sur un lot spécifique.", "operationId": "get-bundle", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-get-bundle" } }, "schema": { "$ref": "#/components/schemas/Catalog_client_bundle" } } }, "description": "Le lot spécifié a été reçu avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire un lot spécifique", "tags": [ "bundles" ] } }, "/v2/project/{project_id}/items/game": { "get": { "description": "Récupère une liste de jeux pour la constitution d'un catalogue.\n\n
Attention. 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 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
", "operationId": "get-games-list", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200" } } }, "description": "La liste de jeux a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste de jeux", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/drm": { "get": { "description": "Récupère la liste des DRM disponibles.", "operationId": "get-drm-list", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "drm": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation" } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_4" } } }, "description": "La liste des DRM a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire la liste des DRM", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/group/{external_id}": { "get": { "description": "Récupère une liste de jeux au sein d'un groupe spécifique pour la constitution d'un catalogue.\n\n
Attention. 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 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
", "operationId": "get-games-group", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/external-id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200" } } }, "description": "La liste de jeux a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste de jeux par groupe spécifique", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/key/group/{external_id}": { "get": { "description": "Récupère une liste de clés de jeu au sein d'un groupe spécifique pour la constitution d'un catalogue.\n\n
Attention. 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 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
", "operationId": "get-game-keys-group", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/external-id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_2", "type": "game_key", "virtual_prices": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_3" } } }, "description": "La liste des clés de jeu a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste de clés de jeu par groupe spécifique", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/key/sku/{item_sku}": { "get": { "description": "Récupère une clé de jeu pour le catalogue.", "operationId": "get-game-key-by-sku", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_1", "type": "game_key", "virtual_prices": [] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_2" } } }, "description": "La clé de jeu a été reçue avec succès." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_key_1' not found", "statusCode": 404 } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_404_1" } } }, "description": "Clé de jeu non trouvée." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une clé de jeu pour le catalogue", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/game/sku/{item_sku}": { "get": { "description": "Récupère un jeu pour le catalogue.", "operationId": "get-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/item-sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_1" } } }, "description": "Le jeu a été reçu avec succès." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_404" } } }, "description": "Jeu non trouvé." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire un jeu pour le catalogue", "tags": [ "game keys" ] } }, "/v2/project/{project_id}/items/groups": { "get": { "description": "Récupère une liste de groupes d'objets pour la constitution d'un catalogue.", "operationId": "get-item-groups", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "groups": [ { "children": [], "description": "Accessory", "external_id": "accessory", "level": 0, "name": "Accessory", "order": 1 }, { "children": [], "description": "Background", "external_id": "background", "level": 0, "name": "Background", "order": 1 }, { "children": [], "description": "Hair", "external_id": "hair", "level": 0, "name": "Hair", "order": 1 }, { "children": [], "description": "Outfit", "external_id": "outfit", "level": 0, "name": "Outfit", "order": 1 }, { "children": [], "description": "Body", "external_id": "body", "level": 0, "name": "Body", "order": 1 }, { "children": [], "description": "Body", "external_id": "delete_group", "level": 0, "name": "Body", "order": 1 }, { "children": [ { "children": [], "description": "Group description", "external_id": "test_group_secure", "image_url": "http://static.xsolla.com/img/xsolla-logo2.png", "level": 1, "name": "Test group secure", "order": 5, "parent_external_id": "very_cool_group" } ], "description": "Very cool group", "external_id": "very_cool_group", "level": 0, "name": "Very cool group", "order": 1 }, { "children": [ { "children": [], "description": "Group description", "external_id": "test_group_split", "image_url": "http://static.xsolla.com/img/xsolla-logo2.png", "level": 1, "name": "Test group secure", "order": 1, "parent_external_id": "test_group_secure" } ], "description": "Group description", "external_id": "test_group_secure", "image_url": "http://static.xsolla.com/img/xsolla-logo2.png", "level": 0, "name": "Test group secure", "order": 1 } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_9" } } }, "description": "La liste de groupes a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste de groupes d'objets", "tags": [ "virtual items & currency" ] } }, "/v2/project/{project_id}/items/virtual_currency": { "get": { "description": "Récupère une liste de monnaies virtuelles pour la constitution d'un catalogue.\n\n
Attention. 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 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
", "operationId": "get-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "description": "Big Rocket - short description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_currency", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "description": "description", "groups": [ { "external_id": "hair", "name": "Hair" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_currency", "virtual_prices": [] }, { "attributes": [], "description": "description", "groups": [], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider_2", "type": "virtual_currency", "virtual_prices": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_6" } } }, "description": "La liste de monnaies virtuelles a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste de monnaies virtuelles", "tags": [ "virtual items & currency" ] } }, "/v2/project/{project_id}/items/virtual_currency/package": { "get": { "description": "Récupère une liste de packages de monnaie virtuelle pour la constitution d'un catalogue.\n\n
Attention. 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 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
", "operationId": "get-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "Big Rocket", "quantity": 100, "sku": "big_rocket", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "name": "VC Name first package", "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "sku": "vc_package_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": "description", "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "SHOTGUN FOR TRUE RAIDERS", "quantity": 200, "sku": "shotgun_raider", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "name": "VC Name third package", "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "sku": "vc_package_3", "type": "bundle", "virtual_prices": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_7" } } }, "description": "La liste de packages de monnaie virtuelle a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste de packages de monnaie virtuelle", "tags": [ "virtual items & currency" ] } }, "/v2/project/{project_id}/items/virtual_items": { "get": { "description": "Récupère une liste d'objets virtuels pour la constitution d'un catalogue.\n\n
Attention. 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 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
", "operationId": "get-virtual-items", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "description": "description", "groups": [ { "external_id": "hair", "name": "Hair" } ], "image_url": "http://image.png", "inventory_options": [ { "consumable": [ { "usages_count": 1 } ] }, { "expiration_period": [ { "type": "day" }, { "value": 1 } ] } ], "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test_2", "type": "virtual_currency" } ] }, { "attributes": [], "description": "description", "groups": [], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider_2", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_5" } } }, "description": "La liste d'objets virtuels a été reçue avec succès." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste d'objets virtuels", "tags": [ "virtual items & currency" ] } }, "/v2/project/{project_id}/items/virtual_items/group/{external_id}": { "get": { "description": "Récupère une liste d'objets au sein d'un groupe spécifique pour la constitution d'un catalogue.\n\n
Attention. 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 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
", "operationId": "get-virtual-items-group", "parameters": [ { "$ref": "#/components/parameters/project-id-path-param" }, { "$ref": "#/components/parameters/external-id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional-fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "description": "description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test_2", "type": "virtual_currency" } ] } ] } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_200_8" } } }, "description": "La liste d'objets du groupe spécifié a été reçue avec succès." }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Item group not found", "statusCode": 404 } } }, "schema": { "$ref": "#/components/schemas/Catalog_inline_response_404_2" } } }, "description": "Groupe non trouvé. Assurez-vous que le paramètre `external_id` est correct et que le groupe n'est pas désactivé ou supprimé." } }, "security": [ { "AuthForClient": [] } ], "summary": "Lire une liste d'objets par groupe spécifique", "tags": [ "virtual items & currency" ] } } }, "components": { "securitySchemes": { "AuthForClient": { "description": "Utilisez l'endpoint [Create user token](https://developers.xsolla.com\\/fr/api/digital-distribution-hub/operation/create-user-token) pour générer un jeton.", "scheme": "bearer", "type": "http" }, "basicAuth": { "description": "L'API Xsolla utilise une authentification d'accès de base. Toutes les requêtes adressées à l'API doivent contenir l'en-tête `Authorization: Basic `, où `your_authorization_basic_key` est la paire `distribution_hub_id:api_key` encodée en Base64. \n\nContactez votre gestionnaire de compte pour obtenir `distribution_hub_id` et `api_key`.", "scheme": "basic", "type": "http" } }, "parameters": { "project-id-path-param": { "description": "ID de projet.", "explode": false, "in": "path", "name": "project_id", "required": true, "schema": { "example": 44056, "type": "integer" }, "style": "simple" }, "currency-query-param": { "description": "Devise dans laquelle les prix sont affichés (USD par défaut). Code de devise à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "explode": true, "in": "query", "name": "currency", "required": false, "schema": { "default": "USD", "type": "string" }, "style": "form" }, "locale-query-param": { "description": "Langue de la réponse. Code de langue à deux lettres minuscules selon la norme ISO 639-1.", "explode": true, "in": "query", "name": "locale", "required": false, "schema": { "default": "en", "type": "string" }, "style": "form" }, "item-sku-path-param": { "description": "UGS de l'objet.", "explode": false, "in": "path", "name": "item_sku", "required": true, "schema": { "example": "booster_mega_1", "type": "string" }, "style": "simple" }, "cart-id-path-param": { "description": "ID de panier.", "explode": false, "in": "path", "name": "cart_id", "required": true, "schema": { "example": "custom_id", "type": "string" }, "style": "simple" }, "order-id-path-param": { "description": "ID de commande.", "explode": false, "in": "path", "name": "order_id", "required": true, "schema": { "example": "656", "type": "string" }, "style": "simple" }, "limit-query-param": { "description": "Nombre maximal d'éléments sur une page.", "example": 50, "explode": true, "in": "query", "name": "limit", "required": false, "schema": { "example": 50, "type": "integer" }, "style": "form" }, "offset-query-param": { "description": "Numéro de l'élément à partir duquel la liste est générée (le compte commence à 0).", "example": 0, "explode": true, "in": "query", "name": "offset", "required": false, "schema": { "example": 0, "type": "integer" }, "style": "form" }, "additional-fields-query-param": { "description": "Liste des champs supplémentaires. Ces champs figureront dans la réponse si vous les envoyez dans votre requête. Champs disponibles `media_list`, `order` et `long_description`.", "explode": true, "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, "country-query-param": { "description": "Pays pour la détermination des prix régionaux et des restrictions pour le catalogue. Code pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). Si vous ne spécifiez pas explicitement le pays, il sera déterminé en fonction de l'adresse IP de l'utilisateur.", "explode": true, "in": "query", "name": "country", "required": false, "schema": { "default": "US", "type": "string" }, "style": "form" }, "sku-path-param": { "description": "UGS du lot.", "explode": false, "in": "path", "name": "sku", "required": true, "schema": { "example": "kg_1", "type": "string" }, "style": "simple" }, "external-id-path-param": { "description": "External ID du groupe.", "explode": false, "in": "path", "name": "external_id", "required": true, "schema": { "default": "all", "type": "string" }, "style": "simple" } }, "schemas": { "Cart_admin-attribute-external_id": { "description": "ID unique de l'attribut. Le paramètre `external_id` ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des traits bas.", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "Cart_value-external_id": { "description": "ID unique de la valeur d'un attribut. Le `external_id` ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des tirets bas.", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "Cart_clientattributes_inner": { "properties": { "external_id": { "$ref": "#/components/schemas/Cart_admin-attribute-external_id" }, "name": { "description": "Nom de l'attribut.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Cart_value-external_id" }, "value": { "description": "Valeur de l'attribut.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "Cart_client-attributes": { "default": [], "description": "Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.", "example": { "value": { "external_id": "genre", "name": "Жанр", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } }, "items": { "$ref": "#/components/schemas/Cart_clientattributes_inner" }, "type": "array" }, "Cart_inline_response_200_groups": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "Cart_inline_response_200_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart_client-attributes" }, "description": { "type": "string" }, "groups": { "items": { "$ref": "#/components/schemas/Cart_inline_response_200_groups" }, "type": "array" }, "image_url": { "type": "string" }, "is_free": { "type": "boolean" }, "name": { "nullable": true, "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "Cart_inline_response_200_price": { "description": "Prix du panier.", "example": "{\"amount\":\"6150.0000000000000000\",\"amount_without_discount\":\"6150.0000000000000000\",\"currency\":\"USD\"}", "nullable": true, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": "object" }, "Cart_inline_response_200": { "properties": { "cart_id": { "description": "ID de panier.", "example": "cart_id", "type": "string" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, le panier est gratuit.", "type": "boolean" }, "items": { "example": [ { "attributes": [], "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Cart_inline_response_200_items" }, "type": "array" }, "price": { "$ref": "#/components/schemas/Cart_inline_response_200_price" } }, "type": "object" }, "Cart-Payment_settings_currency": { "description": "Devise de paiement préférée. Code de devise à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "type": "string" }, "Cart_inline_response_200_1_warnings": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } }, "type": "object" }, "Cart_inline_response_200_1": { "properties": { "cart_id": { "description": "ID de panier.", "example": "cart_id", "type": "string" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, le panier est gratuit.", "type": "boolean" }, "items": { "items": { "$ref": "#/components/schemas/Cart_inline_response_200_items" }, "type": "array" }, "price": { "$ref": "#/components/schemas/Cart_inline_response_200_price" }, "warnings": { "example": [ { "attributes": [], "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Xsolla Booster Mega", "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "quantity": 123, "sku": "booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Cart_inline_response_200_1_warnings" }, "type": "array" } }, "type": "object" }, "Cart_inline_response_404": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with Project ID = 44056 and SKU = booster_mega_12222 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" }, "Cart_inline_response_422_1": { "properties": { "errorCode": { "example": 1421, "type": "integer" }, "errorMessage": { "example": "This type of item cannot be put to the cart. Select another type of item.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" }, "Cart_inline_response_422": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "Item quantity must be non-negative integer.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" }, "Order_inline_response_200_1_content_price_1": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet réduit.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "30", "type": "string" }, "currency": { "description": "Devise d'achat par défaut. Code de devise à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "Order_inline_response_200_1_content_items": { "properties": { "is_free": { "description": "Si ce paramètre est défini sur `true`, l'objet est gratuit.", "example": "false", "type": "string" }, "price": { "$ref": "#/components/schemas/Order_inline_response_200_1_content_price_1" }, "quantity": { "description": "Quantité de l'objet.", "example": 1, "type": "integer" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "some_sku", "type": "string" } }, "type": "object" }, "Order_inline_response_200_1_content_price": { "description": "Prix de la commande.", "properties": { "amount": { "description": "Prix de la commande réduit.", "example": "30", "type": "string" }, "amount_without_discount": { "description": "Prix de la commande.", "example": "30", "type": "string" }, "currency": { "description": "Devise d'achat par défaut. Code de devise à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "Order_inline_response_200_1_content_virtual_price": { "description": "Prix de la commande en monnaie virtuelle.", "properties": { "amount": { "description": "Prix de la commande réduit.", "example": "100", "type": "string" }, "amount_without_discount": { "description": "Prix de la commande.", "example": "150", "type": "string" }, "currency": { "description": "UGS de la monnaie virtuelle utilisée dans la commande.", "example": "test_vc", "type": "string" } }, "type": "object" }, "Order_inline_response_200_1_content": { "description": "Détails de la commande.", "properties": { "is_free": { "description": "Si ce paramètre est défini sur `true`, la commande est gratuite.", "example": "false", "type": "string" }, "items": { "description": "Liste des objets.", "example": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "some_sku" } ], "items": { "$ref": "#/components/schemas/Order_inline_response_200_1_content_items" }, "type": "array" }, "price": { "$ref": "#/components/schemas/Order_inline_response_200_1_content_price" }, "virtual_price": { "$ref": "#/components/schemas/Order_inline_response_200_1_content_virtual_price" } }, "type": "object" }, "Order_inline_response_200_1": { "properties": { "content": { "$ref": "#/components/schemas/Order_inline_response_200_1_content" }, "order_id": { "description": "ID de commande.", "example": 1, "type": "integer" }, "status": { "description": "Statut de la commande : `new`/`paid`/`done`/`canceled`.", "example": "paid", "type": "string" } }, "type": "object" }, "Order_inline_response_404": { "properties": { "errorCode": { "example": 9001, "type": "integer" }, "errorMessage": { "example": "[0401-9001]: Order not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" }, "Order_inline_response_200_billing_info_direct_tax": { "properties": { "amount": { "example": 150, "type": "number" }, "name": { "example": "TAX", "type": "string" }, "rate": { "example": 10, "type": "number" } }, "type": "object" }, "Order_inline_response_200_billing_info_indirect_tax": { "properties": { "amount": { "example": 246.75, "type": "number" }, "name": { "example": "VAT", "type": "string" }, "rate": { "example": 20, "type": "number" } }, "type": "object" }, "Order_inline_response_200_billing_info_price": { "properties": { "amount": { "example": 1480.45, "type": "number" }, "currency": { "description": "Devise d'achat. Code à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" } }, "type": "object" }, "Order_inline_response_200_billing_info": { "description": "Informations sur la facturation.", "properties": { "direct_tax": { "items": { "$ref": "#/components/schemas/Order_inline_response_200_billing_info_direct_tax" }, "type": "array" }, "indirect_tax": { "items": { "$ref": "#/components/schemas/Order_inline_response_200_billing_info_indirect_tax" }, "type": "array" }, "price": { "$ref": "#/components/schemas/Order_inline_response_200_billing_info_price" } }, "type": "object" }, "Order_inline_response_200": { "properties": { "billing_info": { "$ref": "#/components/schemas/Order_inline_response_200_billing_info" }, "order_id": { "description": "ID de commande.", "type": "integer" } }, "type": "object" }, "Order_inline_response_422": { "properties": { "errorCode": { "example": 1401, "type": "integer" }, "errorMessage": { "example": "[0401-1401]: Invalid cart", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" }, "Order_inline_response_422_1": { "properties": { "errorCode": { "example": 1411, "type": "integer" }, "errorMessage": { "example": "[0401-1411]: Invalid item", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" }, "email-required": { "properties": { "country": { "description": "Code pays à deux lettres majuscules selon la norme [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).", "example": "US", "nullable": true, "type": "string" }, "email": { "description": "Adresse e-mail de l'utilisateur pour la réception de la clé de jeu achetée.", "example": "public_email@test.com", "type": "string" }, "id": { "description": "Identifiant unique de l'utilisateur dans le jeu.", "example": "public_id", "nullable": true, "type": "string" }, "ip": { "description": "Adresse IP de l'utilisateur.", "example": "127.0.0.1", "nullable": true, "type": "string" }, "name": { "description": "Nom public de l'utilisateur.", "example": "Public name", "nullable": true, "type": "string" }, "phone": { "description": "Numéro de téléphone de l'utilisateur.", "example": "+66-000-000-00-00", "nullable": true, "type": "string" } }, "required": [ "email" ] }, "Common_inline_response_200_1": { "properties": { "token": { "description": "Jeton d'utilisateur.", "type": "string" } }, "type": "object" }, "Catalog_admin-attribute-external_id": { "description": "ID unique de l'attribut. Le paramètre `external_id` ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des traits bas.", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "Catalog_value-external_id": { "description": "ID unique de la valeur d'un attribut. Le `external_id` ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des tirets bas.", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "Catalog_clientattributes_inner": { "properties": { "external_id": { "$ref": "#/components/schemas/Catalog_admin-attribute-external_id" }, "name": { "description": "Nom de l'attribut.", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Catalog_value-external_id" }, "value": { "description": "Valeur de l'attribut.", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "Catalog_client-attributes-common": { "default": [], "description": "Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.", "items": { "$ref": "#/components/schemas/Catalog_clientattributes_inner" }, "type": "array" }, "Catalog_bundle_type": { "description": "Type de lot. Dans ce cas, il s'agit toujours de `standart`.", "example": "standart", "type": "string" }, "Catalog_client_content_inner": { "description": "Objet dans le package.", "properties": { "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "price": { "description": "Prix de l'objet.", "nullable": true, "properties": { "amount": { "description": "Prix de l'objet avec remise.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "type": "string" }, "currency": { "description": "Devise d'achat par défaut. Code de devise à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "quantity": { "description": "Quantité de l'objet dans le package.", "example": 250, "type": "integer" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des traits bas.", "example": "big_rocket", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet en monnaie virtuelle avec remise.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "Catalog_client_content": { "description": "Contenu du lot.", "example": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "quantity": 100, "sku": "big_rocket", "type": "virtual_currency" } ], "items": { "$ref": "#/components/schemas/Catalog_client_content_inner" }, "type": "array" }, "Catalog_client_description": { "description": "Description de l'objet.", "example": "Big Rocket - description.", "nullable": true, "type": "string" }, "Catalog_groups_response_inner": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "Catalog_groups_response": { "default": [], "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "$ref": "#/components/schemas/Catalog_groups_response_inner" }, "type": "array" }, "Catalog_image_url": { "description": "URL de l'image.", "example": "https://image.example.com", "nullable": true, "type": "string" }, "Catalog_is_free": { "default": "false", "description": "Toujours `false`.", "example": "false", "type": "string" }, "Catalog_client_name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "Catalog_amount": { "description": "Prix de l'objet avec remise.", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Catalog_amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Catalog_currency": { "description": "Devise d'achat. Code à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" }, "Catalog_price": { "description": "Prix de l'objet.", "nullable": true, "properties": { "amount": { "$ref": "#/components/schemas/Catalog_amount" }, "amount_without_discount": { "$ref": "#/components/schemas/Catalog_amount_without_discount" }, "currency": { "$ref": "#/components/schemas/Catalog_currency" } }, "required": [ "amount", "amount_without_discount", "currency" ], "type": "object" }, "Catalog_sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "bundle_1", "type": "string" }, "Catalog_total_content_price": { "description": "Somme des prix du contenu du lot.", "nullable": true, "properties": { "amount": { "description": "Somme des prix du contenu du lot avec remise.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Somme des prix du contenu du lot.", "example": "100.99", "type": "string" }, "currency": { "$ref": "#/components/schemas/Catalog_currency" } }, "type": "object" }, "Catalog_type": { "description": "Type d'objet.", "example": "bundle", "type": "string" }, "Catalog_virtual_prices_inner": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet en monnaie virtuelle avec remise.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet en monnaie virtuelle.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Most popular gold", "nullable": true, "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "nullable": true, "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "Gold", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "gold", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "Catalog_virtual_prices": { "description": "Prix virtuels.", "items": { "$ref": "#/components/schemas/Catalog_virtual_prices_inner" }, "type": "array" }, "Catalog_client_bundle": { "description": "The specified bundle.", "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes-common" }, "bundle_type": { "$ref": "#/components/schemas/Catalog_bundle_type" }, "content": { "$ref": "#/components/schemas/Catalog_client_content" }, "description": { "$ref": "#/components/schemas/Catalog_client_description" }, "groups": { "$ref": "#/components/schemas/Catalog_groups_response" }, "image_url": { "$ref": "#/components/schemas/Catalog_image_url" }, "is_free": { "$ref": "#/components/schemas/Catalog_is_free" }, "name": { "$ref": "#/components/schemas/Catalog_client_name" }, "price": { "$ref": "#/components/schemas/Catalog_price" }, "sku": { "$ref": "#/components/schemas/Catalog_sku" }, "total_content_price": { "$ref": "#/components/schemas/Catalog_total_content_price" }, "type": { "$ref": "#/components/schemas/Catalog_type" }, "virtual_prices": { "$ref": "#/components/schemas/Catalog_virtual_prices" } }, "type": "object" }, "Catalog_inline_response_200_10": { "description": "Informations sur les objets.", "properties": { "items": { "items": { "$ref": "#/components/schemas/Catalog_client_bundle" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_groups": { "properties": { "external_id": { "example": "accessory", "type": "string" }, "name": { "example": "Accessory", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet réduit.", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "2.9900", "type": "string" }, "currency": { "description": "Devise d'achat par défaut. Code de devise à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_virtual_prices": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "Image de la monnaie virtuelle.", "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_unit_items": { "properties": { "drm_name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "ID unique du DRM. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "steam", "type": "string" }, "has_keys": { "description": "Si `true`, le module Clés de jeu a des clés vendables.", "example": false, "type": "boolean" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, l'objet est gratuit.", "example": false, "type": "boolean" }, "is_pre_order": { "description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée.", "example": true, "type": "boolean" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_price" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes-common" }, "description": { "description": "Description de l'objet.", "example": "Game description", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "Nom de l'objet.", "example": "Game name", "type": "string" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "example": "unit", "type": "string" }, "unit_items": { "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_unit_items" }, "type": "array" }, "unit_type": { "description": "Type d'unité : `game`.", "example": "game", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200": { "description": "Objet contenant des jeux.", "properties": { "items": { "example": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_2", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_4_drm": { "properties": { "drm_id": { "description": "ID du DRM.", "example": 1, "type": "number" }, "image": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "link": { "description": "Lien d'échange.", "example": "https://support.us.playstation.com", "type": "string" }, "name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "redeem_instruction_link": { "description": "Lien d'instructions d'échange.", "example": "https://support.us.playstation.com", "type": "string" }, "sku": { "description": "ID unique du DRM. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "steam", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_4": { "description": "Objet contenant des jeux.", "properties": { "drm": { "example": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_4_drm" }, "type": "array" } }, "type": "object" }, "Catalog_client-attributes": { "default": [], "description": "Liste des attributs et de leurs valeurs correspondantes pour le jeu.\n\n
Attention. Cette partie de la réponse n'est disponible que si vous envoyez le paramètre de requête `additional_fields[]=attributes`.
", "items": { "$ref": "#/components/schemas/Catalog_clientattributes_inner" }, "type": "array" }, "Catalog_inline_response_200_3_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Game description", "type": "string" }, "drm_name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "ID unique du DRM. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "steam", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "has_keys": { "description": "Si `true`, le module Clés de jeu a des clés vendables.", "example": false, "type": "boolean" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, l'objet est gratuit.", "example": false, "type": "boolean" }, "is_pre_order": { "description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée.", "example": true, "type": "boolean" }, "name": { "description": "Nom de l'objet.", "example": "Game name", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_price" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_3": { "description": "Objet contenant des jeux.", "properties": { "items": { "example": [ { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_2", "type": "game_key", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_3_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_2": { "description": "Informations sur les clés du jeu.", "example": { "attributes": { "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value" }, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_1", "type": "game_key", "virtual_prices": [] }, "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes-common" }, "description": { "description": "Description de l'objet.", "example": "Game description", "type": "string" }, "drm_name": { "description": "Nom du DRM.", "example": "Steam", "type": "string" }, "drm_sku": { "description": "ID unique du DRM. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "steam", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "has_keys": { "description": "Si `true`, le module Clés de jeu a des clés vendables.", "example": false, "type": "boolean" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, l'objet est gratuit.", "example": false, "type": "boolean" }, "is_pre_order": { "description": "Si `true`, la clé de jeu est en pré-commande et la date de sortie n'est pas dépassée.", "example": true, "type": "boolean" }, "name": { "description": "Nom de l'objet.", "example": "Game name", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_price" }, "release_date": { "description": "Date de publication de la clé de jeu au format ISO 8601.", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `game_key`.", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_404_1": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_key_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_1": { "description": "Informations sur le jeu.", "example": { "attributes": { "$ref": "#/components/examples/client-attribute-game/Catalog_value" }, "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "sku": "game_1", "type": "unit", "unit_items": [ { "drm_name": "Steam", "drm_sku": "steam", "has_keys": true, "is_free": false, "is_pre_order": true, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "game_key_01", "type": "game_key", "virtual_prices": [] }, { "drm_name": "Origin", "drm_sku": "origin", "has_keys": false, "is_free": false, "is_pre_order": false, "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "sku": "game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Game description", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla game" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "Nom de l'objet.", "example": "Game name", "type": "string" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "game_01", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`.", "example": "unit", "type": "string" }, "unit_items": { "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_unit_items" }, "type": "array" }, "unit_type": { "description": "Type d'unité : `game`.", "example": "game", "type": "string" } }, "type": "object" }, "Catalog_inline_response_404": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_9_children": { "properties": { "children": { "description": "Groupes enfant.", "example": [], "items": { "type": "string" }, "type": "array" }, "description": { "description": "Description du groupe.", "example": "Accessory", "type": "string" }, "external_id": { "description": "External ID du groupe.", "example": "accessory", "type": "string" }, "image_url": { "description": "URL de l'image.", "type": "string" }, "level": { "description": "Niveau d'imbrication du groupe.", "example": 2, "type": "integer" }, "name": { "description": "Nom du groupe.", "example": "Accessory", "type": "string" }, "order": { "description": "Définit l'ordre d'empilement.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "External ID du groupe parent.", "example": "background", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_9_children_1": { "properties": { "children": { "description": "Groupes enfant.", "example": [ { "children": [], "description": "Accessory", "external_id": "accessory", "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_9_children" }, "type": "array" }, "description": { "description": "Description du groupe.", "example": "Background description", "type": "string" }, "external_id": { "description": "External ID du groupe.", "example": "background", "type": "string" }, "image_url": { "description": "URL de l'image du groupe.", "type": "string" }, "level": { "description": "Niveau d'imbrication du groupe.", "example": 1, "type": "integer" }, "name": { "description": "Nom du groupe.", "example": "Background", "type": "string" }, "order": { "description": "Définit l'ordre d'empilement.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "External ID du groupe parent.", "example": "hair", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_9_groups": { "properties": { "children": { "description": "Groupes enfant.", "example": [ { "children": [ { "children": [], "description": "Accessory", "external_id": "accessory", "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "description": "Background description", "external_id": "background", "level": 1, "name": "Background", "order": 1, "parent_external_id": "hair" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_9_children_1" }, "type": "array" }, "description": { "description": "Description du groupe.", "example": "Hair description", "type": "string" }, "external_id": { "description": "External ID du groupe.", "example": "hair", "type": "string" }, "image_url": { "description": "URL de l'image.", "type": "string" }, "level": { "description": "Niveau d'imbrication du groupe.", "example": 0, "type": "integer" }, "name": { "description": "Nom du groupe.", "example": "Hair", "type": "string" }, "order": { "description": "Définit l'ordre d'empilement.", "example": 1, "type": "integer" }, "parent_external_id": { "description": "External ID du groupe parent.", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_9": { "properties": { "groups": { "example": [ { "children": [ { "children": [ { "children": [], "description": "Accessory", "external_id": "accessory", "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "description": "Background description", "external_id": "background", "level": 1, "name": "Background", "order": 1, "parent_external_id": "hair" } ], "description": "Hair description", "external_id": "hair", "level": 0, "name": "Hair", "order": 1 }, { "children": [], "description": "Super description", "external_id": "group_external_id", "level": 0, "name": "Super", "order": 1 } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_9_groups" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_5_inventory_options_consumable": { "description": "Définit la propriété de consommabilité, s'il s'agit d'un objet consommable, ou `null` s'il s'agit d'un objet non consommable.", "nullable": true, "properties": { "usages_count": { "description": "Nombre total d'utilisations restantes s'il s'agit d'un objet consommable, ou `null` s'il s'agit d'un objet non consommable.", "example": 1, "nullable": true, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_5_inventory_options_expiration_period": { "description": "Définit la propriété d'expiration s'il s'agit d'un objet à durée limitée, ou `null` s'il s'agit d'un objet à durée illimitée.", "nullable": true, "properties": { "type": { "description": "Définit le type d'expiration de l'objet.", "enum": [ "minute", "hour", "day", "week", "month", "year" ], "example": "day", "type": "string" }, "value": { "description": "Définit la valeur du délai d'expiration.", "example": 1, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_5_inventory_options": { "description": "Définit les propriétés de l'objet d'inventaire.", "properties": { "consumable": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_consumable" }, "expiration_period": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_expiration_period" } }, "type": "object" }, "Catalog_inline_response_200_5_price": { "description": "Prix de l'objet.", "properties": { "amount": { "description": "Prix de l'objet réduit.", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": "100.99", "type": "string" }, "currency": { "description": "Devise d'achat par défaut. Code de devise à trois lettres selon la norme [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).", "example": "USD", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_6_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "accessory", "name": "Accessory" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "inventory_options": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, l'objet est gratuit.", "example": "false", "type": "string" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_price" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "big_rocket", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "example": [ { "amount": 100, "amount_without_discount": 100, "image_url": "http://image.png", "is_default": true, "sku": "shotgun_raider" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_6": { "properties": { "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] } ], "description": "Big Rocket - short description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_currency", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "1" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "value": "3.9" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "value": "Strategy" }, { "value": "Tactical" }, "Turn-based" ] } ], "description": "description", "groups": [ { "external_id": "hair", "name": "Hair" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_currency", "virtual_prices": [] }, { "attributes": [], "description": "description", "groups": [], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "is_free": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider_2", "type": "virtual_currency", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_6_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_7_inventory_options_expiration_period": { "description": "Définit la propriété d'expiration s'il s'agit d'un objet à durée limitée, ou `null` s'il s'agit d'un objet à durée illimitée.", "nullable": true, "properties": { "type": { "description": "Définit le type d'expiration de l'objet.", "enum": [ "minute", "hour", "day", "week", "month", "year" ], "example": "day", "type": "string" }, "value": { "description": "Définit la valeur du délai d'expiration.", "example": 1, "type": "integer" } }, "type": "object" }, "Catalog_inline_response_200_7_inventory_options": { "description": "Définit les propriétés de l'objet d'inventaire.", "properties": { "consumable": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_consumable" }, "expiration_period": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options_expiration_period" } }, "type": "object" }, "Catalog_inline_response_200_7_content": { "description": "Monnaie virtuelle dans le package.", "properties": { "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "inventory_options": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "quantity": { "description": "Quantité de la monnaie virtuelle dans le package.", "example": 250, "type": "integer" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des traits bas.", "example": "big_rocket", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_7_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "bundle_type": { "description": "Type de lot : `standard`/`virtual_currency_package`.", "example": "virtual_currency_package", "type": "string" }, "content": { "description": "Contenu du package de monnaie virtuelle.", "example": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "Big Rocket", "quantity": 100, "sku": "big_rocket", "type": "virtual_currency" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_content" }, "type": "array" }, "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "accessory", "name": "Accessory" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, l'objet est gratuit.", "example": "false", "type": "string" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_price" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "big_rocket", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "bundle", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_7": { "description": "Informations sur les objets.", "properties": { "items": { "example": [ { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "Big Rocket", "quantity": 100, "sku": "big_rocket", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "name": "VC Name first package", "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "sku": "vc_package_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": "description", "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 } }, "name": "SHOTGUN FOR TRUE RAIDERS", "quantity": 200, "sku": "shotgun_raider", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "name": "VC Name third package", "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "sku": "vc_package_3", "type": "bundle", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_5_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "accessory", "name": "Accessory" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "inventory_options": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, l'objet est gratuit.", "example": false, "type": "boolean" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_price" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "big_rocket", "type": "string" }, "type": { "description": "Type d'objet : `virtual_good`/`virtual_currency`/`bundle`.", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type d'objet virtuel.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_5": { "description": "Informations sur les objets virtuels.", "properties": { "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "description": "description", "groups": [ { "external_id": "hair", "name": "Hair" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test_2", "type": "virtual_currency" } ] }, { "attributes": [], "description": "description", "groups": [], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "shotgun_raider_2", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_8_virtual_prices": { "description": "Prix virtuel.", "properties": { "amount": { "description": "Prix de l'objet réduit en monnaie virtuelle.", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "Prix de l'objet.", "example": 200, "type": "integer" }, "description": { "description": "Description de la monnaie virtuelle.", "example": "Big Rocket - description", "type": "string" }, "image_url": { "example": "http://image.png", "type": "string" }, "is_default": { "description": "Indique si le prix est le prix par défaut de l'objet.", "example": true, "type": "boolean" }, "name": { "description": "Nom de la monnaie virtuelle.", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "UGS de la monnaie virtuelle.", "example": "vc_test", "type": "string" }, "type": { "description": "Type de monnaie virtuelle.", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "Catalog_inline_response_200_8_items": { "properties": { "attributes": { "$ref": "#/components/schemas/Catalog_client-attributes" }, "description": { "description": "Description de l'objet.", "example": "Big Rocket - description", "type": "string" }, "groups": { "description": "Groupes auxquels l'objet appartient.", "example": [ { "external_id": "accessory", "name": "Accessory" } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_groups" }, "type": "array" }, "image_url": { "description": "URL de l'image.", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "inventory_options": { "$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options" }, "is_free": { "description": "Si ce paramètre est défini sur `true`, l'objet est gratuit.", "example": "false", "type": "string" }, "name": { "description": "Nom de l'objet.", "example": "Big Rocket", "type": "string" }, "price": { "$ref": "#/components/schemas/Catalog_inline_response_200_5_price" }, "sku": { "description": "ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.", "example": "big_rocket", "type": "string" }, "type": { "description": "Type d'objet : `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`.", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type d'objet virtuel.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non_consumable", "type": "string" }, "virtual_prices": { "description": "Prix virtuels.", "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_8_virtual_prices" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_200_8": { "properties": { "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] } ], "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "Big Rocket", "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "sku": "big_rocket", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "value": "3.9" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "value": "Strategy" }, { "value": "Tactical" }, "Turn-based" ] } ], "description": "description", "groups": [ { "external_id": "accessory", "name": "Accessory" } ], "image_url": "http://image.png", "inventory_options": { "consumable": { "usages_count": 1 }, "expiration_period": { "type": "day", "value": 1 } }, "is_free": false, "name": "SHOTGUN FOR TRUE RAIDERS", "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "sku": "shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "vc_test_2", "type": "virtual_currency" } ] } ], "items": { "$ref": "#/components/schemas/Catalog_inline_response_200_8_items" }, "type": "array" } }, "type": "object" }, "Catalog_inline_response_404_2": { "properties": { "errorCode": { "example": 4403, "type": "integer" }, "errorMessage": { "example": "[0401-4403]: Item group not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } }, "requestBodies": { "fill-cart-json-model": { "content": { "application/json": { "schema": { "example": [ { "quantity": 123, "sku": "booster_mega_1" } ], "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "items": { "description": "Liste des objets.", "items": { "minItems": 1, "properties": { "quantity": { "default": 123, "type": "number" }, "sku": { "default": "booster_mega_1", "type": "string" } }, "required": [ "quantity", "sku" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" } } } }, "put-item-by-cart-id-json-model": { "content": { "application/json": { "schema": { "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "quantity": { "default": 123, "description": "Quantité de l'objet.", "type": "number" } }, "type": "object" } } } }, "create-order-model": { "content": { "application/json": { "schema": { "example": { "geotype": 13038 }, "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "geotype": { "description": "ID du partenaire distributeur du côté de Xsolla.", "type": "number" }, "quantity": { "description": "Quantité de l'objet.", "example": 1, "type": "integer" } }, "required": [ "geotype", "currency" ], "type": "object" } } }, "description": "Données pour la création de la commande.", "required": true }, "post-user-token-json-model": { "content": { "application/json": { "schema": { "properties": { "user": { "$ref": "#/components/schemas/email-required", "description": "Informations sur l'utilisateur.", "type": "object" } }, "required": [ "user" ], "type": "object" } } } } }, "examples": { "200-get-bundle-list": { "value": { "items": [ { "attributes": { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] }, "bundle_type": "standard", "content": [ { "attributes": { "external_id": "size", "name": "Size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Large" } ] }, "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "quantity": 100, "sku": "big_rocket", "type": "virtual_currency", "virtual_item_type": "non_consumable", "virtual_prices": [] } ], "description": "pricePoint_44056_1", "groups": [], "is_free": false, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "price": { "amount": 9.99, "amount_without_discount": 9.99, "currency": "USD" }, "sku": "kg_1", "total_content_price": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "type": "bundle", "virtual_prices": [] } ] } }, "200-get-bundle": { "value": { "attributes": [], "bundle_type": "standard", "content": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "quantity": 100, "sku": "big_rocket", "type": "virtual_currency", "virtual_prices": [] } ], "description": "pricePoint_44056_1.", "groups": [], "is_free": false, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "price": { "amount": 9.99, "amount_without_discount": 9.99, "currency": "USD" }, "sku": "kg_1", "total_content_amount": { "amount": 10.99, "amount_without_discount": 10.99, "currency": "USD" }, "type": "bundle", "virtual_prices": [] } } } }, "x-tagGroups": [ { "name": "Panier", "tags": [ "cart" ] }, { "name": "Catalogue", "tags": [ "game keys", "virtual items & currency", "bundles" ] }, { "name": "Communs", "tags": [ "user token" ] }, { "name": "Notifications", "tags": [ "notifications" ] }, { "name": "Commande", "tags": [ "order" ] } ] }