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: ページでの要素数の制限。
      example: 50
      in: query
      name: limit
      required: false
      schema:
        example: 50
        minimum: 1
        type: integer
    offset-query-param:
      description: リストが生成される要素番号（カウントは0から始まります）。
      example: 0
      in: query
      name: offset
      required: false
      schema:
        example: 0
        minimum: 0
        type: integer
    project_id-path-param:
      description: >-
        プロジェクトID。このパラメータは、[ドメインページ](https://publisher.xsolla.com/)のプロジェクト名の横にあります。
      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: 基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。
  schemas:
    Player-Inventory_client-attributes:
      default: []
      description: アイテムに対応する属性と値のリスト。カタログのフィルタリングに使用できます。
      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: 属性名。
            example: Genre
            type: string
          values:
            items:
              properties:
                external_id:
                  $ref: '#/components/schemas/value-external_id'
                value:
                  description: 属性値。
                  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: プロジェクト特有のパラメータ。
      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。`external_id`には、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。
      example: attribute_1
      maxLength: 255
      minLength: 1
      pattern: ^[a-zA-Z0-9-_]+$
      type: string
    value-external_id:
      description: 属性の一意の値ID。`external_id`には、英小文字、ダッシュ、およびアンダースコアのみが含まれます。
      example: attribute_value
      maxLength: 255
      minLength: 1
      pattern: ^[-_.\d\w]+$
      type: string
  securitySchemes:
    XsollaLoginUserJWT:
      bearerFormat: JWT
      description: >-
        デフォルトでは、エクソラログインユーザートークン（Bearerトークン）が認証に使用されます。テスト用のエクソラログインユーザートークンでこのエンドポイントを呼

        び出すことができます：`Bearer
        eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。


        [決済ステーションアクセストークン](https://developers.xsolla.com/ja/api/pay-station/operation/create-token/)を代用として使用することができます。
      scheme: bearer
      type: http
    basicAuth:
      description: >
        エクソラAPIはベーシックアクセス認証を使用します。APIへのすべてのリクエストは`Authorization: Basic 

        <your_authorization_basic_key>`ヘッダーを含む必要があり、`your_authorization_basic_key`はBase6

        4標準に従ってエンコードされた`project_id:api_key`ペアです。


        必要に応じて、`project_id`の代わりに`merchant_id`を使用することができます。機能には影響しません。


        [パブリッシャーアカウント](https://publisher.xsolla.com/)に移動して、パラメータの値を確認します：


        * `merchant_id`が表示されます：
          * **会社設定 > 会社**セクションで
          * 任意のパブリッシャー・アカウント・ページのブラウザ・アドレス・バーにあるURL。URLは以下の形式です：`https://publisher.xsolla.co
            m/<merchant_id>`。
        *
        `api_key`は、作成時に一度だけアドミンページに表示され、お客様側で保存する必要があります。新しいキーは、次のセクションで作成することができます：
          * **会社設定＞APIキー**
          * **プロジェクト設定 > APIキー**
        * `project_id`が表示されます：
          * プロジェクト名の横にあるパブリッシャーアカウントで。
          * パブリッシャー・アカウントでプロジェクトを作業する際に、ブラウザのアドレス・バーに表示されるURL。URLは以下の形式です：`https://publisher
            .xsolla.com/<merchant_id>/projects/<project_id>`。

        API
        キーの操作に関する詳細は、[APIリファレンス](https://developers.xsolla.com/ja/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: Shop Builder API
  version: 2.0.0
openapi: 3.0.0
paths:
  /v2/project/{project_id}/inventory/account/link:
    post:
      description: ユーザーのゲームアカウントとエクソラアカウントを接続します。
      operationId: inventory-account-link
      parameters:
        - description: プロジェクトID。
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              properties:
                linking_code:
                  description: リンキングコードです。ユーザーがエクソラアカウントへの接続を承認するために使用されます。
                  example: 53LRH2
                  type: string
                platform:
                  description: ユーザーがプレイするパブリッシングプラットフォーム。
                  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。
                  example: platform_user_id
                  type: string
              required:
                - linking_code
                - platform
                - user_id
              type: object
        required: true
      responses:
        '204':
          description: ユーザーのゲームアカウントとエクソラアカウントは正常に接続されました。
        '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: プロパティ`linking_code`は必須です。リクエストの中で渡したことを確認してください。
      security:
        - basicAuth: []
      summary: ゲームアカウントとエクソラを接続
      tags:
        - cross-inventory
      x-badges:
        - color: '#95ff80'
          name: Server-side
  /v2/project/{project_id}/inventory/account/signin:
    post:
      description: パブリッシングプラットフォームのユーザーに対して、Shop Builder APIと連携するためのJWTを取得します。
      operationId: inventory-account-signin
      parameters:
        - description: プロジェクトID。
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              properties:
                platform:
                  description: ユーザーがプレイするパブリッシングプラットフォーム。
                  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。
                  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: ユーザーのゲームアカウントは正常にトークン化されました。
        '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: '`user_id`プロパティは必須です。リクエストで渡されたことを確認してください。'
      security:
        - basicAuth: []
      summary: ユーザートークン化
      tags:
        - cross-inventory
      x-badges:
        - color: '#95ff80'
          name: Server-side
  /v2/project/{project_id}/inventory/purchase:
    post:
      description: >-
        指定されたユーザーインベントリに、指定された購入アイテムを追加します。


        <div
        class="notice"><strong>注意</strong><br><br>一度に処理できる<strong>操作は最大50個</strong>です。この制限を超える操作は無視されます。</div>
      operationId: grant-item-by-purchase
      parameters:
        - description: プロジェクトID。
          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: 操作説明。例：「毎月のチャレンジリワード」。
                    maxLength: 255
                    minLength: 1
                    type: string
                  custom_parameters:
                    $ref: '#/components/schemas/Player-Inventory_custom_parameters'
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: このクラスのアイテムが付与されるために必要な数。
                          type: number
                        sku:
                          default: booster_mega_1
                          description: アイテムクラス識別子。SKUには、英小文字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: ユーザーがプレイするパブリッシングプラットフォーム。
                    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: 控除前の購入金額。
                        type: string
                      currency:
                        default: USD
                        description: >-
                          [ISO
                          4217](https://en.wikipedia.org/wiki/ISO_4217)に基づく通貨を購入します。
                        type: string
                      external_purchase_date:
                        default: '2020-01-01T05:00:00+05:00'
                        description: ISO 8601に基づく購入日。
                        type: string
                      external_purchase_id:
                        default: 10-534-35
                        description: 購入したプラットフォームからの購入インボイス識別子。
                        type: string
                    required:
                      - amount
                      - currency
                      - external_purchase_id
                      - external_purchase_date
                    type: object
                  user:
                    properties:
                      id:
                        default: d342dad2-9d59-11e9-a384-42010aa8003f
                        description: プラットフォーム上でユニークなユーザー識別子。
                        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: 控除前の購入金額。
                          example: '2.99'
                          type: string
                        comment:
                          description: 操作説明。例：「毎月のチャレンジリワード」。
                          example: Montly challange rewards
                          type: string
                        currency:
                          description: >-
                            [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: ISO 8601に基づく購入日。
                          example: '2020-01-01T05:00:00+05:00'
                          type: string
                        external_purchase_id:
                          description: 購入したプラットフォームからの購入インボイス識別子。
                          example: 10-534-35
                          type: string
                        items:
                          items:
                            properties:
                              quantity:
                                description: このクラスのアイテムが付与されるために必要な数。
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  アイテムクラス識別子。SKUには、英小文字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                                example: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        order_id:
                          description: エクソラ側での操作説明。
                          example: 123456
                          type: number
                        platform:
                          description: ユーザーがプレイするパブリッシングプラットフォーム。
                          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: プラットフォーム上でユニークなユーザー識別子。
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: ユーザーの購入に成功しました。
        '422':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: エラーコード。
                      example: 1102
                      type: integer
                    errorMessage:
                      description: エラーメッセージ。
                      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: 処理不可能なエンティティー。
      security:
        - basicAuth: []
      summary: 購入したアイテムをユーザーに付与する
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/revoke:
    post:
      description: >-
        複数のユーザーのアイテムのアクセス権を剥奪します。


        <div
        class="notice"><strong>注意</strong><br><br>一度に処理できる<strong>操作は最大50個</strong>です。この制限を超える操作は無視されます。</div>
      operationId: revoke-item
      parameters:
        - description: プロジェクトID。
          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: 操作説明。例：「アイテムが他のプレイヤーに譲渡されました」。
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: 取り消す必要があるこのクラスのアイテムの数。
                          minimum: 1
                          type: integer
                        sku:
                          default: booster_mega_1
                          description: >-
                            一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                          minLength: 1
                          type: string
                      required:
                        - sku
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: ユーザーがプレイするパブリッシングプラットフォーム。
                    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: プラットフォーム上でユニークなユーザー識別子。
                        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: アイテムの取り消しに成功したユーザー数。
                    example: 10
                    type: integer
                  operations:
                    description: 操作の説明。
                    items:
                      properties:
                        comment:
                          description: 操作説明。例：「アイテムが他のプレイヤーに譲渡されました」。
                          example: Some comment for this operation
                          type: string
                        items:
                          description: 本操作におけるアイテム。
                          items:
                            properties:
                              balance:
                                description: ユーザーが所有しているこのクラスのアイテムの合計数。
                                example: 1
                                type: integer
                              quantity:
                                description: このクラスの取り消されたアイテムの数。
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  アイテムクラス識別子。SKUには、英小文字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                                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: プラットフォーム上でユニークなユーザー識別子。
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: ユーザーアイテムの取り消しに成功しました。
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: エラーコード。
                      example: 4001
                      type: integer
                    errorMessage:
                      description: エラーメッセージ。
                      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: この数のアイテムの削除に失敗しました。
      security:
        - basicAuth: []
      summary: インベントリアイテムを取り消す
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/reward:
    post:
      description: >-
        指定されたユーザーインベントリに、指定されたアイテムを追加します。


        <div
        class="notice"><strong>注意</strong><br><br>一度に処理できる<strong>操作は最大50個</strong>です。この制限を超える操作は無視されます。</div>
      operationId: add-item-to-inventory
      parameters:
        - description: プロジェクトID。
          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: 操作説明。例：「毎月のチャレンジリワード」。
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: このクラスのアイテムが付与されるために必要な数。
                          type: number
                        sku:
                          default: booster_mega_1
                          description: アイテムクラス識別子。SKUには、英小文字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: ユーザーがプレイするパブリッシングプラットフォーム。
                    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: プラットフォーム上でユニークなユーザー識別子。
                        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: 操作説明。例：「毎月のチャレンジリワード」。
                          example: Montly challange rewards
                          type: string
                        items:
                          items:
                            properties:
                              balance:
                                description: ユーザーが所有しているこのクラスのアイテムの合計数。
                                example: 5
                                type: integer
                              quantity:
                                description: このクラスのアイテムが付与されるために必要な数。
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  アイテムクラス識別子。SKUには、英小文字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                                example: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        platform:
                          description: ユーザーがプレイするパブリッシングプラットフォーム。
                          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: プラットフォーム上でユニークなユーザー識別子。
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: 成功したユーザーリワード。
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: エラーコード。
                      example: 4001
                      type: integer
                    errorMessage:
                      description: エラーメッセージ。
                      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: プロジェクトのアイテムが見つかりません。
      security:
        - basicAuth: []
      summary: アイテムをユーザーに付与する
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/inventory/set:
    post:
      description: >-
        指定されたユーザーインベントリに指定された項目を設定します。ただし、新しいデータは古いデータに置き換わります。


        <div
        class="notice"><strong>注意</strong><br><br>一度に処理できる<strong>操作は最大50個</strong>です。この制限を超える操作は無視されます。</div>
      operationId: set-item-quantity
      parameters:
        - description: プロジェクトID。
          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: 操作説明。例：「毎月のインベントリ同期」。
                    maxLength: 255
                    minLength: 1
                    type: string
                  items:
                    items:
                      properties:
                        quantity:
                          default: 1
                          description: このクラスのアイテムが付与されるために必要な数。
                          type: number
                        sku:
                          default: booster_mega_1
                          description: アイテムクラス識別子。SKUには、英小文字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                          type: string
                      required:
                        - sku
                        - platform
                        - quantity
                      type: object
                    minItems: 1
                    type: array
                  platform:
                    default: xsolla
                    description: ユーザーがプレイするパブリッシングプラットフォーム。
                    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: プラットフォーム上でユニークなユーザー識別子。
                        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: 操作説明。例：「毎日のインベントリ同期」。
                          example: Daily inventory syncing
                          type: string
                        items:
                          items:
                            properties:
                              balance:
                                description: ユーザーが所有しているこのクラスのアイテムの合計数。
                                example: 5
                                type: integer
                              quantity:
                                description: このクラスのアイテムが付与されるために必要な数。
                                example: 1
                                type: integer
                              sku:
                                description: >-
                                  アイテムクラス識別子。SKUには、英小文字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                                example: com.xsolla.item_1
                                type: string
                            type: object
                          type: array
                        platform:
                          description: ユーザーがプレイするパブリッシングプラットフォーム。
                          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: プラットフォーム上でユニークなユーザー識別子。
                          example: d.user
                          type: string
                      type: object
                    type: array
                type: object
          description: 成功した応答。
        '404':
          content:
            application/json:
              schema:
                items:
                  properties:
                    errorCode:
                      description: エラーコード。
                      example: 4001
                      type: integer
                    errorMessage:
                      description: エラーメッセージ。
                      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: プロジェクトのアイテムが見つかりません。
      security:
        - basicAuth: []
      summary: ユーザーにアイテムを設定する
      tags:
        - inventory-management
      x-badges:
        - color: '#95ff80'
          name: Server-side
        - color: '#d7dee0'
          name: Admin
  /v2/project/{project_id}/user/inventory/item/consume:
    post:
      description: クライアントエンドポイント。現在のユーザーインベントリからアイテムを消費します。
      operationId: consume-item
      parameters:
        - description: プロジェクトID。
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: ユーザーがプレイするパブリッシングプラットフォーム。
          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: アイテム数量。
                  example: 1
                  type: number
                sku:
                  default: booster_mega_1
                  description: 一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                  example: booster_mega_1
                  type: string
              required:
                - sku
                - quantity
              type: object
      responses:
        '200':
          description: ユーザーインベントリからアイテムが消費されました。
        '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: >-
            アイテムがまったく見つからなかったか、アイテムがインベントリに見つからなかったか、または十分ではありません（最初の数より多くを消費しようとする）。
        '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: '`quantity`と`sku`パラメータが渡されることを確認してください。'
      security:
        - XsollaLoginUserJWT: []
      summary: アイテムを消費する
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/inventory/items:
    get:
      description: >-
        クライアントエンドポイント。現在のユーザーインベントリを取得します。


        <div
        class="notice"><strong>注意</strong><br><br>すべてのプロジェクトには、回答で得られるアイテムの数に制限があります。初期値および最大値は、<strong>1応答あたり50アイテム</strong>です。ページごとにより多くのデータを取得するには、<b>LIMIT</b>と<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: ユーザーがプレイするパブリッシングプラットフォーム。
          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: アイテム説明。
                          example: Big Rocket - short description
                          type: string
                        groups:
                          description: アイテムが所属するグループ。
                          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。
                          example: https://picture.bigrocket.png
                          type: string
                        instance_id:
                          deprecated: true
                          description: 非推奨のパラメータです。常には`null`です。
                          type: 'null'
                        name:
                          description: アイテム名。
                          example: Rocket
                          type: string
                        quantity:
                          description: アイテム数量。
                          example: null
                          nullable: true
                          type: integer
                        remaining_uses:
                          description: 消耗品のプロパティを定義します：消耗品の場合は残りの使用回数、非消耗品の場合は`null`。
                          example: 1
                          nullable: true
                          type: integer
                        sku:
                          description: >-
                            一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                          example: com.xsolla.instanciated_item_1
                          type: string
                        type:
                          description: >-
                            アイテムタイプ：`consumable`/`expiration`/`permanent`/`lootboxes`/`physical`。
                          example: virtual_good
                          type: string
                        virtual_item_type:
                          description: 仮想アイテムタイプ。
                          enum:
                            - consumable
                            - non_consumable
                            - non_renewing_subscription
                          example: non_consumable
                          nullable: true
                          type: string
                      type: object
                    type: array
                type: object
          description: ユーザーインベントリが正常に取得されました。
      security:
        - XsollaLoginUserJWT: []
      summary: 現在のユーザーインベントリーを取得する
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/time_limited_items:
    get:
      description: クライアントエンドポイント。現在のユーザーの時間制限のあるイテムを取得します。
      operationId: get-user-subscriptions
      parameters:
        - description: プロジェクトID。
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: ユーザーがプレイするパブリッシングプラットフォーム。
          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: アイテム説明。
                          example: >-
                            Premium. Premium Status provides a character with
                            several benefits allowing faster overall
                            progression.
                          type: string
                        expired_at:
                          description: >-
                            Unixタイムスタンプ。時間制限のあるアイテムの有効期限。ユーザーがアイテムを所持していない場合、値は
                            `null` になります。
                          example: 1746057600
                          type: integer
                        image_url:
                          description: 画像URL。
                          example: https://picture.bigrocket.png
                          type: string
                        name:
                          description: サブスクリプション名。
                          example: Premium status
                          type: string
                        sku:
                          description: >-
                            一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                          example: com.xsolla.premium_item_1
                          type: string
                        status:
                          description: |-
                            時間制限のあるアイテムの状態。
                            アイテムは以下の状態になる可能性があります：
                            - `none` - 購入していません。
                            - `active` - アイテムがアクティブです。
                            - `expired` - アイテムを購入しましたが、有効期限が切れています。
                          example: active
                          type: string
                        type:
                          description: アイテムタイプ：`virtual_good`。
                          example: virtual_good
                          type: string
                        virtual_item_type:
                          description: 仮想アイテムタイプ。
                          enum:
                            - consumable
                            - non_consumable
                            - non_renewing_subscription
                          example: non_consumable
                          type: string
                          x-enumDescriptions:
                            consumable: 使用後にインベントリから消えるアイテム（例：弾丸）。
                            non_consumable: 無期限でインベントリに保管できるアイテム。
                            non_renewing_subscription: 期間限定のサービスやコンテンツへのアクセスを表すことができる時間制限のあるアイテム。
                      type: object
                    type: array
                type: object
          description: ユーザーの期間限定アイテムが正常に取得されました。
      security:
        - XsollaLoginUserJWT: []
      summary: 現在のユーザーの時間制限のあるアイテムを取得する
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
  /v2/project/{project_id}/user/virtual_currency_balance:
    get:
      description: クライアントエンドポイント。現在のユーザーの仮想残高を取得します。
      operationId: get-user-virtual-balance
      parameters:
        - description: プロジェクトID。
          in: path
          name: project_id
          required: true
          schema:
            default: 44056
            type: integer
        - description: ユーザーがプレイするパブリッシングプラットフォーム。
          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: アイテム数量。
                          example: null
                          type: integer
                        description:
                          description: アイテム説明。
                          example: Big Rocket - short description
                          type: string
                        image_url:
                          description: 画像URL。
                          example: https://picture.bigrocket.png
                          type: string
                        name:
                          description: アイテム名。
                          example: Rocket
                          type: string
                        sku:
                          description: >-
                            一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
                          example: com.xsolla.instanciated_item_1
                          type: string
                        type:
                          description: アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`。
                          example: virtual_currency
                          type: string
                      type: object
                    type: array
                type: object
          description: ユーザーの仮想残高は正常に取得されました。
      security:
        - XsollaLoginUserJWT: []
      summary: 現在のユーザーの仮想残高を取得
      tags:
        - inventory-client
      x-badges:
        - color: '#80eaff'
          name: Client-side
servers:
  - url: https://store.xsolla.com/api
tags:
  - name: inventory-client
    x-displayName: クライアント
  - name: inventory-management
    x-displayName: 管理
  - name: cross-inventory
    x-displayName: クロスインベントリ
