components:
  examples:
    Player-Inventory_inventory_purchase_request_example:
      value:
        - purchase:
            amount: '3.5'
            comment: xsolla
            currency: USD
            custom_parameters:
              - user_device_info:
                  engine_version: Unity 2020.2.0b5
                  os: windows
                user_public_id:
                  nickname: player1
              - comment: xsolla
                custom_parameters:
                  content_creator_rewards:
                    - content_creator:
                        id: cc1
                      reward:
                        amount: '10.00'
                        currency: USD
                    - content_creator:
                        id: cc2
                      reward:
                        amount: '15.00'
                        currency: RUB
                items:
                  - quantity: 5
                    sku: com.xsolla.panda_sdk3
                  - quantity: 3
                    sku: com.xsolla.panda_sdk2
                platform: xsolla
                purchase:
                  amount: '3.5'
                  currency: USD
                  external_purchase_date: '2020-01-01T00:00:00+05:00'
                  external_purchase_id: '1000001'
                user:
                  id: 83857636-65b4-11e8-9ccb-42010a8a001c
            external_purchase_date: '2020-01-01T00:00:00+05:00'
            external_purchase_id: '1000000'
            items:
              - quantity: 5
                sku: com.xsolla.panda_sdk1
              - quantity: 3
                sku: com.xsolla.panda_sdk2
            platform: xsolla
            user:
              id: 672c91cd-65db-4b6e-ad68-6e93b21249d8
  parameters:
    limit-query-param:
      description: Nombre maximal d'éléments sur une page.
      example: 50
      in: query
      name: limit
      required: false
      schema:
        example: 50
        minimum: 1
        type: integer
    offset-query-param:
      description: >-
        Numéro de l'élément à partir duquel la liste est générée (le décompte
        commence à 0).
      example: 0
      in: query
      name: offset
      required: false
      schema:
        example: 0
        minimum: 0
        type: integer
    project_id-path-param:
      description: >-
        ID de projet. Ce paramètre se trouve dans le [Compte
        éditeur](https://publisher.xsolla.com/) à côté du nom du projet.
      in: path
      name: project_id
      required: true
      schema:
        example: 44056
        type: integer
  responses:
    Player-Inventory_401-invalid-basic-auth:
      content:
        application/json:
          examples:
            response:
              value:
                errorCode: 1020
                errorMessage: '[0401-1020]: Error in Authentication method occurred'
                statusCode: 401
          schema:
            properties:
              errorCode:
                example: 1020
                type: integer
              errorMessage:
                example: '[0401-1020]: Error in Authentication method occurred'
                type: string
              statusCode:
                example: 401
                type: integer
            type: object
      description: >-
        L'authentification de base n'a pas été passée ou est incorrecte.
        Vérifiez que vous avez utilisé l'authentification de base ou des
        informations d'identification correctes.
  schemas:
    Player-Inventory_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:
        properties:
          external_id:
            $ref: '#/components/schemas/admin-attribute-external_id'
          name:
            description: Nom de l'attribut.
            example: Genre
            type: string
          values:
            items:
              properties:
                external_id:
                  $ref: '#/components/schemas/value-external_id'
                value:
                  description: Valeur de l'attribut.
                  example: Strategy
                  type: string
              type: object
            type: array
        type: object
      type: array
    Player-Inventory_custom_parameters:
      additionalProperties:
        oneOf:
          - type: array
          - type: object
          - type: string
          - type: integer
          - type: 'null'
          - type: number
          - type: boolean
      description: Paramètres spécifiques au projet.
      example:
        array_param:
          - user_device_info:
              engine_version: Unity 2020.2.0b5
              os: windows
            user_public_id:
              nickname: player1
          - user_device_info:
              engine_version: UE 4.25
              os: mac
            user_public_id:
              nickname: player1
        bool_param: true
        int_param: 100
        null_param: null
        object_param:
          key: value
      maxProperties: 200
      minProperties: 1
      type: object
    admin-attribute-external_id:
      description: >-
        ID unique de l'attribut. Le `external_id` ne peut comprendre que des
        caractères alphanumériques latins minuscules et majuscules, des tirets
        et des traits bas.
      example: attribute_1
      maxLength: 255
      minLength: 1
      pattern: ^[a-zA-Z0-9-_]+$
      type: string
    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
  securitySchemes:
    XsollaLoginUserJWT:
      bearerFormat: JWT
      description: "Par défaut, JWT utilisateur Xsolla Login (jeton Bearer) est utilisé pour \nl'autorisation. Vous pouvez essayer d'appeler cet endpoint avec un JWT \nutilisateur Xsolla Login de test\_: `Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`.\n\nVous pouvez également utiliser le [jeton d'accès Pay \nStation](https://developers.xsolla.com/fr/api/pay-station/operation/create-token/)."
      scheme: bearer
      type: http
    basicAuth:
      description: "L'API Xsolla utilise une authentification d'accès de base. Toutes les requêtes \nadressées à l'API doivent contenir l'en-tête `Authorization: Basic \n<your_authorization_basic_key>`, où `your_authorization_basic_key` est la paire \n`project_id:api_key` encodée en Base64.\n\nVous pouvez utiliser `merchant_id` au lieu de `project_id` si nécessaire. Cela \nn'affecte pas la fonctionnalité.\n\nAccédez au [Compte éditeur](https://publisher.xsolla.com/) pour trouver les \nvaleurs des paramètres\_:\n\n* `merchant_id` est affichée :\n  * Dans la section **Paramètres de l'entreprise > Entreprise**\n  * Dans l'URL dans la barre d'adresse du navigateur sur n'importe quelle page du \n    compte de l'éditeur. L'URL a le format suivant : \n    `https://publisher.xsolla.com/<merchant_id>`.\n* `api_key` n'apparaît dans le compte de l'éditeur qu'une seule fois lors de sa \n  création et doit être stockée de votre côté. Vous pouvez créer une nouvelle clé \n  dans la section suivante :\n  * **Paramètres de l'entreprise > Clés API**\n  * **Paramètres du projet > Clés API**\n* `project_id` est affichée :\n  * Dans Compte de l'éditeur, à côté du nom du projet.\n  * Dans l'URL dans la barre d'adresse du navigateur lorsque vous travaillez sur un \n    projet dans le compte de l'éditeur. L'URL a le format suivant : \n    `https://publisher.xsolla.com/<merchant_id>/projets/<project_id>`.\n\nPour plus d'informations sur l'utilisation des clés API, voir la  [référence de \nl'API](https://developers.xsolla.com/fr/api/getting-started/#api_keys_overview).\n"
      scheme: basic
      type: http
info:
  description: >-
    # Overview


    * **Version:** 2.0.0

    * **Servers**: `https://store.xsolla.com/api`

    * **[Contact Us by Email](mailto:integration@xsolla.com)**

    * **Contact URL:** https://xsolla.com/

    * **Required TLS version:** 1.2


    Shop Builder API provides a third-party solution for implementing

    the server side for your store interface. Use the endpoints to manage
    in-game items,

    in-game currencies, cart, player inventory, promotions, game library, etc.
  title: Shop Builder API
  version: 2.0.0
openapi: 3.0.0
paths:
  /v2/project/{project_id}/inventory/account/link:
    post:
      description: Connecte le compte de jeu de l'utilisateur à un compte Xsolla.
      operationId: inventory-account-link
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              properties:
                linking_code:
                  description: >-
                    Code de liaison. Il est utilisé par les utilisateurs pour
                    approuver la connexion de leur compte à un compte Xsolla.
                  example: 53LRH2
                  type: string
                platform:
                  description: Plateforme de publication sur laquelle l'utilisateur joue.
                  enum:
                    - playstation_network
                    - xbox_live
                    - xsolla
                    - pc_standalone
                    - nintendo_shop
                    - google_play
                    - app_store_ios
                    - android_standalone
                    - ios_standalone
                    - android_other
                    - ios_other
                    - pc_other
                  example: xbox_live
                  type: string
                user_id:
                  description: >-
                    ID utilisateur sur la plateforme de publication sur laquelle
                    l'utilisateur joue.
                  example: platform_user_id
                  type: string
              required:
                - linking_code
                - platform
                - user_id
              type: object
        required: true
      responses:
        '204':
          description: >-
            Le compte de jeu de l'utilisateur a été connecté avec succès au
            compte Xsolla.
        '401':
          $ref: '#/components/responses/Player-Inventory_401-invalid-basic-auth'
        '422':
          content:
            application/json:
              examples:
                response:
                  value:
                    errorCode: 1102
                    errorMessage: >-
                      [0401-1102]: Unprocessable Entity. The property
                      publisher_project_id is required
                    statusCode: 422
              schema:
                properties:
                  errorCode:
                    example: 1102
                    type: integer
                  errorMessage:
                    example: >-
                      [0401-1102]: Unprocessable Entity. The property
                      publisher_project_id is required
                    type: string
                  statusCode:
                    example: 422
                    type: integer
                type: object
          description: >-
            La propriété `linking_code` est requise. Assurez-vous de l'avoir
            passée dans votre requête.
      security:
        - basicAuth: []
      summary: Connecter un compte de jeu à Xsolla
      tags:
        - cross-inventory
      x-badges:
        - color: '#95ff80'
          name: Server-side
  /v2/project/{project_id}/inventory/account/signin:
    post:
      description: >-
        Récupère un JWT pour interagir avec Shop Builder API pour les
        utilisateurs de votre plateforme de publication.
      operationId: inventory-account-signin
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              properties:
                platform:
                  description: Plateforme de publication sur laquelle l'utilisateur joue.
                  enum:
                    - playstation_network
                    - xbox_live
                    - xsolla
                    - pc_standalone
                    - nintendo_shop
                    - google_play
                    - app_store_ios
                    - android_standalone
                    - ios_standalone
                    - android_other
                    - ios_other
                    - pc_other
                  example: xbox_live
                  type: string
                user_id:
                  description: >-
                    ID utilisateur sur la plateforme de publication sur laquelle
                    l'utilisateur joue.
                  example: platform_user_id
                  type: string
              required:
                - user_id
                - platform
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  token:
                    example: >-
                      eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI
                    type: string
                type: object
          description: Le compte de jeu de l'utilisateur a été correctement tokénisé.
        '401':
          $ref: '#/components/responses/Player-Inventory_401-invalid-basic-auth'
        '422':
          content:
            application/json:
              examples:
                response:
                  value:
                    errorCode: 1102
                    errorMessage: >-
                      [0401-1102]: Unprocessable Entity. The property
                      publisher_project_id is required
                    statusCode: 422
              schema:
                properties:
                  errorCode:
                    example: 1102
                    type: integer
                  errorMessage:
                    example: >-
                      [0401-1102]: Unprocessable Entity. The property
                      publisher_project_id is required
                    type: string
                  statusCode:
                    example: 422
                    type: integer
                type: object
          description: >-
            La propriété `user_id` est requise. Assurez-vous de l'avoir passée
            dans votre requête.
      security:
        - basicAuth: []
      summary: Tokénisation de l'utilisateur
      tags:
        - cross-inventory
      x-badges:
        - color: '#95ff80'
          name: Server-side
  /v2/project/{project_id}/inventory/purchase:
    post:
      description: >-
        Ajoute des objets spécifiques aux inventaires des utilisateurs
        spécifiques en fonction de leurs achats.


        <div class="notice"><strong>Attention</strong><br><br><strong>Seules 50
        opérations</strong> peuvent être traitées à la fois. Les opérations qui
        dépassent cette limite seront ignorées.</div>
      operationId: grant-item-by-purchase
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            examples:
              example:
                $ref: >-
                  #/components/examples/Player-Inventory_inventory_purchase_request_example
            schema:
              items:
                properties:
                  comment:
                    default: Monthly challenge rewards
                    description: "Description de l'opération. Par exemple : «\_Récompenses mensuelles.\_»"
                    maxLength: 255
                    minLength: 1
                    type: string
                  custom_parameters:
                    $ref: '#/components/schemas/Player-Inventory_custom_parameters'
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: Nombre d'objets de cette classe à octroyer.
                          type: number
                        sku:
                          default: booster_mega_1
                          description: >-
                            Identifiant de la classe de l'objet. L'UGS ne peut
                            comprendre que des caractères alphanumériques latins
                            minuscules, des points, des tirets et des traits
                            bas.
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: Plateforme de publication sur laquelle l'utilisateur joue.
                    enum:
                      - playstation_network
                      - xbox_live
                      - xsolla
                      - pc_standalone
                      - nintendo_shop
                      - google_play
                      - app_store_ios
                      - android_standalone
                      - ios_standalone
                      - android_other
                      - ios_other
                      - pc_other
                    type: string
                  purchase:
                    properties:
                      amount:
                        default: '2.99'
                        description: Montant de l'achat avant toute déduction.
                        type: string
                      currency:
                        default: USD
                        description: >-
                          Devise d'achat selon la norme [ISO
                          4217](https://en.wikipedia.org/wiki/ISO_4217).
                        type: string
                      external_purchase_date:
                        default: '2020-01-01T05:00:00+05:00'
                        description: Date d'achat selon la norme ISO 8601.
                        type: string
                      external_purchase_id:
                        default: 10-534-35
                        description: >-
                          Identifiant de facture de l'achat sur la plateforme
                          sur laquelle l'achat a été effectué.
                        type: string
                    required:
                      - amount
                      - currency
                      - external_purchase_id
                      - external_purchase_date
                    type: object
                  user:
                    properties:
                      id:
                        default: d342dad2-9d59-11e9-a384-42010aa8003f
                        description: Identifiant unique de l'utilisateur sur la plateforme.
                        type: string
                    type: object
                required:
                  - user
                  - items
                  - purchase
                type: object
              type: array
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    count: 2
                    operations:
                      - amount: '2.99'
                        comment: Quest completed
                        currency: USD
                        custom_parameters:
                          array_param:
                            - user_device_info:
                                engine_version: Unity 2020.2.0b5
                                os: windows
                              user_public_id:
                                nickname: player1
                            - user_device_info:
                                engine_version: UE 4.25
                                os: mac
                              user_public_id:
                                nickname: player2
                        external_purchase_date: '2020-01-01T05:00:00+05:00'
                        external_purchase_id: 10-534-35
                        items:
                          - quantity: 5
                            sku: com.xsolla.boots_1
                          - quantity: 3
                            sku: com.xsolla.crystal_pack_1
                        order_id: 123456
                        platform: xbox_live
                        user_id: 0125760a-6810-11e9-84c0-42010aa80029
                      - amount: '2.99'
                        comment: Daily reward
                        currency: USD
                        custom_parameters: null
                        external_purchase_date: '2020-01-01T05:00:00+05:00'
                        external_purchase_id: 10-534-35
                        items:
                          - quantity: 2
                            sku: com.xsolla.helmet_1
                          - quantity: 3
                            sku: com.xsolla.minigun_1
                        order_id: 123457
                        platform: xbox_live
                        user_id: a7d10a4e-3f68-43cc-a6b2-893d2c68fd14
              schema:
                properties:
                  count:
                    example: 10
                    type: integer
                  operations:
                    items:
                      properties:
                        amount:
                          description: Montant de l'achat avant toute déduction.
                          example: '2.99'
                          type: string
                        comment:
                          description: "Description de l'opération. Par exemple : «\_Récompenses mensuelles.\_»"
                          example: Montly challange rewards
                          type: string
                        currency:
                          description: >-
                            Devise d'achat selon la norme [ISO
                            4217](https://en.wikipedia.org/wiki/ISO_4217).
                          example: USD
                          type: string
                        custom_parameters:
                          $ref: >-
                            #/components/schemas/Player-Inventory_custom_parameters
                        external_purchase_date:
                          description: Date d'achat selon la norme ISO 8601.
                          example: '2020-01-01T05:00:00+05:00'
                          type: string
                        external_purchase_id:
                          description: >-
                            Identifiant de facture de l'achat sur la plateforme
                            sur laquelle l'achat a été effectué.
                          example: 10-534-35
                          type: string
                        items:
                          items:
                            properties:
                              quantity:
                                description: Nombre d'objets de cette classe à octroyer.
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  Identifiant de la classe 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: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        order_id:
                          description: Description de l'opération côté Xsolla.
                          example: 123456
                          type: number
                        platform:
                          description: >-
                            Plateforme de publication sur laquelle l'utilisateur
                            joue.
                          enum:
                            - playstation_network
                            - xbox_live
                            - xsolla
                            - pc_standalone
                            - nintendo_shop
                            - google_play
                            - app_store_ios
                            - android_standalone
                            - ios_standalone
                            - android_other
                            - ios_other
                            - pc_other
                          example: xbox_live
                          type: string
                        user_id:
                          description: >-
                            Identifiant unique de l'utilisateur sur la
                            plateforme.
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: Achat de l'utilisateur effectué avec succès.
        '422':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: Code d'erreur.
                      example: 1102
                      type: integer
                    errorMessage:
                      description: Message d'erreur.
                      example: >-
                        [0401-1102]: Unprocessable Entity. The property sku is
                        required
                      type: string
                    statusCode:
                      example: 422
                      type: integer
                  type: object
                type: array
            incorrect_format_input_data:
              examples:
                response:
                  value:
                    errorCode: 1102
                    errorMessage: >-
                      [0401-1102]: Unprocessable Entity. The property sku is
                      required
                    statusCode: 422
          description: Unprocessable Entity.
      security:
        - basicAuth: []
      summary: Octroyer des objets à des utilisateurs par achats
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/revoke:
    post:
      description: "Révoque l'accès de plusieurs utilisateurs à des objets.\n\n<div class=\"notice\"><strong>Attention</strong><br><br><strong>Seules 50\_opérations</strong> peuvent être traitées à la fois. Les opérations qui dépassent cette limite seront ignorées.</div>"
      operationId: revoke-item
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  comment:
                    default: Item was transferred to another player
                    description: "Description de l'opération. Par exemple\_: «\_L'objet a été transféré à un autre joueur.\_»"
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: Nombre d'objets de cette classe à révoquer.
                          minimum: 1
                          type: integer
                        sku:
                          default: booster_mega_1
                          description: >-
                            ID unique de l'objet. L'UGS ne peut comprendre que
                            des caractères alphanumériques latins minuscules et
                            majuscules, des points, des tirets et des traits
                            bas.
                          minLength: 1
                          type: string
                      required:
                        - sku
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: Plateforme de publication sur laquelle l'utilisateur joue.
                    enum:
                      - playstation_network
                      - xbox_live
                      - xsolla
                      - pc_standalone
                      - nintendo_shop
                      - google_play
                      - app_store_ios
                      - android_standalone
                      - ios_standalone
                      - android_other
                      - ios_other
                      - pc_other
                    example: xsolla
                    type: string
                  user:
                    properties:
                      id:
                        default: d342dad2-9d59-11e9-a384-42010aa8003f
                        description: Identifiant unique de l'utilisateur sur la plateforme.
                        type: string
                    type: object
                required:
                  - user
                  - items
                type: object
              type: array
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    count: 2
                    operations:
                      - comment: Remove from inventory
                        items:
                          - balance: 3
                            quantity: 5
                            sku: com.xsolla.boots_1
                          - balance: 5
                            quantity: 3
                            sku: com.xsolla.crystal_pack_1
                        platform: xsolla
                        user_id: 0125760a-6810-11e9-84c0-42010aa80029
                      - comment: Cheater
                        items:
                          - balance: 0
                            quantity: 2
                            sku: com.xsolla.helmet_1
                          - balance: 0
                            quantity: 3
                            sku: com.xsolla.minigun_1
                        platform: xsolla
                        user_id: a7d10a4e-3f68-43cc-a6b2-893d2c68fd14
              schema:
                properties:
                  count:
                    description: >-
                      Nombre d'utilisateurs dont les objets ont été révoqués
                      avec succès.
                    example: 10
                    type: integer
                  operations:
                    description: Description des opérations.
                    items:
                      properties:
                        comment:
                          description: "Description de l'opération. Par exemple\_: «\_L'objet a été transféré à un autre joueur.\_»"
                          example: Some comment for this operation
                          type: string
                        items:
                          description: Objets concernés par cette opération.
                          items:
                            properties:
                              balance:
                                description: >-
                                  Nombre total d'objets de cette classe en
                                  possession de l'utilisateur.
                                example: 1
                                type: integer
                              quantity:
                                description: Nombre d'objets révoqués de cette classe.
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  Identifiant de la classe 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: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        platform:
                          default: xsolla
                          enum:
                            - playstation_network
                            - xbox_live
                            - xsolla
                            - pc_standalone
                            - nintendo_shop
                            - google_play
                            - app_store_ios
                            - android_standalone
                            - ios_standalone
                            - android_other
                            - ios_other
                            - pc_other
                          example: xbox_live
                          type: string
                        user_id:
                          description: >-
                            Identifiant unique de l'utilisateur sur la
                            plateforme.
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: >-
            La révocation des objets des utilisateurs a été effectuée avec
            succès.
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: Code d'erreur.
                      example: 4001
                      type: integer
                    errorMessage:
                      description: Message d'erreur.
                      example: >-
                        [0401-5004]: Could not find instance in inventory: Could
                        not remove 10, user only has 1
                      type: string
                    statusCode:
                      example: 404
                      type: integer
                  type: object
                type: array
            incorrect_format_input_data:
              examples:
                response:
                  value:
                    errorCode: 1104
                    errorMessage: >-
                      [0401-1102]: Unprocessable Entity. The property sku is
                      required
                    statusCode: 404
            many_items:
              examples:
                response:
                  value:
                    errorCode: 5004
                    errorMessage: >-
                      [0401-4001]: Could not find item for project 44056 with id
                      armor_max ()
                    statusCode: 404
            not_found_user:
              examples:
                response:
                  value:
                    errorCode: 0
                    errorMessage: Could not find User
                    statusCode: 404
            remove_many:
              examples:
                response:
                  value:
                    errorCode: 4001
                    errorMessage: >-
                      [0401-5004]: Could not find instance in inventory: Could
                      not remove 10, user only has 1
                    statusCode: 404
          description: Échec de la suppression de ce nombre d'objets.
      security:
        - basicAuth: []
      summary: Révoquer des objets d'inventaire
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/reward:
    post:
      description: >-
        Ajoute des objets spécifiques aux inventaires des utilisateurs
        spécifiques.


        <div class="notice"><strong>Attention</strong><br><br><strong>Seules 50
        opérations</strong> peuvent être traitées à la fois. Les opérations qui
        dépassent cette limite seront ignorées.</div>
      operationId: add-item-to-inventory
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  comment:
                    default: Monthly challenge rewards
                    description: "Description de l'opération. Par exemple : «\_Récompenses mensuelles.\_»"
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: Nombre d'objets de cette classe à octroyer.
                          type: number
                        sku:
                          default: booster_mega_1
                          description: >-
                            Identifiant de la classe de l'objet. L'UGS ne peut
                            comprendre que des caractères alphanumériques latins
                            minuscules, des points, des tirets et des traits
                            bas.
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: Plateforme de publication sur laquelle l'utilisateur joue.
                    enum:
                      - playstation_network
                      - xbox_live
                      - xsolla
                      - pc_standalone
                      - nintendo_shop
                      - google_play
                      - app_store_ios
                      - android_standalone
                      - ios_standalone
                      - android_other
                      - ios_other
                      - pc_other
                    type: string
                  user:
                    properties:
                      id:
                        default: d342dad2-9d59-11e9-a384-42010aa8003f
                        description: Identifiant unique de l'utilisateur sur la plateforme.
                        type: string
                    type: object
                required:
                  - user
                  - items
                type: object
              type: array
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    count: 2
                    operations:
                      - comment: Quest completed
                        items:
                          - balance: 5
                            quantity: 5
                            sku: com.xsolla.boots_1
                          - balance: 3
                            quantity: 3
                            sku: com.xsolla.crystal_pack_1
                        platform: xsolla
                        user_id: 0125760a-6810-11e9-84c0-42010aa80029
                      - comment: Daily reward
                        items:
                          - balance: 5
                            quantity: 2
                            sku: com.xsolla.helmet_1
                          - balance: 5
                            quantity: 3
                            sku: com.xsolla.minigun_1
                        platform: xsolla
                        user_id: a7d10a4e-3f68-43cc-a6b2-893d2c68fd14
              schema:
                properties:
                  count:
                    example: 10
                    type: integer
                  operations:
                    items:
                      properties:
                        comment:
                          description: "Description de l'opération. Par exemple : «\_Récompenses mensuelles.\_»"
                          example: Montly challange rewards
                          type: string
                        items:
                          items:
                            properties:
                              balance:
                                description: >-
                                  Nombre total d'objets de cette classe en
                                  possession de l'utilisateur.
                                example: 5
                                type: integer
                              quantity:
                                description: Nombre d'objets de cette classe à octroyer.
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  Identifiant de la classe 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: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        platform:
                          description: >-
                            Plateforme de publication sur laquelle l'utilisateur
                            joue.
                          enum:
                            - null
                            - playstation_network
                            - xbox_live
                            - xsolla
                            - pc_standalone
                            - nintendo_shop
                            - google_play
                            - app_store_ios
                            - android_standalone
                            - ios_standalone
                            - android_other
                            - ios_other
                            - pc_other
                          example: xbox_live
                          nullable: true
                          type: string
                        user_id:
                          description: >-
                            Identifiant unique de l'utilisateur sur la
                            plateforme.
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: Récompenses octroyées aux utilisateurs avec succès.
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: Code d'erreur.
                      example: 4001
                      type: integer
                    errorMessage:
                      description: Message d'erreur.
                      example: >-
                        [0401-4001]: Could not find item for project 44056 with
                        id armor_max ()
                      type: string
                    statusCode:
                      example: 404
                      type: integer
                  type: object
                type: array
            incorrect_format_input_data:
              examples:
                response:
                  value:
                    errorCode: 1104
                    errorMessage: >-
                      [0401-1102]: Unprocessable Entity. The property sku is
                      required
                    statusCode: 404
            many_items:
              examples:
                response:
                  value:
                    errorCode: 5004
                    errorMessage: >-
                      [0401-4001]: Could not find item for project 44056 with id
                      armor_max ()
                    statusCode: 404
            not_found_user:
              examples:
                response:
                  value:
                    errorCode: 0
                    errorMessage: Could not find User
                    statusCode: 404
          description: Objet non trouvé pour le projet.
      security:
        - basicAuth: []
      summary: Octroyer des objets à des utilisateurs
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/set:
    post:
      description: >-
        Définit des objets spécifiques aux inventaires des utilisateurs
        spécifiques. Notez que les nouvelles données remplaceront les anciennes
        données.


        <div class="notice"><strong>Attention</strong><br><br><strong>Seules 50
        opérations</strong> peuvent être traitées à la fois. Les opérations qui
        dépassent cette limite seront ignorées.</div>
      operationId: set-item-quantity
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              items:
                properties:
                  comment:
                    default: Monthly inventory syncing
                    description: "Description de l'opération. Par exemple\_: «\_Synchronisation mensuelle de l'inventaire.\_»"
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: Nombre d'objets de cette classe à octroyer.
                          type: number
                        sku:
                          default: booster_mega_1
                          description: >-
                            Identifiant de la classe de l'objet. L'UGS ne peut
                            comprendre que des caractères alphanumériques latins
                            minuscules, des points, des tirets et des traits
                            bas.
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: Plateforme de publication sur laquelle l'utilisateur joue.
                    enum:
                      - playstation_network
                      - xbox_live
                      - xsolla
                      - pc_standalone
                      - nintendo_shop
                      - google_play
                      - app_store_ios
                      - android_standalone
                      - ios_standalone
                      - android_other
                      - ios_other
                      - pc_other
                    type: string
                  user:
                    properties:
                      id:
                        default: d342dad2-9d59-11e9-a384-42010aa8003f
                        description: Identifiant unique de l'utilisateur sur la plateforme.
                        type: string
                    type: object
                required:
                  - user
                  - items
                type: object
              type: array
        required: true
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    count: 2
                    operations:
                      - comment: Monthly inventory syncing
                        items:
                          - balance: 5
                            quantity: 5
                            sku: com.xsolla.boots_1
                          - balance: 3
                            quantity: 3
                            sku: com.xsolla.crystal_pack_1
                        platform: xsolla
                        user_id: 0125760a-6810-11e9-84c0-42010aa80029
                      - comment: Monthly inventory syncing
                        items:
                          - balance: 2
                            quantity: 2
                            sku: com.xsolla.helmet_1
                          - balance: 3
                            quantity: 3
                            sku: com.xsolla.minigun_1
                        platform: xsolla
                        user_id: a7d10a4e-3f68-43cc-a6b2-893d2c68fd14
              schema:
                properties:
                  count:
                    example: 10
                    type: integer
                  operations:
                    items:
                      properties:
                        comment:
                          description: "Description de l'opération. Par exemple\_: «\_Synchronisation quotidienne de l'inventaire.\_»"
                          example: Daily inventory syncing
                          type: string
                        items:
                          items:
                            properties:
                              balance:
                                description: >-
                                  Nombre total d'objets de cette classe en
                                  possession de l'utilisateur.
                                example: 5
                                type: integer
                              quantity:
                                description: Nombre d'objets de cette classe à octroyer.
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  Identifiant de la classe 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: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        platform:
                          description: >-
                            Plateforme de publication sur laquelle l'utilisateur
                            joue.
                          enum:
                            - playstation_network
                            - xbox_live
                            - xsolla
                            - pc_standalone
                            - nintendo_shop
                            - google_play
                            - app_store_ios
                            - android_standalone
                            - ios_standalone
                            - android_other
                            - ios_other
                            - pc_other
                          example: xbox_live
                          type: string
                        user_id:
                          description: >-
                            Identifiant unique de l'utilisateur sur la
                            plateforme.
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: Réponse de succès.
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: Code d'erreur.
                      example: 4001
                      type: integer
                    errorMessage:
                      description: Message d'erreur.
                      example: >-
                        [0401-4001]: Could not find item for project 44056 with
                        id armor_max ()
                      type: string
                    statusCode:
                      example: 404
                      type: integer
                  type: object
                type: array
            incorrect_format_input_data:
              examples:
                response:
                  value:
                    errorCode: 1104
                    errorMessage: >-
                      [0401-1102]: Unprocessable Entity. The property sku is
                      required
                    statusCode: 404
            many_items:
              examples:
                response:
                  value:
                    errorCode: 5004
                    errorMessage: >-
                      [0401-4001]: Could not find item for project 44056 with id
                      armor_max ()
                    statusCode: 404
            not_found_user:
              examples:
                response:
                  value:
                    errorCode: 0
                    errorMessage: Could not find User
                    statusCode: 404
          description: Objet non trouvé pour le projet.
      security:
        - basicAuth: []
      summary: Définir des objets à des utilisateurs
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/user/inventory/item/consume:
    post:
      description: >-
        Endpoint client. Consomme un objet de l'inventaire actuel d'un
        utilisateur.
      operationId: consume-item
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: Plateforme de publication sur laquelle l'utilisateur joue.
          in: query
          name: platform
          required: false
          schema:
            default: xsolla
            enum:
              - playstation_network
              - xbox_live
              - xsolla
              - pc_standalone
              - nintendo_shop
              - google_play
              - app_store_ios
              - android_standalone
              - ios_standalone
              - android_other
              - ios_other
              - pc_other
            type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                quantity:
                  default: 1
                  description: Quantité de l'objet.
                  example: 1
                  type: number
                sku:
                  default: booster_mega_1
                  description: >-
                    ID unique de l'objet. L'UGS ne peut comprendre que des
                    caractères alphanumériques latins minuscules et majuscules,
                    des points, des tirets et des traits bas.
                  example: booster_mega_1
                  type: string
              required:
                - sku
                - quantity
              type: object
      responses:
        '200':
          description: Un objet de l'inventaire utilisateur a été consommé.
        '404':
          content:
            application/json:
              schema:
                properties:
                  errorCode:
                    example: 4001
                    type: integer
                  errorMessage:
                    example: >-
                      [0401-4001]: Item with Project Id = 44056 and Sku = gun_5
                      not found
                    type: string
                  statusCode:
                    example: 404
                    type: integer
                type: object
            application/json 1:
              examples:
                response:
                  value:
                    errorCode: 4001
                    errorMessage: >-
                      [0401-4001]: Item with Project Id = 44056 and Sku = gun_5
                      not found
                    statusCode: 404
            application/json 2:
              examples:
                response:
                  value:
                    errorCode: 5004
                    errorMessage: >-
                      [0401-5004]: Could not find instance in inventory: Could
                      not remove 112299999344, user only has 12
                    statusCode: 404
          description: "L'objet n'a pas été trouvé du tout\_; l'objet n'a pas été trouvé dans l'inventaire\_; ou il n'y a pas suffisamment d'unités de l'objet (tentative de consommer plus que la quantité initiale disponible)."
        '422':
          content:
            application/json:
              examples:
                response:
                  value:
                    errorCode: 5002
                    errorMessage: '[0401-5002]: Quantity and item_id/sku must be specified'
                    statusCode: 422
              schema:
                properties:
                  errorCode:
                    example: 5002
                    type: integer
                  errorMessage:
                    example: '[0401-5002]: Quantity and item_id/sku must be specified'
                    type: string
                  statusCode:
                    example: 422
                    type: integer
                type: object
          description: Assurez-vous que les paramètres `quantity` et `sku` sont passés.
      security:
        - XsollaLoginUserJWT: []
      summary: Consommer un objet
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/inventory/items:
    get:
      description: "Endpoint client. Récupère l'inventaire actuel de l'utilisateur.\n\n<div class=\"notice\"><strong>Attention</strong><br><br>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 <strong>50\_éléments par réponse.</strong> Pour obtenir plus de données page par page, utilisez les champs <b>limit</b> et <b>offset</b>.</div>"
      operationId: get-user-inventory
      parameters:
        - $ref: '#/components/parameters/project_id-path-param'
        - $ref: '#/components/parameters/limit-query-param'
        - $ref: '#/components/parameters/offset-query-param'
        - description: Plateforme de publication sur laquelle l'utilisateur joue.
          in: query
          name: platform
          required: false
          schema:
            default: xsolla
            enum:
              - playstation_network
              - xbox_live
              - xsolla
              - pc_standalone
              - nintendo_shop
              - google_play
              - app_store_ios
              - android_standalone
              - ios_standalone
              - android_other
              - ios_other
              - pc_other
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    items:
                      - attributes: []
                        description: Big Rocket - short description
                        groups: []
                        image_url: https://picture.bigrocket.png
                        instance_id: null
                        name: Rocket
                        quantity: null
                        remaining_uses: 1
                        sku: com.xsolla.instanciated_item_1
                        type: virtual_good
                        virtual_item_type: non_consumable
                      - attributes: []
                        description: description
                        groups: []
                        image_url: http://image.png
                        instance_id: null
                        name: SHOTGUN FOR TRUE RAIDERS
                        quantity: 2
                        remaining_uses: 1
                        sku: com.xsolla.shotgun_raider_1
                        type: virtual_good
                        virtual_item_type: non_consumable
                      - attributes:
                          - external_id: stack_size
                            name: Stack size
                            values:
                              - external_id: >-
                                  stack_size_value_99c25352ab6e34a0e0755fc2a9daa7a76021dce2
                                value: 5
                          - external_id: licensed
                            name: Licensed
                            values:
                              - external_id: >-
                                  licensed_value_d75d8034dd2f82cb3d2789f5ec1837a6c350b505
                                value: true
                        description: null
                        groups: []
                        image_url: null
                        instance_id: null
                        name: HEADPHONES
                        quantity: 5
                        remaining_uses: 1
                        sku: com.xsolla.headphones_for_pro_1
                        type: virtual_good
                        virtual_item_type: non_consumable
                      - attributes: []
                        description: null
                        groups: []
                        image_url: null
                        instance_id: null
                        name: UNIQUE DIAMONDS
                        quantity: 100
                        remaining_uses: 1
                        sku: com.xsolla.platform_currency_1
                        type: virtual_currency
              schema:
                properties:
                  items:
                    example:
                      - attributes: []
                        description: Big Rocket - short description
                        groups: []
                        image_url: https://picture.bigrocket.png
                        instance_id: null
                        name: Rocket
                        quantity: null
                        remaining_uses: 1
                        sku: com.xsolla.instanciated_item_1
                        type: virtual_good
                        virtual_item_type: non_consumable
                      - attributes: []
                        description: description
                        groups: []
                        image_url: http://image.png
                        instance_id: null
                        name: SHOTGUN FOR TRUE RAIDERS
                        quantity: 2
                        remaining_uses: 1
                        sku: com.xsolla.shotgun_raider_1
                        type: virtual_good
                        virtual_item_type: non_consumable
                      - attributes:
                          - external_id: stack_size
                            name: Stack size
                            values:
                              - external_id: >-
                                  stack_size_value_99c25352ab6e34a0e0755fc2a9daa7a76021dce2
                                value: 5
                          - external_id: licensed
                            name: Licensed
                            values:
                              - external_id: >-
                                  licensed_value_d75d8034dd2f82cb3d2789f5ec1837a6c350b505
                                value: true
                        description: null
                        groups: []
                        image_url: null
                        instance_id: null
                        name: HEADPHONES
                        quantity: 5
                        remaining_uses: 1
                        sku: com.xsolla.headphones_for_pro_1
                        type: virtual_good
                        virtual_item_type: non_consumable
                      - attributes: []
                        description: null
                        groups: []
                        image_url: null
                        instance_id: null
                        name: UNIQUE DIAMONDS
                        quantity: 100
                        remaining_uses: 1
                        sku: com.xsolla.platform_currency_1
                        type: virtual_currency
                    items:
                      properties:
                        attributes:
                          $ref: >-
                            #/components/schemas/Player-Inventory_client-attributes
                        description:
                          description: Description de l'objet.
                          example: Big Rocket - short description
                          type: string
                        groups:
                          description: Groupes auxquels l'objet appartient.
                          example:
                            - external_id: accessory
                              name: Accessory
                          items:
                            properties:
                              external_id:
                                example: accessory
                                type: string
                              name:
                                example: Accessory
                                type: string
                            type: object
                          type: array
                        image_url:
                          description: URL de l'image.
                          example: https://picture.bigrocket.png
                          type: string
                        instance_id:
                          deprecated: true
                          description: Paramètre obsolète. Toujours `null`.
                          type: 'null'
                        name:
                          description: Nom de l'objet.
                          example: Rocket
                          type: string
                        quantity:
                          description: Quantité de l'objet.
                          example: null
                          nullable: true
                          type: integer
                        remaining_uses:
                          description: "Définit les propriétés de consommation\_: nombre 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
                        sku:
                          description: >-
                            ID unique de l'objet. L'UGS ne peut comprendre que
                            des caractères alphanumériques latins minuscules et
                            majuscules, des points, des tirets et des traits
                            bas.
                          example: com.xsolla.instanciated_item_1
                          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
                          nullable: true
                          type: string
                      type: object
                    type: array
                type: object
          description: L'inventaire de l'utilisateur a été récupéré avec succès.
      security:
        - XsollaLoginUserJWT: []
      summary: Lire l'inventaire actuel de l'utilisateur
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/time_limited_items:
    get:
      description: >-
        Endpoint client. Récupère les objets à durée limitée actuels d'un
        utilisateur.
      operationId: get-user-subscriptions
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: Plateforme de publication sur laquelle l'utilisateur joue.
          in: query
          name: platform
          required: false
          schema:
            default: xsolla
            enum:
              - playstation_network
              - xbox_live
              - xsolla
              - pc_standalone
              - nintendo_shop
              - google_play
              - app_store_ios
              - android_standalone
              - ios_standalone
              - android_other
              - ios_other
              - pc_other
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    items:
                      - description: >-
                          The PLEX or “30-day Pilot's License EXtension” is a
                          virtual item that represents 30 days of subscription
                          time and can be bought for cash and then sold to other
                          players for in-game ISK.
                        expired_at: 1746057600
                        image_url: https://picture.bigrocket.png
                        name: PLEX
                        sku: com.xsolla.plex_1
                        status: active
                        type: virtual_good
                        virtual_item_type: non_renewing_subscription
                      - description: >-
                          WoW token allows players to buy game time World of
                          Warcraft for money and sell it for game gold at
                          auction.
                        expired_at: 1546304461
                        image_url: https://picture.bigrocket.png
                        name: WoW Token
                        sku: com.xsolla.token_1
                        status: expired
                        type: virtual_good
                        virtual_item_type: non_renewing_subscription
                      - amount: 10
                        description: >-
                          Premium. Premium Status provides a character with
                          several benefits allowing faster overall progression.
                        expired_at: null
                        image_url: https://picture.bigrocket.png
                        name: Premium account
                        sku: com.xsolla.premium_item_1
                        status: none
                        type: virtual_good
                        virtual_item_type: non_renewing_subscription
              schema:
                properties:
                  items:
                    example:
                      - amount: 10
                        description: Ruble
                        image_url: https://picture.bigrocket.png
                        name: Ruble
                        sku: com.xsolla.VC_1
                        type: virtual_currency
                        virtual_item_type: non_renewing_subscription
                      - amount: 5000
                        description: Xsollar
                        image_url: http://image.png
                        name: Xsollar
                        sku: com.xsolla.VC_2
                        type: virtual_currency
                        virtual_item_type: non_renewing_subscription
                    items:
                      properties:
                        description:
                          description: Description de l'objet.
                          example: >-
                            Premium. Premium Status provides a character with
                            several benefits allowing faster overall
                            progression.
                          type: string
                        expired_at:
                          description: >-
                            Horodatage Unix. Date d'expiration de l'objet à
                            durée limitée. Si l'utilisateur ne possède pas
                            l'objet, la valeur est `null`.
                          example: 1746057600
                          type: integer
                        image_url:
                          description: URL de l'image.
                          example: https://picture.bigrocket.png
                          type: string
                        name:
                          description: Nom de la l'abonnement.
                          example: Premium status
                          type: string
                        sku:
                          description: >-
                            ID unique de l'objet. L'UGS ne peut comprendre que
                            des caractères alphanumériques latins minuscules et
                            majuscules, des points, des tirets et des traits
                            bas.
                          example: com.xsolla.premium_item_1
                          type: string
                        status:
                          description: "Statut de l'objet à durée limitée.\nL'objet peut avoir trois statuts\_:\n- `none` — non acheté\_;\n- `active` — l'objet est actif\_;\n- `expired` — l'objet a été acheté, mais a expiré."
                          example: active
                          type: string
                        type:
                          description: "Type d'objet\_: `virtual_good`."
                          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
                          x-enumDescriptions:
                            consumable: >-
                              Un objet qui disparaît de l'inventaire après
                              utilisation (par exemple, des munitions).
                            non_consumable: >-
                              Un objet qui reste dans l'inventaire pour une
                              durée illimitée.
                            non_renewing_subscription: >-
                              Objet à durée limitée qui peut représenter l'accès
                              à des services ou à du contenu pour une période de
                              temps limitée.
                      type: object
                    type: array
                type: object
          description: >-
            Les objets à durée limitée de l'utilisateur ont été récupérés avec
            succès.
      security:
        - XsollaLoginUserJWT: []
      summary: Lire les objets à durée limitée actuels d'un utilisateur
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/virtual_currency_balance:
    get:
      description: Endpoint client. Récupère le solde virtuel actuel de l'utilisateur.
      operationId: get-user-virtual-balance
      parameters:
        - description: ID de projet.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: Plateforme de publication sur laquelle l'utilisateur joue.
          in: query
          name: platform
          required: false
          schema:
            default: xsolla
            enum:
              - playstation_network
              - xbox_live
              - xsolla
              - pc_standalone
              - nintendo_shop
              - google_play
              - app_store_ios
              - android_standalone
              - ios_standalone
              - android_other
              - ios_other
              - pc_other
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                response:
                  value:
                    items:
                      - amount: 10
                        description: Ruble
                        image_url: https://picture.bigrocket.png
                        name: Ruble
                        sku: com.xsolla.VC_1
                        type: virtual_currency
                      - amount: 5000
                        description: Xsollar
                        image_url: http://image.png
                        name: Xsollar
                        sku: com.xsolla.VC_2
                        type: virtual_currency
              schema:
                properties:
                  items:
                    example:
                      - description: >-
                          The PLEX or “30-day Pilot's License EXtension” is a
                          virtual item that represents 30 days of subscription
                          time and can be bought for cash and then sold to other
                          players for in-game ISK.
                        expired_at: 1746057600
                        image_url: https://picture.bigrocket.png
                        name: PLEX
                        sku: com.xsolla.plex_1
                        status: active
                        type: virtual_good
                        virtual_item_type: non_renewing_subscription
                      - description: >-
                          WoW token allows players to buy game time World of
                          Warcraft for money and sell it for game gold at
                          auction.
                        expired_at: 1546304461
                        image_url: https://picture.bigrocket.png
                        name: WoW Token
                        sku: com.xsolla.token_1
                        status: expired
                        type: virtual_good
                        virtual_item_type: non_renewing_subscription
                    items:
                      properties:
                        amount:
                          description: Quantité de l'objet.
                          example: null
                          type: integer
                        description:
                          description: Description de l'objet.
                          example: Big Rocket - short description
                          type: string
                        image_url:
                          description: URL de l'image.
                          example: https://picture.bigrocket.png
                          type: string
                        name:
                          description: Nom de l'objet.
                          example: Rocket
                          type: string
                        sku:
                          description: >-
                            ID unique de l'objet. L'UGS ne peut comprendre que
                            des caractères alphanumériques latins minuscules et
                            majuscules, des points, des tirets et des traits
                            bas.
                          example: com.xsolla.instanciated_item_1
                          type: string
                        type:
                          description: "Type d'objet\_: `virtual_good`/`virtual_currency`/`bundle`."
                          example: virtual_currency
                          type: string
                      type: object
                    type: array
                type: object
          description: Le solde virtuel de l'utilisateur a été récupéré avec succès.
      security:
        - XsollaLoginUserJWT: []
      summary: Lire le solde virtuel actuel de l'utilisateur
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
servers:
  - url: https://store.xsolla.com/api
tags:
  - name: inventory-client
    x-displayName: Client
  - name: inventory-management
    x-displayName: Gestion
  - name: cross-inventory
    x-displayName: Inventaire multiplateforme
