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: Limite da quantidade de elementos na página.
      example: 50
      in: query
      name: limit
      required: false
      schema:
        example: 50
        minimum: 1
        type: integer
    offset-query-param:
      description: >-
        Número do elemento a partir do qual a lista é gerada (a quantidade
        começa a partir de 0).
      example: 0
      in: query
      name: offset
      required: false
      schema:
        example: 0
        minimum: 0
        type: integer
    project_id-path-param:
      description: >-
        ID do projeto. Você pode encontrar esse parâmetro em sua [Conta de
        Distribuidor](https://publisher.xsolla.com/) ao lado do nome do projeto.
      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: >-
        Autenticação básica não aprovada ou errada. Verifique se você usou a
        autenticação básica ou as credenciais corretas.
  schemas:
    Player-Inventory_client-attributes:
      default: []
      description: >-
        Lista de atributos e seus valores correspondentes ao item. Pode ser
        usado para a filtragem de catálogos.
      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: Nome do atributo.
            example: Genre
            type: string
          values:
            items:
              properties:
                external_id:
                  $ref: '#/components/schemas/value-external_id'
                value:
                  description: Valor do atributo.
                  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: Parâmetros específicos do projeto.
      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 de atributo exclusivo. O `external_id` só pode conter caracteres
        alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados.
      example: attribute_1
      maxLength: 255
      minLength: 1
      pattern: ^[a-zA-Z0-9-_]+$
      type: string
    value-external_id:
      description: >-
        ID de valor exclusivo para um atributo. O `external_id` pode conter
        apenas caracteres alfanuméricos latinos minúsculos, traços e
        sublinhados.
      example: attribute_value
      maxLength: 255
      minLength: 1
      pattern: ^[-_.\d\w]+$
      type: string
  securitySchemes:
    XsollaLoginUserJWT:
      bearerFormat: JWT
      description: >-
        Por padrão, o Xsolla Login User JWT (Bearer token) é usado para
        autorização. 

        Você pode tentar chamar esse ponto de extremidade com um token de testes
        Xsolla 

        Login User JWT: `Bearer
        eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`.


        Você pode usar o [token de acesso Pay
        Station](https://developers.xsolla.com/pt/api/pay-station/operation/create-token/)
        como uma alternativa.
      scheme: bearer
      type: http
    basicAuth:
      description: >
        A Xsolla API usa autenticação de acesso básica. Todas as solicitações à
        API 

        devem conter o cabeçalho `Authorization: Basic
        <your_authorization_basic_key>`, 

        onde `your_authorization_basic_key` é o par codificado
        `project_id:api_key` de 

        acordo com o padrão Base64.


        Você pode usar `merchant_id` em vez de `project_id` se precisar. Isso
        não afeta 

        a funcionalidade.


        Vá para a [Conta de Distribuidor](https://publisher.xsolla.com/) para
        encontrar 

        valores dos parâmetros:


        * `merchant_id` é mostrado:
          * Na seção **Configurações da empresa > Empresa**
          * Na URL na barra de endereço do navegador em qualquer página de conta de editor. 
            O URL tem o seguinte formato: `https://publisher.xsolla.com/<merchant_id>`.
        * `api_key` é exibida na Conta de Distribuidor apenas uma vez quando é
        criada e 
          deve ser armazenada do seu lado. Você pode criar uma nova chave na seção a 
          seguir:
          * **Configurações da empresa > Chaves API**
          * **Configurações do projeto > Chaves API**
        * `project_id` é mostrado:
          * Na Conta de Distribuidor ao lado do nome do projeto.
          * Na URL na barra de endereços do navegador ao trabalhar no projeto na Conta do 
            Publicador. O URL tem o seguinte formato: 
            `https://publisher.xsolla.com/<merchant_id>/projects/<project_id>`.

        Para obter mais informações sobre como trabalhar com chaves API,
        consulte a 

        [Referência de
        API](https://developers.xsolla.com/pt/api/getting-started/#api_keys_overview)
        .
      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: API Shop Builder
  version: 2.0.0
openapi: 3.0.0
paths:
  /v2/project/{project_id}/inventory/account/link:
    post:
      description: Conecta a conta de jogo do usuário com a conta Xsolla.
      operationId: inventory-account-link
      parameters:
        - description: ID do projeto.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              properties:
                linking_code:
                  description: >-
                    Código de vinculação. Ele é usado pelos usuários para
                    aprovar a conexão de sua conta com a conta Xsolla.
                  example: 53LRH2
                  type: string
                platform:
                  description: Plataforma de publicação em que o usuário joga.
                  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 de usuário da plataforma de publicação em que o usuário
                    joga.
                  example: platform_user_id
                  type: string
              required:
                - linking_code
                - platform
                - user_id
              type: object
        required: true
      responses:
        '204':
          description: >-
            A conta de jogo do usuário foi conectada com sucesso com a conta de
            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: >-
            A propriedade `linking_code` é obrigatória. Certifique-se de
            passá-la em seu pedido.
      security:
        - basicAuth: []
      summary: Conecte a conta do jogo à Xsolla
      tags:
        - cross-inventory
      x-badges:
        - color: '#95ff80'
          name: Server-side
  /v2/project/{project_id}/inventory/account/signin:
    post:
      description: >-
        Obtém JWT para trabalhar com a Shop Builder API para usuários da sua
        plataforma de distribuição.
      operationId: inventory-account-signin
      parameters:
        - description: ID do projeto.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              properties:
                platform:
                  description: Plataforma de publicação em que o usuário joga.
                  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 de usuário de uma plataforma de publicação na qual o
                    usuário joga.
                  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: A conta de jogo do usuário foi tokenizada com sucesso.
        '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: >-
            A propriedade `user_id` é obrigatória. Certifique-se de passá-la em
            seu pedido.
      security:
        - basicAuth: []
      summary: Tokenização de usuário
      tags:
        - cross-inventory
      x-badges:
        - color: '#95ff80'
          name: Server-side
  /v2/project/{project_id}/inventory/purchase:
    post:
      description: >-
        Adiciona os itens especificados por compra aos inventários de usuários
        especificados.


        <div class="notice"><strong>Atenção</strong><br><br><strong>Apenas 50
        operações</strong> podem ser processadas de uma só vez. As operações que
        excederem esse limite serão ignoradas.</div>
      operationId: grant-item-by-purchase
      parameters:
        - description: ID do projeto.
          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: >-
                      Descrição da operação. Por exemplo: "Recompensas mensais
                      por desafio".
                    maxLength: 255
                    minLength: 1
                    type: string
                  custom_parameters:
                    $ref: '#/components/schemas/Player-Inventory_custom_parameters'
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: >-
                            Número de itens dessa classe que precisava ser
                            concedido.
                          type: number
                        sku:
                          default: booster_mega_1
                          description: >-
                            Identificador de classe de item. O SKU só pode
                            conter caracteres alfanuméricos latinos minúsculos,
                            pontos, traços e sublinhados.
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: Plataforma de publicação em que o usuário joga.
                    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: Valor da compra antes de qualquer dedução.
                        type: string
                      currency:
                        default: USD
                        description: >-
                          Moeda de compra no padrão [ISO
                          4217](https://en.wikipedia.org/wiki/ISO_4217).
                        type: string
                      external_purchase_date:
                        default: '2020-01-01T05:00:00+05:00'
                        description: Data de compra no padrão ISO 8601.
                        type: string
                      external_purchase_id:
                        default: 10-534-35
                        description: >-
                          Identificador de fatura de compra da plataforma em que
                          uma compra foi feita.
                        type: string
                    required:
                      - amount
                      - currency
                      - external_purchase_id
                      - external_purchase_date
                    type: object
                  user:
                    properties:
                      id:
                        default: d342dad2-9d59-11e9-a384-42010aa8003f
                        description: O identificador de usuário exclusivo na plataforma.
                        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: Valor da compra antes de qualquer dedução.
                          example: '2.99'
                          type: string
                        comment:
                          description: >-
                            Descrição da operação. Por exemplo: "Recompensas
                            mensais por desafio".
                          example: Montly challange rewards
                          type: string
                        currency:
                          description: >-
                            Moeda de compra no padrão [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: Data de compra no padrão ISO 8601.
                          example: '2020-01-01T05:00:00+05:00'
                          type: string
                        external_purchase_id:
                          description: >-
                            Identificador de fatura de compra da plataforma em
                            que uma compra foi feita.
                          example: 10-534-35
                          type: string
                        items:
                          items:
                            properties:
                              quantity:
                                description: >-
                                  Número de itens dessa classe que precisava ser
                                  concedido.
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  Identificador de classe de item. O SKU só pode
                                  conter caracteres alfanuméricos latinos
                                  minúsculos, pontos, traços e sublinhados.
                                example: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        order_id:
                          description: Descrição da operação do lado da Xsolla.
                          example: 123456
                          type: number
                        platform:
                          description: Plataforma de publicação em que o usuário joga.
                          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: O identificador de usuário exclusivo na plataforma.
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: Compra bem-sucedida do usuário.
        '422':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: Código de erro.
                      example: 1102
                      type: integer
                    errorMessage:
                      description: Mensagem de erro.
                      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: Conceder itens por compras aos usuários
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/revoke:
    post:
      description: >-
        Revoga o acesso a itens de vários usuários.


        <div class="notice"><strong>Atenção</strong><br><br><strong>Apenas 50
        operações</strong> podem ser processadas de uma só vez. As operações que
        excederem esse limite serão ignoradas.</div>
      operationId: revoke-item
      parameters:
        - description: ID do projeto.
          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: >-
                      Descrição da operação. Por exemplo: "Item foi transferido
                      para outro jogador".
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: >-
                            Número de itens dessa classe que precisaram ser
                            revogados.
                          minimum: 1
                          type: integer
                        sku:
                          default: booster_mega_1
                          description: >-
                            ID de item exclusivo. O SKU só pode conter
                            caracteres alfanuméricos latinos minúsculos e
                            maiúsculos, pontos, traços e sublinhados.
                          minLength: 1
                          type: string
                      required:
                        - sku
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: Plataforma de publicação em que o usuário joga.
                    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: O identificador de usuário exclusivo na plataforma.
                        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: >-
                      Número de usuários cujos itens foram revogados com
                      sucesso.
                    example: 10
                    type: integer
                  operations:
                    description: Descrição das operações.
                    items:
                      properties:
                        comment:
                          description: >-
                            Descrição da operação. Por exemplo: "Item foi
                            transferido para outro jogador".
                          example: Some comment for this operation
                          type: string
                        items:
                          description: Itens nesta operação.
                          items:
                            properties:
                              balance:
                                description: >-
                                  Quantidade total de itens desta classe em
                                  posse do usuário.
                                example: 1
                                type: integer
                              quantity:
                                description: Número de itens revogados desta classe.
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  Identificador de classe de item. O SKU só pode
                                  conter caracteres alfanuméricos latinos
                                  minúsculos, pontos, traços e sublinhados.
                                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: O identificador de usuário exclusivo na plataforma.
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: Revogação de itens de usuário bem-sucedida.
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: Código de erro.
                      example: 4001
                      type: integer
                    errorMessage:
                      description: Mensagem de erro.
                      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: Falha ao remover esse número de itens.
      security:
        - basicAuth: []
      summary: Revogar itens de inventário
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/reward:
    post:
      description: >-
        Adiciona os itens especificados aos inventários de usuários
        especificados.


        <div class="notice"><strong>Atenção</strong><br><br><strong>Apenas 50
        operações</strong> podem ser processadas de uma só vez. As operações que
        excederem esse limite serão ignoradas.</div>
      operationId: add-item-to-inventory
      parameters:
        - description: ID do projeto.
          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: >-
                      Descrição da operação. Por exemplo: "Recompensas mensais
                      por desafio".
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: >-
                            Número de itens dessa classe que precisava ser
                            concedido.
                          type: number
                        sku:
                          default: booster_mega_1
                          description: >-
                            Identificador de classe de item. O SKU só pode
                            conter caracteres alfanuméricos latinos minúsculos,
                            pontos, traços e sublinhados.
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: Plataforma de publicação em que o usuário joga.
                    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: O identificador de usuário exclusivo na plataforma.
                        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: >-
                            Descrição da operação. Por exemplo: "Recompensas
                            mensais por desafio".
                          example: Montly challange rewards
                          type: string
                        items:
                          items:
                            properties:
                              balance:
                                description: >-
                                  Quantidade total de itens desta classe em
                                  posse do usuário.
                                example: 5
                                type: integer
                              quantity:
                                description: >-
                                  Número de itens dessa classe que precisava ser
                                  concedido.
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  Identificador de classe de item. O SKU só pode
                                  conter caracteres alfanuméricos latinos
                                  minúsculos, pontos, traços e sublinhados.
                                example: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        platform:
                          description: Plataforma de publicação em que o usuário joga.
                          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: O identificador de usuário exclusivo na plataforma.
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: Recompensa de usuário bem-sucedida.
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: Código de erro.
                      example: 4001
                      type: integer
                    errorMessage:
                      description: Mensagem de erro.
                      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: Item para projeto não encontrado.
      security:
        - basicAuth: []
      summary: Conceder itens aos usuários
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/set:
    post:
      description: >-
        Define itens especificados para inventários de usuários especificados.
        Observe que os novos dados substituirão os dados antigos.


        <div class="notice"><strong>Atenção</strong><br><br><strong>Apenas 50
        operações</strong> podem ser processadas de uma só vez. As operações que
        excederem esse limite serão ignoradas.</div>
      operationId: set-item-quantity
      parameters:
        - description: ID do projeto.
          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: >-
                      Descrição da operação. Por exemplo: "Sincronização mensal
                      de inventário".
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: >-
                            Número de itens dessa classe que precisava ser
                            concedido.
                          type: number
                        sku:
                          default: booster_mega_1
                          description: >-
                            Identificador de classe de item. O SKU só pode
                            conter caracteres alfanuméricos latinos minúsculos,
                            pontos, traços e sublinhados.
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: Plataforma de publicação em que o usuário joga.
                    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: O identificador de usuário exclusivo na plataforma.
                        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: >-
                            Descrição da operação. Por exemplo: "Sincronização
                            diária de inventário".
                          example: Daily inventory syncing
                          type: string
                        items:
                          items:
                            properties:
                              balance:
                                description: >-
                                  Quantidade total de itens desta classe em
                                  posse do usuário.
                                example: 5
                                type: integer
                              quantity:
                                description: >-
                                  Número de itens dessa classe que precisava ser
                                  concedido.
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  Identificador de classe de item. O SKU só pode
                                  conter caracteres alfanuméricos latinos
                                  minúsculos, pontos, traços e sublinhados.
                                example: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        platform:
                          description: Plataforma de publicação em que o usuário joga.
                          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: O identificador de usuário exclusivo na plataforma.
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: Resposta bem-sucedida.
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: Código de erro.
                      example: 4001
                      type: integer
                    errorMessage:
                      description: Mensagem de erro.
                      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: Item para projeto não encontrado.
      security:
        - basicAuth: []
      summary: Definir itens para usuários
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/user/inventory/item/consume:
    post:
      description: >-
        Ponto de extremidade do cliente. Consome um item do inventário do
        usuário atual.
      operationId: consume-item
      parameters:
        - description: ID do projeto.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: Plataforma de publicação em que o usuário joga.
          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: Quantidade do item.
                  example: 1
                  type: number
                sku:
                  default: booster_mega_1
                  description: >-
                    ID de item exclusivo. O SKU só pode conter caracteres
                    alfanuméricos latinos minúsculos e maiúsculos, pontos,
                    traços e sublinhados.
                  example: booster_mega_1
                  type: string
              required:
                - sku
                - quantity
              type: object
      responses:
        '200':
          description: Item do inventário do usuário consumido.
        '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: >-
            O item não foi encontrado. O item não foi encontrado no inventário,
            ou não é suficiente (tentativa de consumir mais do que o número
            inicial).
        '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: Certifique-se os parâmetros `quantity` e `sku` sejam passados.
      security:
        - XsollaLoginUserJWT: []
      summary: Consumir item
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/inventory/items:
    get:
      description: >-
        Ponto de extremidade do cliente. Recupera o inventário do usuário atual.


        <div class="notice"><strong>Atenção</strong><br><br>Todos os projetos
        têm a limitação do número de itens que você pode obter na resposta. O
        valor padrão e máximo é de <strong>50 itens por resposta.</strong> Para
        obter mais dados página por página, use os campos <b>limit</b> e
        <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: Plataforma de publicação em que o usuário joga.
          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: Descrição do item.
                          example: Big Rocket - short description
                          type: string
                        groups:
                          description: Grupo aos quais o item pertence.
                          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 da imagem.
                          example: https://picture.bigrocket.png
                          type: string
                        instance_id:
                          deprecated: true
                          description: Parâmetro descontinuado. Sempre `null`.
                          type: 'null'
                        name:
                          description: Nome do item.
                          example: Rocket
                          type: string
                        quantity:
                          description: Quantidade do item.
                          example: null
                          nullable: true
                          type: integer
                        remaining_uses:
                          description: >-
                            Define as propriedades consumíveis: número de usos
                            restantes se este for um item consumível ou `null`
                            se este for um item não consumível.
                          example: 1
                          nullable: true
                          type: integer
                        sku:
                          description: >-
                            ID de item exclusivo. O SKU só pode conter
                            caracteres alfanuméricos latinos minúsculos e
                            maiúsculos, pontos, traços e sublinhados.
                          example: com.xsolla.instanciated_item_1
                          type: string
                        type:
                          description: >-
                            Tipo de item:
                            `consumable`/`expiration`/`permanent`/`lootboxes`/`physical`.
                          example: virtual_good
                          type: string
                        virtual_item_type:
                          description: Tipo de item virtual.
                          enum:
                            - consumable
                            - non_consumable
                            - non_renewing_subscription
                          example: non_consumable
                          nullable: true
                          type: string
                      type: object
                    type: array
                type: object
          description: O inventário do usuário foi recuperado com sucesso.
      security:
        - XsollaLoginUserJWT: []
      summary: Obter o inventário do usuário atual
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/time_limited_items:
    get:
      description: >-
        Ponto de extremidade do cliente. Recupera os itens de tempo limitado do
        usuário atual.
      operationId: get-user-subscriptions
      parameters:
        - description: ID do projeto.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: Plataforma de publicação em que o usuário joga.
          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: Descrição do item.
                          example: >-
                            Premium. Premium Status provides a character with
                            several benefits allowing faster overall
                            progression.
                          type: string
                        expired_at:
                          description: >-
                            Carimbo de data/hora Unix. Data de validade do item
                            de tempo limitado. Se o usuário não tiver item, o
                            valor será `null`.
                          example: 1746057600
                          type: integer
                        image_url:
                          description: URL da imagem.
                          example: https://picture.bigrocket.png
                          type: string
                        name:
                          description: Nome da assinatura.
                          example: Premium status
                          type: string
                        sku:
                          description: >-
                            ID de item exclusivo. O SKU só pode conter
                            caracteres alfanuméricos latinos minúsculos e
                            maiúsculos, pontos, traços e sublinhados.
                          example: com.xsolla.premium_item_1
                          type: string
                        status:
                          description: |-
                            Status do item de tempo limitado.
                            O item pode estar em três status:
                            - `none` - não comprado.
                            - `active` - o item está ativo.
                            - `expired` - o item foi comprado, mas expirou.
                          example: active
                          type: string
                        type:
                          description: 'Tipo de item: `virtual_good`.'
                          example: virtual_good
                          type: string
                        virtual_item_type:
                          description: Tipo de item virtual.
                          enum:
                            - consumable
                            - non_consumable
                            - non_renewing_subscription
                          example: non_consumable
                          type: string
                          x-enumDescriptions:
                            consumable: >-
                              Um item que desaparece do inventário após o uso
                              (por exemplo, munição).
                            non_consumable: >-
                              Um item que permanece no inventário por um período
                              ilimitado de tempo.
                            non_renewing_subscription: >-
                              Item de tempo limitado que pode representar acesso
                              a serviços ou conteúdos por um período limitado.
                      type: object
                    type: array
                type: object
          description: Os itens de tempo limitado do usuário foram recuperados com sucesso.
      security:
        - XsollaLoginUserJWT: []
      summary: Obter itens de tempo limitado do usuário atual
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/virtual_currency_balance:
    get:
      description: >-
        Ponto de extremidade do cliente. Recupera o saldo virtual do usuário
        atual.
      operationId: get-user-virtual-balance
      parameters:
        - description: ID do projeto.
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: Plataforma de publicação em que o usuário joga.
          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: Quantidade do item.
                          example: null
                          type: integer
                        description:
                          description: Descrição do item.
                          example: Big Rocket - short description
                          type: string
                        image_url:
                          description: URL da imagem.
                          example: https://picture.bigrocket.png
                          type: string
                        name:
                          description: Nome do item.
                          example: Rocket
                          type: string
                        sku:
                          description: >-
                            ID de item exclusivo. O SKU só pode conter
                            caracteres alfanuméricos latinos minúsculos e
                            maiúsculos, pontos, traços e sublinhados.
                          example: com.xsolla.instanciated_item_1
                          type: string
                        type:
                          description: >-
                            Tipo de item:
                            `virtual_good`/`virtual_currency`/`bundle`.
                          example: virtual_currency
                          type: string
                      type: object
                    type: array
                type: object
          description: O saldo virtual do usuário foi recuperado com sucesso.
      security:
        - XsollaLoginUserJWT: []
      summary: Obter o saldo virtual do usuário atual
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
servers:
  - url: https://store.xsolla.com/api
tags:
  - name: inventory-client
    x-displayName: Cliente
  - name: inventory-management
    x-displayName: Gestão
  - name: cross-inventory
    x-displayName: Inventário multiplataforma
