{ "components": { "examples": { "200-admin-get-group": { "value": { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_enabled": true, "items_count": 5, "name": { "en": "Weapons" }, "order": 1 } }, "200-admin-get-group-by-item-type": { "value": { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 3, "name": { "en": "Weapons" }, "order": 1 } }, "200-admin-get-group-list": { "value": { "groups": [ { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_enabled": true, "items_count": 5, "name": { "en": "Weapons" }, "order": 1 }, { "description": { "en": "Melee weapons" }, "external_id": "swords", "id": 2, "image_url": "https://example.com/swords.png", "is_enabled": true, "items_count": 3, "name": { "en": "Swords" }, "order": 2 }, { "description": { "en": "Player armor" }, "external_id": "armor", "id": 3, "image_url": "https://example.com/armor.png", "is_enabled": true, "items_count": 4, "name": { "en": "Armor" }, "order": 3 } ] } }, "200-admin-get-group-list-by-item-type": { "value": { "groups": [ { "description": { "en": "Player weapons" }, "external_id": "weapons", "id": 1, "image_url": "https://example.com/weapons.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 3, "name": { "en": "Weapons" }, "order": 1 }, { "description": { "en": "Melee weapons" }, "external_id": "swords", "id": 2, "image_url": "https://example.com/swords.png", "is_contains_any_items": true, "is_enabled": true, "items_count": 2, "name": { "en": "Swords" }, "order": 2 }, { "description": { "en": "Player armor" }, "external_id": "armor", "id": 3, "image_url": "https://example.com/armor.png", "is_contains_any_items": false, "is_enabled": true, "items_count": 0, "name": { "en": "Armor" }, "order": 3 } ] } }, "201-admin-create-group": { "value": { "external_id": "weapons" } }, "404-attribute-not-found": { "value": { "errorCode": 9901, "errorMessage": "[0401-9901]: Attribute not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-attribute-value-not-found": { "value": { "errorCode": 9906, "errorMessage": "[0401-9906]: Attribute value not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-coupon-not-found": { "value": { "errorCode": 9802, "errorMessage": "[0401-9802]: Coupon not found", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "404-game-code-not-found": { "value": { "errorCode": 4603, "errorMessage": "[0401-4603]: Game code not found.", "statusCode": 404, "transactionId": "transaction id" } }, "404-item-by-sku-not-found": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'item_sku' not found", "statusCode": 404, "transactionId": "transaction id" } }, "404-user-not-found": { "value": { "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User", "statusCode": 404, "transactionId": "transaction id" } }, "422-custom-attributes-size-exceeded": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "JSON can’t exceed 500 characters.", "property": "custom_attributes" } ], "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-drm-is-not-drm-free": { "value": { "errorCode": 5103, "errorMessage": "[0401-5103]: Selected drm is not drmfree.", "statusCode": 422, "transactionId": "transaction id" } }, "422-external-id-duplicate": { "value": { "errorCode": 9907, "errorMessage": "[0401-9907]: The attribute value already exists.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-external-id-invalid": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. Does not match the regex pattern ^[a-zA-Z0-9-_]+$", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-external-id-required": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-item-out-of-range-available-user-limit": { "value": { "errorCode": 4510, "errorMessage": "[0401-4510]: Available item limit is out of range.", "statusCode": 422, "transactionId": "transaction id" } }, "422-item-without-user-limit": { "value": { "errorCode": 4508, "errorMessage": "[0401-4508]: Item does not have configured user limits.", "statusCode": 422, "transactionId": "transaction id" } }, "422-numbers-of-attribute-values-per-item-exceeded": { "value": { "errorCode": 9909, "errorMessage": "[0401-9909]: The number of attribute values you specified for the item exceeds the required limit. Try to specify fewer attribute values.", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-numbers-of-attributes-per-item-exceeded": { "value": { "errorCode": 9908, "errorMessage": "[0401-9908]: The number of attributes you specified for the item exceeds the required limit. Try to specify fewer attributes.", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-property-external-id-required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "The property external_id is required", "property": "external_id" } ], "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-property-sku-is-required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `sku` is required", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "422-user-already-has-entitlement": { "value": { "errorCode": 5101, "errorMessage": "[0401-5101]: User already has entitlement.", "statusCode": 422, "transactionId": "transaction id" } }, "422-user_external_id_invalid": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Must be at least 1 characters long", "property": "user_external_id" }, { "message": "Does not match the regex pattern ^\\S+$", "property": "user_external_id" } ], "statusCode": 404, "transactionId": "transaction id" } }, "422-value-invalid": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `value` is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-value-limit-exceeded": { "value": { "errorCode": 9908, "errorMessage": "[0401-9908]: You reached the maximum number of values for the attribute.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "422-value-properties-required": { "value": { "errorCode": 9901, "errorMessage": "[0401-1102]: Unprocessable Entity. Array value found, but an object is required", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Bundles_200-get-bundle": { "value": { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_prices": [] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "pricePoint_44056_1.", "groups": [], "image_url": null, "is_free": false, "item_id": 610316, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "long_description": null, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.kg_1", "total_content_price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "type": "bundle", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } }, "Bundles_200-get-bundle-list": { "value": { "has_more": true, "items": [ { "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Casual" }, { "external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7", "value": "Strategy" }, { "external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8", "value": "Mobile" } ] } ], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [ { "external_id": "size", "name": "Size", "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "Large" } ] } ], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_item_type": "non_consumable", "virtual_prices": [] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "pricePoint_44056_1", "groups": [ { "external_id": "exclusive", "item_order_in_group": 1, "name": "Exclusive" } ], "image_url": null, "is_free": false, "item_id": 61031, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "long_description": null, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.kg_1", "total_content_price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "type": "bundle", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ] } } }, "parameters": { "additional_fields-entitlement-query-param": { "description": "追加フィールドのリスト。これらのフィールドは、リクエストの中で送信すると、応答に含まれます。利用可能なフィールドは`attributes`。", "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "type": "string" }, "type": "array" } }, "additional_fields-query-param": { "description": "追加フィールドのリスト。これらのフィールドは、リクエストの中で送信すると、応答に含まれます。", "in": "query", "name": "additional_fields[]", "required": false, "schema": { "items": { "enum": [ "media_list", "order", "long_description", "custom_attributes", "item_order_in_group" ], "type": "string" }, "type": "array" } }, "cart_id-path-param": { "description": "カートID。", "in": "path", "name": "cart_id", "required": true, "schema": { "example": "custom_id", "type": "string" } }, "country-query-param": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従った2文字の大文字の国名コード。[エクソーラがサポートする国](https://developers.xsolla.com/ja/doc/shop-builder/references/supported-countries/)と[国を決定するプロセス](https://developers.xsolla.com/ja/doc/shop-builder/features/pricing-policy/#pricing_policy_country_determination)に関する詳細情報については、ドキュメントを確認してください。", "in": "query", "name": "country", "required": false, "schema": { "example": "US", "type": "string" } }, "currency-query-param": { "description": "カートに表示される商品価格の通貨。[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "in": "query", "name": "currency", "required": false, "schema": { "default": "USD", "type": "string" } }, "external_id-attr-path-param": { "description": "属性external ID。", "in": "path", "name": "external_id", "required": true, "schema": { "example": "attribute_id", "type": "string" } }, "external_id-group-path-param": { "description": "External item group ID specified during creation.", "in": "path", "name": "external_id", "required": true, "schema": { "example": "weapons", "type": "string" } }, "external_id_59080-group-path-param": { "description": "グループexternal ID。", "in": "path", "name": "external_id", "required": true, "schema": { "default": "armour", "type": "string" } }, "group_id-path-param": { "description": "グループID。", "in": "path", "name": "group_id", "required": true, "schema": { "example": 10, "type": "integer" } }, "id-group-path-param": { "description": "Item group ID assigned by Xsolla.", "in": "path", "name": "id", "required": true, "schema": { "example": 1, "type": "integer" } }, "item_id-path-param": { "description": "アイテムID。", "in": "path", "name": "item_id", "required": true, "schema": { "example": "656", "type": "string" } }, "item_id_59080-path-param": { "description": "アイテムID。", "in": "path", "name": "item_id", "required": true, "schema": { "example": "259774", "type": "string" } }, "item_sku-path-param": { "description": "アイテムSKU。", "in": "path", "name": "item_sku", "required": true, "schema": { "example": "booster_mega_1", "type": "string" } }, "item_sku_59080-path-param": { "description": "アイテムSKU。", "in": "path", "name": "sku", "required": true, "schema": { "example": "electric_shield", "type": "string" } }, "item_type-group-path-param": { "description": "Item type used to filter groups. Determines which items are included in `items_count`. Values containing `/` (for example, `virtual_currency/package` or `game/key`) must be URL-encoded (for example, `virtual_currency%2Fpackage`).", "in": "path", "name": "item_type", "required": true, "schema": { "enum": [ "virtual_items", "virtual_currency", "virtual_currency/package", "game/key", "bundle", "game", "value_points", "subscription_plans" ], "example": "virtual_items", "type": "string" } }, "limit-query-param": { "description": "ページでの要素数の制限。", "example": 50, "in": "query", "name": "limit", "required": false, "schema": { "example": 50, "minimum": 1, "type": "integer" } }, "locale-query-param": { "description": "Response language. Two-letter lowercase language code per ISO 639-1 (for example, `en`). Five-character locale codes (for example, `en-US`) are supported in localization fields such as `name` and `description`, but are normalized to two-letter codes in responses. You can find the full list of supported languages in the [documentation](https://developers.xsolla.com/ja/doc/shop-builder/references/supported-languages/).", "in": "query", "name": "locale", "required": false, "schema": { "default": "en", "type": "string" } }, "merchant_id-path-param": { "description": "マーチャントID。", "in": "path", "name": "merchant_id", "required": true, "schema": { "example": 121212, "type": "integer" } }, "offset-query-param": { "description": "リストが生成される要素番号（カウントは0から始まります）。", "example": 0, "in": "query", "name": "offset", "required": false, "schema": { "example": 0, "minimum": 0, "type": "integer" } }, "order_id-path-param": { "description": "注文ID。", "in": "path", "name": "order_id", "required": true, "schema": { "example": "656", "type": "string" } }, "platform-query-param": { "description": "ユーザーがプレイするパブリッシングプラットフォーム：`xsolla`（デフォルト）、`playstation_network`、`xbox_live`、`pc_standalone`、`nintendo_shop`、`google_play`、`app_store_ios`、`android_standalone`、`ios_standalone`、`android_other`、`ios_other`、`pc_other`。", "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" } }, "project_id-path-param": { "description": "Project ID. You can find this parameter in your [Publisher Account](https://publisher.xsolla.com/0/projects/0/) next to the project name and in the browser address bar when working with a project. The URL has the following format: `https://publisher.xsolla.com//projects/`.", "in": "path", "name": "project_id", "required": true, "schema": { "example": 44056, "type": "integer" } }, "project_id_59080-path-param": { "description": "プロジェクトID。このパラメータは、[パブリッシャーアカウント](https://publisher.xsolla.com/)のプロジェクト名の横にあります。", "in": "path", "name": "project_id", "required": true, "schema": { "example": 59080, "type": "integer" } }, "promo_code-query-param": { "description": "大文字と小文字を区別する一意のコードです。文字と数字が含まれます。", "in": "query", "name": "promo_code", "required": false, "schema": { "example": "WINTER2021", "maxLength": 128, "minLength": 1, "type": "string" } }, "quantity-query-param": { "description": "コード数量。", "in": "query", "name": "quantity", "required": true, "schema": { "example": 100, "type": "integer" } }, "reason-query-param": { "description": "コード受信の理由。", "in": "query", "name": "reason", "required": true, "schema": { "example": "Very important", "type": "string" } }, "region_id-path-param": { "description": "地域ID。プロジェクト内での一意の地域識別子。", "in": "path", "name": "region_id", "required": true, "schema": { "example": 42, "type": "integer" } }, "region_id-query-param": { "description": "リージョンID。", "in": "query", "name": "region_id", "required": false, "schema": { "default": 1, "type": "integer" } }, "sandbox-query-param": { "description": "どのような種類の資格が返されるべきか。このパラメータが1に設定された場合、サンドボックスモードでユーザーによって受信された資格のみが返されます。パラメータが渡されないまたは0に設定されている場合、ライブモードでのみユーザーによって受信された資格が返されます。", "in": "query", "name": "sandbox", "required": false, "schema": { "default": 0, "type": "integer" } }, "show_inactive_time_limited_items-query-param": { "description": "ユーザーに利用可能でない、期限付きアイテムを表示します。このようなアイテムの有効期間はまだ開始されていないか、すでに期限切れです。", "in": "query", "name": "show_inactive_time_limited_items", "required": false, "schema": { "default": 0, "example": 1, "type": "integer" } }, "sku-path-param": { "description": "バンドルSKU。", "in": "path", "name": "sku", "required": true, "schema": { "example": "kg_1", "type": "string" } }, "user_email-query-param": { "description": "ユーザーのメールアドレス。", "in": "query", "name": "user_email", "required": true, "schema": { "example": "email@email.com", "type": "string" } }, "user_external_id-query-param": { "description": "ユーザーexternal ID", "in": "query", "name": "user_external_id", "required": true, "schema": { "example": "d342dad2-9d59-11e9-a384-42010aa8003f", "type": "string" } }, "value_external_id-path-param": { "description": "属性値のexternal ID。", "in": "path", "name": "value_external_id", "required": true, "schema": { "example": "value_id", "pattern": "^[-_\\.\\d\\w]+$", "type": "string" } }, "virtual_currency_package_sku-path-param": { "description": "仮想通貨パッケージ SKU。", "in": "path", "name": "virtual_currency_package_sku", "required": true, "schema": { "example": "crystal-pack", "type": "string" } }, "virtual_currency_sku-path-param": { "description": "仮想通貨SKU。", "in": "path", "name": "virtual_currency_sku", "required": true, "schema": { "example": "crystal", "type": "string" } }, "with_geo-query-param": { "description": "Whether to return the user's locale and country information in the response headers. If set to `true`, the response includes `X-User-Locale-Code` and `X-User-Country-Code` headers.", "in": "query", "name": "with_geo", "required": false, "schema": { "default": false, "type": "boolean" } }, "x-user-for-header": { "description": "ユーザー識別子は、エクソーラログインユーザーJWTまたは[ペイステーションアクセストークン](https://developers.xsolla.com/ja/pay-station-api/current/token/create-token)を使用して転送することができます。", "example": "ACCESS_TOKEN/LOGIN_JWT", "in": "header", "name": "x-user-for", "required": false, "schema": { "type": "string" } }, "x-user-id-header": { "description": "ゲーム付きカートを販売する場合、自分のユーザーIDを使用することができます。", "example": "UNIQUE_ID", "in": "header", "name": "x-user-id", "required": false, "schema": { "maxLength": 32, "type": "string" } } }, "requestBodies": { "Bundles_bundle": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "class", "name": { "en": "Class" }, "values": [ { "external_id": "soldier", "value": { "en": "Soldier" } }, { "external_id": "officer", "value": { "en": "Officer" } } ] } ], "content": [ { "quantity": 1, "sku": "com.xsolla.iron_gloves_1" }, { "quantity": 1, "sku": "com.xsolla.iron_boots_1" }, { "quantity": 1, "sku": "com.xsolla.iron_shield_1" }, { "quantity": 1, "sku": "com.xsolla.iron_armour_1" }, { "quantity": 1, "sku": "com.xsolla.iron_helmet_1" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "de": "Brustpanzer für Soldaten", "en": "Chest of armour for soldiers" }, "groups": [ "chests" ], "image_url": "https://picture.bundle-with-many-stuff.png", "is_enabled": true, "is_free": true, "is_paid_randomized_reward": true, "limits": { "per_item": null, "per_user": null }, "long_description": { "de": "Brustpanzer für Soldaten", "en": "Chest of armour for soldiers" }, "media_list": [ { "type": "image", "url": "https://test.com/image0" }, { "type": "image", "url": "https://test.com/image1" } ], "name": { "de": "Brustpanzer", "en": "Chest of armour" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "9.99", "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": "9.99", "currency": "EUR", "is_default": false, "is_enabled": true } ], "sku": "com.xsolla.armour_chest_1", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Bundles_admin_bundle_request" } } }, "description": "バンドルデータを持つオブジェクト。", "required": true }, "Cart-Payment_admin-create-payment-token": { "content": { "application/json": { "examples": { "common": { "value": { "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "settings": { "currency": "USD", "external_id": "AABBCCDD01", "language": "de", "payment_method": 1380, "return_url": "https://developers.xsolla.com/ja/", "ui": { "theme": "63295aab2e47fab76f7708e3" } }, "user": { "country": { "allow_modify": false, "value": "US" }, "email": { "value": "user@xsolla.com" }, "id": { "value": "user-id" }, "name": { "value": "user-name" } } } }, "in-sandbox": { "value": { "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "sandbox": true, "settings": { "currency": "USD" }, "user": { "id": { "value": "user-id" } } } }, "with-custom-parameters": { "value": { "custom_parameters": { "user_os": "windows10", "user_public_id": "player1" }, "purchase": { "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] }, "settings": { "currency": "USD", "external_id": "AABBCCDD01", "language": "de", "payment_method": 1380, "return_url": "https://developers.xsolla.com/ja/", "ui": { "theme": "63295aab2e47fab76f7708e3" } }, "user": { "country": { "allow_modify": false, "value": "US" }, "email": { "value": "user@xsolla.com" }, "id": { "value": "user-id" }, "name": { "value": "user-name" } } } } }, "schema": { "additionalProperties": false, "properties": { "custom_parameters": { "$ref": "#/components/schemas/Cart-Payment_custom_parameters_token" }, "promo_code": { "$ref": "#/components/schemas/Promotions_coupon_code" }, "purchase": { "$ref": "#/components/schemas/Cart_admin_payment" }, "sandbox": { "$ref": "#/components/schemas/Cart-Payment_settings_sandbox" }, "settings": { "additionalProperties": false, "description": "ユーザーの支払いプロセスと決済UIを構成するための設定。", "properties": { "currency": { "$ref": "#/components/schemas/Cart-Payment_settings_currency" }, "external_id": { "$ref": "#/components/schemas/Cart-Payment_settings_external_id" }, "language": { "$ref": "#/components/schemas/Cart-Payment_settings_locale" }, "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" }, "user": { "$ref": "#/components/schemas/Cart-Payment_admin-user-request-body" } }, "required": [ "user", "purchase" ], "type": "object" } } } }, "Cart-Payment_admin-fill-cart-json-model": { "content": { "application/json": { "examples": { "basic": { "value": { "currency": "USD", "items": [ { "quantity": 2, "sku": "com.xsolla.cup01" }, { "quantity": 1, "sku": "com.xsolla.t-shirt01" }, { "quantity": 1, "sku": "com.xsolla.cup02" }, { "quantity": 1, "sku": "com.xsolla.hat01" } ] } } }, "schema": { "$ref": "#/components/schemas/Cart" } } } }, "Cart-Payment_create-order-by-cart-idJsonModel": { "content": { "application/json": { "example": { "custom_parameters": { "character_id": "ingameUsername" }, "sandbox": true, "settings": { "ui": { "desktop": { "header": { "close_button": false, "is_visible": true, "type": "normal", "visible_logo": true, "visible_name": true, "visible_purchase": true } }, "theme": "63295a9a2e47fab76f7708e1" } } }, "schema": { "properties": { "currency": { "description": "注文価格の通貨。3文字の通貨コード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "type": "string" }, "custom_parameters": { "description": "プロジェクト特有のパラメータ。", "maxProperties": 200, "minProperties": 1, "type": "object" }, "locale": { "description": "応答言語。", "type": "string" }, "sandbox": { "default": false, "description": "サンドボックスモードで注文を作成します。このオプションは、会社のユーザーリストに指定されているユーザーに使用できます。", "type": "boolean" }, "settings": { "additionalProperties": false, "description": "ユーザーの支払いプロセスと決済UIを構成するための設定。", "properties": { "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" } }, "type": "object" } } } }, "Cart-Payment_create-order-with-specified-item-idJsonModel": { "content": { "application/json": { "example": { "custom_parameters": { "character_id": "ingameUsername" }, "promo_code": "discount_code", "quantity": 5, "sandbox": true, "settings": { "ui": { "desktop": { "header": { "close_button": false, "is_visible": true, "type": "normal", "visible_logo": true, "visible_name": true, "visible_purchase": true } }, "theme": "63295a9a2e47fab76f7708e1" } } }, "schema": { "properties": { "currency": { "description": "注文価格の通貨。3文字の通貨コード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "type": "string" }, "custom_parameters": { "description": "プロジェクト特有のパラメータ。", "maxProperties": 200, "minProperties": 1, "type": "object" }, "locale": { "description": "応答言語。", "type": "string" }, "promo_code": { "description": "支払いによりプロモーションコードキャンペーンのコードを引き換えます。", "type": "string" }, "quantity": { "default": 1, "description": "アイテム数量。", "minimum": 1, "type": "integer" }, "sandbox": { "default": false, "description": "サンドボックスモードで注文を作成します。このオプションは、会社のユーザーリストに指定されているユーザーに使用できます。", "type": "boolean" }, "settings": { "additionalProperties": false, "description": "ユーザーの支払いプロセスと決済UIを構成するための設定。", "properties": { "payment_method": { "$ref": "#/components/schemas/Cart-Payment_settings_payment_method" }, "redirect_policy": { "$ref": "#/components/schemas/Cart-Payment_redirect_policy" }, "return_url": { "$ref": "#/components/schemas/Cart-Payment_settings_return_url" }, "ui": { "$ref": "#/components/schemas/Cart-Payment_settings_ui" } }, "type": "object" } }, "type": "object" } } } }, "Cart-Payment_fill-cart-json-model": { "content": { "application/json": { "schema": { "example": { "items": [ { "quantity": 123, "sku": "com.xsolla.booster_mega_1" } ] }, "properties": { "items": { "description": "アイテムのリスト。", "items": { "minItems": 1, "properties": { "quantity": { "default": 123, "type": "number" }, "sku": { "default": "booster_mega_1", "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "type": "array" } }, "required": [ "items" ], "type": "object" } } } }, "Cart-Payment_put-item-by-cart-idJsonModel": { "content": { "application/json": { "schema": { "properties": { "quantity": { "default": 123, "description": "アイテム数量。", "type": "number" } }, "type": "object" } } } }, "Game-Keys_create-update-game-model": { "content": { "application/json": { "schema": { "example": { "description": { "en-US": "Game description", "ru-RU": "Краткое описание игры" }, "groups": [ "new_games" ], "image_url": "http://image.png", "is_enabled": true, "is_show_in_store": true, "long_description": { "en-US": "Game long description", "ru-RU": "Полное описание игры" }, "media_list": [ { "type": "image", "url": "http://image.png" }, { "type": "video", "url": "http://video.png" } ], "name": { "en-US": "Game name", "ru-RU": "Название игры" }, "sku": "com.xsolla.game_1", "unit_items": [ { "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "total": 5 } }, "name": { "en-US": "Game key name", "ru-RU": "Название игрового ключа" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": "Some description", "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 35.5, "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [ { "id": 12 }, { "id": 64 } ], "sku": "com.xsolla.game_key_1", "vc_prices": [ { "amount": 35.5, "is_default": true, "is_enabled": true, "sku": "com.xsolla.gold_1" } ] } ] }, "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-post-put-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "アイテムが所属するグループ。", "items": { "properties": { "external_id": { "example": "horror", "type": "string" } }, "required": [ "external_id" ], "type": "object" }, "type": "array" }, "image_url": { "description": "画像URL。", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "description": "無効の場合、アイテムの購入やインベントリからのアクセスはできません。", "type": "boolean" }, "is_show_in_store": { "description": "アイテムは購入可能です。", "type": "boolean" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "スクリーンショット、ゲームプレイ動画などのゲーム追加アセット。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "メディアタイプ：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "リソースファイル。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "リスト内のゲーム順の優先順位。", "example": 1, "type": "integer" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "unit_items": { "description": "異なるDRMに対応したゲームキー。", "items": { "description": "ゲームキーアイテム。特定のプラットフォーム（steam、gogなど）のゲームを表します。", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "drm_sku": { "description": "DRMユニークID。", "example": "steam", "type": "string" }, "groups": { "description": "アイテムが所属するグループ。", "items": { "properties": { "external_id": { "example": "horror", "type": "string" } }, "required": [ "external_id" ], "type": "object" }, "type": "array" }, "is_enabled": { "description": "無効の場合、アイテムの購入やインベントリからのアクセスはできません。", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "description": "アイテムは購入可能です。", "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Game-key-item-limit" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "リスト内のゲーム順の優先順位。", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "pre_order": { "description": "先行予約の設定。", "properties": { "description": { "description": "予約注文に関する追加情報は電子メールで送信されます。", "type": "string" }, "is_enabled": { "description": "無効の場合、アイテムは先行予約ではありません。", "type": "boolean" }, "release_date": { "description": "ISO 8601形式でのゲームキーのリリース日。", "type": "string" } }, "required": [ "release_date", "is_enabled" ], "type": "object" }, "prices": { "description": "実際通貨建ての価格。", "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "currency": { "description": "商品価格の通貨。3文字のコード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.Xsolla.com/doc/pay-station/references/supported-currencies/)。", "example": "RUB", "type": "string" }, "is_default": { "description": "ユーザーの通貨での価格が指定されていない場合、デフォルトの価格がカタログ作成に使用されます。", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_1", "maxLength": 255, "minLength": 1, "type": "string" }, "vc_prices": { "items": { "properties": { "amount": { "type": "number" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "gold", "type": "string" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "drm_sku", "prices" ], "type": "object" }, "type": "array" } }, "required": [ "sku", "name", "unit_items" ], "type": "object" } } }, "description": "ゲームデータを持つオブジェクト。", "required": true }, "ItemGroup_create": { "content": { "application/json": { "example": { "description": { "de": "Spielerwaffen", "en": "Player weapons" }, "external_id": "weapons", "iconUrl": "https://example.com/weapons.png", "isEnabled": true, "name": { "de": "Waffen", "en": "Weapons" }, "order": 1 }, "schema": { "$ref": "#/components/schemas/admin-group-create-request" } } }, "description": "Object with item group data.", "required": true }, "ItemGroup_item_order": { "content": { "application/json": { "example": [ { "item_id": 101, "order": 1 }, { "item_id": 102, "order": 2 }, { "item_id": 103, "order": 3 } ], "schema": { "items": { "$ref": "#/components/schemas/item-in-group-order-request-item" }, "type": "array", "uniqueItems": true } } }, "description": "Array of items with new order values in the group.", "required": true }, "ItemGroup_order": { "content": { "application/json": { "examples": { "by_external_id": { "summary": "Identify groups by external_id", "value": [ { "external_id": "weapons", "order": 1 }, { "external_id": "armor", "order": 2 }, { "external_id": "consumables", "order": 3 } ] }, "by_id": { "summary": "Identify groups by ID", "value": [ { "id": 1, "order": 1 }, { "id": 2, "order": 2 }, { "id": 3, "order": 3 } ] } }, "schema": { "oneOf": [ { "items": { "additionalProperties": false, "properties": { "id": { "description": "Item group ID assigned by Xsolla.", "example": 1, "minimum": 0, "type": "integer" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "id", "order" ], "type": "object" }, "title": "Identify by ID", "type": "array", "uniqueItems": true }, { "items": { "additionalProperties": false, "properties": { "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "minLength": 1, "type": "string" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "external_id", "order" ], "type": "object" }, "title": "Identify by external_id", "type": "array", "uniqueItems": true } ] } } }, "description": "Array of groups with new order values. All items must use the same identification method (either all by `id` or all by `external_id`).", "required": true }, "ItemGroup_update": { "content": { "application/json": { "example": { "description": { "de": "Aktualisierte Spielerwaffen", "en": "Updated player weapons" }, "external_id": "weapons", "iconUrl": "https://example.com/weapons-new.png", "isEnabled": true, "name": { "de": "Waffen Aktualisiert", "en": "Weapons Updated" }, "order": 2 }, "schema": { "$ref": "#/components/schemas/admin-group-update-request" } } }, "description": "Object with item group data to update.", "required": true }, "Virtual-Items-Currency_admin-create-virtual-currency": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "material", "name": { "en-US": "Material" }, "values": [ { "external_id": "gold", "value": { "en-US": "Gold" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "de-DE": "Die Hauptwährung deines Königreichs", "en-US": "The main currency of your kingdom" }, "groups": [ "gold" ], "is_enabled": true, "is_free": false, "is_paid_randomized_reward": false, "limits": { "per_item": 10000, "per_user": 5 }, "name": { "de-DE": "Goldmünze", "en-US": "Gold coin" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 100, "currency": "USD", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.coin_1" }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency" } } } }, "Virtual-Items-Currency_admin-create-virtual-currency-package": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "event", "name": { "en-US": "Event" }, "values": [ { "external_id": "10-anniversary", "value": { "en-US": "10th anniversary" } }, { "external_id": "christmas", "value": { "en-US": "Christmas" } } ] } ], "content": [ { "quantity": 500, "sku": "com.xsolla.novigrad_crown" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en-US": "The Crown (also known as the Novigradian crown) is a monetary unit which is used in some Northern Kingdoms", "ru-RU": "Крона (Также известна как Новиградская крона) - платежная единица, используемая в северных королевствах" }, "groups": [ "witcher" ], "image_url": "https://vignette.wikia.nocookie.net/witcher/images/7/7c/Items_Orens.png/revision/latest?cb=20081113120917", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "limits": { "per_item": null, "per_user": null }, "long_description": { "en-US": "Long Test new", "ru-RU": "Длинное описание" }, "media_list": [ { "type": "image", "url": "https://test.com/image0" }, { "type": "image", "url": "https://test.com/image1" } ], "name": { "en-US": "500x Novigradian crown", "ru-RU": "500x Новиградских крон" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 99.99, "currency": "USD", "is_default": true }, { "amount": 80.03, "currency": "EUR", "is_enabled": false } ], "sku": "com.xsolla.novigrad_crown_500", "vc_prices": null }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-currency-package" } } } }, "Virtual-Items-Currency_admin-create-virtual-item": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "craft-materials", "name": { "en": "Craft materials" }, "values": [ { "external_id": "steel", "value": { "en-US": "5" } }, { "external_id": "leather", "value": { "en-US": "1" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "de": "Ein Schwert ist eine Nahkampfwaffe mit Klinge, die zum Schneiden oder Stechen bestimmt ist, länger als ein Messer oder Dolch ist und aus einer langen Klinge besteht, die an einem Griff befestigt ist.", "en": "A sword is a bladed melee weapon intended for cutting or thrusting that is longer than a knife or dagger, consisting of a long blade attached to a hilt." }, "groups": [ "weapons" ], "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": 100, "per_user": 5 }, "name": { "de": "Schwert", "en": "Sword" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 100, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 200, "country_iso": "CZ", "currency": "CZK", "is_default": true, "is_enabled": false } ], "sku": "com.xsolla.sword_1", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-virtual-item" } } } }, "admin-order-search": { "content": { "application/json": { "example": { "created_date_from": "2018-01-07T00:00:00+03:00", "created_date_until": "2018-01-09T16:00:00+03:00", "limit": 5, "offset": 0 }, "schema": { "properties": { "created_date_from": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)形式のオーダー作成期間の開始日または日時。", "example": "2020-04-15T18:16:00+05:00", "format": "date-time", "nullable": false, "type": "string" }, "created_date_until": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)形式のオーダー作成期間の終了日または日時。", "example": "2020-04-16T18:16:00+05:00", "format": "date-time", "nullable": false, "type": "string" }, "limit": { "default": 10, "description": "応答に含まれる注文数の制限。", "maximum": 10, "minimum": 1, "nullable": false, "type": "integer" }, "offset": { "default": 0, "description": "リストが生成される順序の番号（カウントは0から始まる）。", "minimum": 0, "nullable": false, "type": "integer" } }, "type": "object" } } }, "description": "注文検索パラメータ" }, "connector-import-items-body": { "content": { "application/json": { "schema": { "properties": { "connector_external_id": { "description": "アイテムをインポートするための操作のタイプを指定する固定値。", "enum": [ "import_items" ], "type": "string" }, "file_url": { "description": "JSON形式のデータを含むファイルのURL。ファイルは、一般に公開されているストレージサービスにホストされている必要があります。ファイルテンプレートは、パブリッシャーアカウントでの[ストア > 仮想アイテム > カタログ管理 > アイテムをインポート（JSON）](https://publisher.xsolla.com/0/projects/0/storefront/import-export/import-items)セクションからダウンロードできます。", "example": "https://my-bucket.s3.amazonaws.com/items.json", "type": "string" }, "mode": { "default": "create_and_update", "description": "Import actions:\n\nPossible values:\n- `create` — Add new items.\n- `create_and_update` — Add new items and update existing ones.\n- `sync` — Add new, update existing, and disable missing items.", "enum": [ "create", "create_and_update", "sync" ], "type": "string" } }, "required": [ "connector_external_id", "file_url" ], "type": "object" } } } }, "create-update-attribute": { "content": { "application/json": { "example": { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" } }, "required": [ "external_id", "name" ], "type": "object" } } } }, "create-update-attribute-value": { "content": { "application/json": { "example": { "external_id": "weapon_class_sword_value", "value": { "de": "Schwert", "en": "Sword" } }, "schema": { "$ref": "#/components/schemas/request-attribute-value" } } } }, "create-update-region": { "content": { "application/json": { "schema": { "example": { "countries": [ "JP", "CN", "VN" ], "name": { "de-DE": "Asien", "en-US": "Asia" } }, "properties": { "countries": { "$ref": "#/components/schemas/Regions_countries" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "required": [ "countries", "name" ], "type": "object" } } } }, "reset-user-limits": { "content": { "application/json": { "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user" ], "type": "object" } } } }, "reset-user-limits-flexible": { "content": { "application/json": { "example": { "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "user": { "$ref": "#/components/schemas/User-limit_user_flexible" } }, "required": [ "user" ], "type": "object" } } } }, "update-user-limits-flexible": { "content": { "application/json": { "example": { "available": 0, "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "available": { "$ref": "#/components/schemas/User-limit_available_flexible" }, "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user", "available" ], "type": "object" } } } }, "update-user-limits-strict": { "content": { "application/json": { "example": { "available": 1, "user": { "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f" } }, "schema": { "properties": { "available": { "$ref": "#/components/schemas/User-limit_available" }, "user": { "$ref": "#/components/schemas/User-limit_user" } }, "required": [ "user", "available" ], "type": "object" } } } } }, "responses": { "200-admin-get-attribute": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/admin_attribute_response" } } }, "description": "指定された属性は正常に受信されました。" }, "200-admin-get-attribute-list-response": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "size", "name": { "de": "Größe", "en": "Size" } }, { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } } ], "total_count": 2 } } }, "schema": { "description": "アイテムを持つオブジェクト。", "properties": { "attributes": { "items": { "$ref": "#/components/schemas/admin_attribute_response" }, "type": "array" }, "total_count": { "type": "integer" } }, "type": "object" } } }, "description": "属性リストは正常に受信されました。" }, "200-admin-get-region": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Regions_200-region-model" } } }, "description": "指定された地域は正常に受信されました。" }, "200-admin-get-regions-list": { "content": { "application/json": { "examples": { "response": { "value": { "regions": [ { "id": 44, "name": { "de-DE": "Asien", "en-US": "Asia" } }, { "id": 45, "name": { "de-DE": "GUS", "en-US": "CIS" } } ] } } }, "schema": { "description": "アイテムを持つオブジェクト。", "properties": { "regions": { "items": { "$ref": "#/components/schemas/Regions_200-region-short-model" }, "type": "array" } }, "type": "object" } } }, "description": "地域リストは正常に受信されました。" }, "200-admin-get-user-item-limits": { "content": { "application/json": { "examples": { "response": { "value": { "per_user": { "available": 9, "total": 10 } } } }, "schema": { "$ref": "#/components/schemas/User-limit-item" } } }, "description": "ユーザーの購入制限が正常に受信されました。" }, "200-admin-order-search": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "orders": [ { "date_created": "2018-01-08T15:32:06+03:00", "is_free": true, "items": [ { "description": { "description": "yes", "image_url": "http://example.com/image.jpg", "name": "bla" }, "is_bonus": false, "is_free": true, "item_id": 1005111, "order_item_id": 29, "quantity": 1, "region_id": 1, "sku": "com.xsolla.1005111", "tax_category": "DG00001", "type": "virtual_good" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005112, "order_item_id": 30, "quantity": 3, "region_id": 1, "sku": "com.xsolla.1005112", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100511, "project_id": 101, "status": "done", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": 1 } }, { "coupons": [ { "code": "OPQRSTUVWX", "coupon_id": 100510, "sku": "com.xsolla.100510", "type": "promocode" } ], "date_created": "2018-01-07T15:32:06+03:00", "invoice_id": "100510", "is_free": false, "items": [ { "description": null, "is_bonus": false, "is_free": false, "item_id": 1005101, "order_item_id": 27, "price": { "amount": "67.3400", "amount_without_discount": "67.3400", "currency": "USD", "is_virtual_currency": false }, "quantity": 1, "region_id": null, "sku": "com.xsolla.1005101", "tax_category": "DG00001", "type": "game_key" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005102, "order_item_id": 28, "quantity": 2, "region_id": null, "sku": "com.xsolla.1005102", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100510, "price": { "amount": "67.3400", "amount_without_discount": "72.3400", "currency": "USD", "is_virtual_currency": false }, "project_id": 101, "promotions": [ { "promotion_id": 1005101 } ], "status": "paid", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": null } }, { "date_created": "2018-01-02T15:32:06+03:00", "is_free": false, "items": [ { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005051, "order_item_id": 17, "quantity": 1, "region_id": null, "sku": "com.xsolla.1005051", "tax_category": "DG00001", "type": "virtual_good" }, { "description": null, "is_bonus": true, "is_free": true, "item_id": 1005052, "order_item_id": 18, "quantity": 3, "region_id": null, "sku": "com.xsolla.1005052", "tax_category": "DG00001", "type": "value_point" } ], "mode": "default", "order_id": 100505, "price": { "amount": "78.2300", "amount_without_discount": "78.2300", "currency": "popugi", "is_virtual_currency": true }, "project_id": 101, "status": "paid", "user": { "country": "US", "email": "user@xsolla.com", "id": "07e653a2b15011e6818f005056a54369", "region_id": null } } ], "total_items_count": 11 } } }, "schema": { "properties": { "has_more": { "description": "追加のページがあるかどうか。", "example": true, "type": "boolean" }, "orders": { "description": "注文リスト。", "items": { "properties": { "coupons": { "description": "注文に適用されるクーポンリスト。", "items": { "properties": { "code": { "description": "使用したクーポンコード。大文字と小文字を区別する一意のコードです。文字と数字が含まれます。", "type": "string" }, "coupon_id": { "description": "クーポンIDは、クーポンを使用してプロモーションを作成する際にエクソーラによって生成されます。", "type": "integer" }, "sku": { "description": "クーポンSKU、クーポンを使用してプロモーションを作成する際にエクソーラによって生成されます。", "type": "string" }, "type": { "description": "クーポンのタイプ。", "enum": [ "unique_catalog_offer", "coupon", "promocode" ], "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] }, "date_created": { "description": "[ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)形式の注文作成日または日時コード。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": "string" }, "invoice_id": { "description": "請求書ID。", "type": "string" }, "is_free": { "description": "注文が無料かどうか。", "example": false, "type": "boolean" }, "items": { "description": "アイテムシスト。", "items": { "properties": { "description": { "description": "アイテムに関する情報を持つオブジェクト。", "properties": { "description": { "description": "アイテムの説明。", "type": "string" }, "image_url": { "description": "アイテム画像URL。", "format": "uri", "type": "string" }, "name": { "description": "アイテム名。", "type": "string" } }, "type": [ "object", "null" ] }, "is_bonus": { "description": "アイテムがボーナスであるかどうか。", "example": false, "type": "boolean" }, "is_free": { "default": false, "description": "アイテムが無料かどうか。", "example": false, "type": "boolean" }, "item_id": { "description": "アイテム ID。これは、アイテムを作成する際にエクソーラによって生成されます。", "example": 1, "type": "integer" }, "order_item_id": { "description": "注文のアイテム ID。これは、注文作成中にエクソーラによって生成されます。", "type": "integer" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "30", "type": "string" }, "amount_without_discount": { "description": "割引なしのアイテム価格。", "example": "30", "type": "string" }, "currency": { "description": "[ISO4217](https://en.wikipedia.org/wiki/ISO_4217)形式の3文字コードの仮想通貨のSKU。[エクソーラがサポートする通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)に関する詳細情報はドキュメントを参照してください。", "example": "USD", "type": "string" }, "is_virtual_currency": { "description": "通貨が仮想通貨であるかどうか。", "example": false, "type": "boolean" } }, "type": [ "object", "null" ] }, "quantity": { "description": "アイテム数量。", "example": 1, "type": "integer" }, "region_id": { "description": "アイテムが利用可能な地域のID。地域の販売制限の詳細については、[ドキュメント](https://developers.xsolla.com/ja/doc/shop-builder/features/regional-restrictions/)を参照してください。", "type": [ "integer", "null" ] }, "sku": { "description": "作成時に指定されたアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "elven_shield", "type": "string" }, "tax_category": { "description": "税のカテゴリ。", "example": "DG00002", "type": "string" }, "type": { "description": "アイテムタイプ。", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good", "value_point" ], "example": "virtual_good", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "description": "注文作成モード。", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "order_id": { "description": "注文ID。", "example": 1, "type": "integer" }, "price": { "description": "注文価格。", "properties": { "amount": { "description": "最終注文価格。", "example": "30", "type": "string" }, "amount_without_discount": { "description": "割引なしの注文価格。", "example": "30", "type": "string" }, "currency": { "description": "[ISO4217](https://en.wikipedia.org/wiki/ISO_4217)形式の3文字コードの実際通貨または仮想通貨のSKU。[エクソーラがサポートする通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)に関する詳細情報はドキュメントを参照してください。", "example": "USD", "type": "string" }, "is_virtual_currency": { "description": "通貨が仮想通貨であるかどうか。", "example": false, "type": "boolean" } }, "type": [ "object", "null" ] }, "project_id": { "description": "プロジェクトID。このパラメータは、[パブリッシャーアカウント](https://publisher.xsolla.com/)のプロジェクト名の横にあります。", "example": 44056, "type": "integer" }, "promotions": { "description": "注文に適用されるプロモーションリスト。", "items": { "properties": { "promotion_id": { "description": "プロジェクト内のプロモーションID。", "example": 111425, "type": "integer" } }, "type": "object" }, "type": [ "array", "null" ] }, "status": { "description": "注文状況。", "enum": [ "new", "paid", "done", "canceled", "expired" ], "example": "paid", "type": "string" }, "user": { "properties": { "country": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従った2文字の大文字の国名コード。[エクソーラがサポートする国](https://developers.xsolla.com/ja/doc/shop-builder/references/supported-countries/)の詳細情報については、ドキュメントを確認してください。", "example": "US", "type": "string" }, "email": { "description": "[RFC 822](https://www.w3.org/Protocols/rfc822/#z8)プロトコルに従って書式設定されたユーザーのメールアドレス。", "example": "user@xsolla.com", "format": "email", "type": "string" }, "id": { "description": "注文作成時に渡されたユーザーID。", "example": "07e653a2b15011e6818f005056a54369", "type": "string" }, "region_id": { "description": "ユーザーの地域ID。地域別の販売制限が設定されている場合に返される。注文を作成するときに渡されたユーザーの国は、[地域を作成する](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-region/)ときに指定された国のリストと照合されます。地域販売制限の詳細については、[ドキュメント](https://developers.xsolla.com/ja/doc/shop-builder/features/regional-restrictions/)を参照してください。", "example": 12, "type": [ "integer", "null" ] } }, "type": "object" } }, "type": "object" }, "type": "array" }, "total_items_count": { "description": "指定された期間の注文の合計数。", "example": 1, "type": "integer" } }, "type": "object" } } }, "description": "注文リストは正常に取得されました。" }, "200-items-import-status-model": { "content": { "application/json": { "schema": { "example": { "date_completed": "2024-11-19T15:27:31+03:00", "date_created": "2024-11-19T14:27:31+03:00", "date_updated": "2024-11-19T15:27:31+03:00", "error": null, "error_code": null, "progress": 100, "result": { "errors_by_sku": [ { "error_code": 4055, "error_message": "[0401-4055]: Item default price not set", "sku": "com.xsolla.sword_1", "type": "virtual_items" }, { "error_code": 1817, "error_message": "[0410-1817]: SKU can't be empty", "sku": "", "type": null } ], "errors_count": 2, "total_entities_count": 10 }, "status": "error" }, "properties": { "date_completed": { "description": "GMT+3タイムゾーンでのインポート操作完了のタイムスタンプ。エラーによりインポートが中断され、アイテムがインポートされなかった場合は、空の文字列が返されます。", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "date_created": { "description": "GMT+3タイムゾーンでのインポート作成操作のタイムスタンプ。", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "date_updated": { "description": "GMT+3タイムゾーンのエラーによりインポートが中断されたときのタイムスタンプ。", "example": "2024-12-15T18:16:00+03:00", "type": "string" }, "error": { "description": "一般的なインポートエラーの説明。", "type": "string" }, "error_code": { "description": "一般的なインポートエラーのコード。", "type": "string" }, "progress": { "description": "インポート実行の進捗状況を表するパーセント。", "example": 100, "type": "integer" }, "result": { "description": "特定のアイテムSKUのインポート結果とインポートエラーに関するデータを含むオブジェクト。", "properties": { "errors_by_sku": { "description": "特定のアイテムSKUのインポートエラーに関するデータを含むオブジェクトの配列。", "items": { "properties": { "error_code": { "description": "特定のアイテムSKUのインポートエラーコード。", "example": 1001, "type": "integer" }, "error_message": { "description": "特定のアイテムSKUのインポートエラーの説明。", "example": "Something went wrong", "type": "string" }, "sku": { "description": "インポートされたアイテムのSKU。", "example": "sku_1", "type": "string" }, "type": { "description": "アイテムタイプ。", "enum": [ "virtual_good", "virtual_currency", "virtual_currency_packages", "bundle" ], "example": "vi", "type": "string" } }, "type": "object" }, "type": "array" }, "errors_count": { "description": "インポート時にエラーが発生したアイテムの数。", "example": 3, "type": "integer" }, "total_entities_count": { "description": "インポートされたアイテムの合計数。", "example": 11, "type": "integer" } }, "type": "object" }, "status": { "description": "Import status.\n\nPossible values:\n- `initialized` — Import has been initiated.\n- `process` — Import is in progress.\n- `done` — Import was successfull.\n- `error` — Due to errors, the import was not completed or only partially completed.", "enum": [ "initialized", "process", "done", "error" ], "example": "error", "type": "string" } }, "type": "object" } } }, "description": "インポート状況が正常に取得されました。" }, "201-admin-create-attribute": { "content": { "application/json": { "example": { "external_id": "genre" }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" } }, "type": "object" } } }, "description": "属性は正常に更新されました。" }, "201-admin-create-attribute-value": { "content": { "application/json": { "example": { "external_id": "rpg" }, "schema": { "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" } }, "type": "object" } } }, "description": "属性値は正常に作成されました。" }, "201-admin-create-region": { "content": { "application/json": { "example": { "region_id": 42 }, "schema": { "properties": { "region_id": { "$ref": "#/components/schemas/Regions_region_id" } }, "type": "object" } } }, "description": "地域が正常に作成されました。" }, "204-admin-delete-region": { "content": {}, "description": "地域は正常に削除されました。" }, "204-admin-update-attribute": { "content": {}, "description": "属性は正常に更新されました。" }, "204-admin-update-region": { "content": {}, "description": "地域が正常に更新されました。" }, "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": "基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。" }, "403-auth-header-not-sent": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Authorization header not sent", "statusCode": 403 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Authorization header not sent.", "type": "string" }, "statusCode": { "example": 403, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "認証ヘッダーが送信されていません。" }, "404-attribute-not-found": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9901, "errorMessage": "[0401-9901]: Attribute not found.", "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 9901, "type": "integer" }, "errorMessage": { "example": "[0401-9901]: Attribute not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "属性が見つかりません。" }, "404-attribute-value-not-found": { "content": { "application/json": { "examples": { "Attribue value not found": { "$ref": "#/components/examples/404-attribute-value-not-found" }, "Attribute not found": { "$ref": "#/components/examples/404-attribute-not-found" } }, "schema": { "$ref": "#/components/schemas/404-not-found" } } }, "description": "属性値が見つかりません。" }, "404-region-not-found": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 9701, "type": "integer" }, "errorMessage": { "example": "[0401-9701]: Region not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "地域が見つかりません。`id`が正しいか確認してください。" }, "422-create-update-attribute-value": { "content": { "application/json": { "examples": { "external_id is duplicate": { "$ref": "#/components/examples/422-external-id-duplicate" }, "external_id is invalid": { "$ref": "#/components/examples/422-external-id-invalid" }, "external_id is required": { "$ref": "#/components/examples/422-external-id-required" }, "value is required": { "$ref": "#/components/examples/422-value-invalid" }, "value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" }, "value properties minimum length": { "$ref": "#/components/examples/422-value-properties-required" } }, "schema": { "$ref": "#/components/schemas/schemas-422-invalid-request" } } }, "description": "無効なリクエストです。" }, "422-validation-failed": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "statusCode": 422 } } }, "schema": { "$ref": "#/components/schemas/schemas-422-invalid-request" } } }, "description": "無効なリクエストです。" }, "Bundles_200-admin-get-bundle": { "content": { "application/json": { "example": { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "type": "virtual_good" }, { "description": { "en": "Take it, take it all! All of the Empires riches in one Mega Booster." }, "image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "type": "virtual_good" }, { "description": { "en": "Test your luck to find glorious treasures from Empire's past" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] }, "schema": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" } } }, "description": "指定されたバンドルは正常に受信されました。" }, "Bundles_200-admin-get-bundle-list": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png", "name": { "en": "Xsolla Booster Mini" }, "quantity": 2, "sku": "com.xsolla.booster_min_1", "type": "virtual_good" }, { "description": { "en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good." }, "image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png", "name": { "en": "Booster" }, "quantity": 15, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" }, { "description": { "en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods." }, "image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png", "name": { "en": "Xsolla Gloves" }, "quantity": 3, "sku": "com.xsolla.gloves_1", "type": "virtual_good" }, { "description": { "en": "Stylishly protect your toes with the accent of Xsolla" }, "image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png", "name": { "en": "Xsolla Boots" }, "quantity": 2, "sku": "com.xsolla.boots_1", "type": "virtual_good" }, { "description": { "en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)" }, "image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png", "name": { "en": "Xsolla Gun" }, "quantity": 10, "sku": "com.xsolla.gun_max", "type": "virtual_good" }, { "description": { "en": "Just hold down the trigger and pray to the Empire" }, "image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png", "name": { "en": "Empire Minigun" }, "quantity": 3, "sku": "com.xsolla.minigun_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Ultra Super Lootbox with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-03-01T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677639600, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Ultra Super lootbox with different items" }, "media_list": [], "name": { "en": "Ultra Super Lootbox Bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "150.49", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.UltraSuperLootboxBundle_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "type": "virtual_good" }, { "description": { "en": "Take it, take it all! All of the Empires riches in one Mega Booster." }, "image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "type": "virtual_good" }, { "description": { "en": "Test your luck to find glorious treasures from Empire's past" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610317, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] } ] }, "schema": { "description": "アイテムを持つオブジェクト。", "properties": { "items": { "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "type": "array" } }, "type": "object" } } }, "description": "バンドルのリストは正常に受信されました。" }, "Bundles_200-admin-get-bundle-list-in-group": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Test your luck to find glorious treasures from the past in an Xsolla Booster Mini." }, "image_url": "https://cdn.xsolla.net/img/misc/images/5ee252b292a560930c8f7e2c791dfc6d.png", "name": { "en": "Xsolla Booster Mini" }, "quantity": 2, "sku": "com.xsolla.booster_min_1", "type": "virtual_good" }, { "description": { "en": "Get high-quality, competitively priced gas with Booster. Download the app for free same-day delivery. Kick the gas station habit for good." }, "image_url": "https://cdn.xsolla.net/img/misc/images/e76d317ee5a8d06a4b730bcf23746e9e.png", "name": { "en": "Booster" }, "quantity": 15, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" }, { "description": { "en": "Enjoy a range of outdoor activities with gloves from EK Sporting Goods." }, "image_url": "https://cdn.xsolla.net/img/misc/images/93a7ee3ae284b677d3dc1f2e989731cb.png", "name": { "en": "Xsolla Gloves" }, "quantity": 3, "sku": "com.xsolla.gloves_1", "type": "virtual_good" }, { "description": { "en": "Stylishly protect your toes with the accent of Xsolla" }, "image_url": "https://cdn.xsolla.net/img/misc/images/6e33d40df3cdac152dac9ac3d1f5986e.png", "name": { "en": "Xsolla Boots" }, "quantity": 2, "sku": "com.xsolla.boots_1", "type": "virtual_good" }, { "description": { "en": "The M134 Minigun is a 7.62×51mm NATO, six-barrel rotary machine gun with a high rate of fire (2,000 to 6,000 rounds per minute)" }, "image_url": "https://cdn.xsolla.net/img/misc/images/3093eeb39d5ec7def3af6396607a30ba.png", "name": { "en": "Xsolla Gun" }, "quantity": 10, "sku": "com.xsolla.gun_max", "type": "virtual_good" }, { "description": { "en": "Just hold down the trigger and pray to the Empire" }, "image_url": "https://cdn.xsolla.net/img/misc/images/dabfa4567cd2d82e0562d4b0f448b436.png", "name": { "en": "Empire Minigun" }, "quantity": 3, "sku": "com.xsolla.minigun_2", "type": "virtual_good" } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Ultra Super Lootbox with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/779d2588a5b3cf348133fa7d5755cec8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "day_of_week": 2, "displayable_reset_next_date": "2023-03-07T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "weekly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Ultra Super lootbox with different items" }, "media_list": [], "name": { "en": "Ultra Super Lootbox Bundle" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": "150.49", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.UltraSuperLootboxBundle_1", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "standard", "content": [ { "description": { "en": "Opens ONE Empire lootbox of any kind" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5c2f8536f08a9949964e4fa2e01a7cb8.png", "name": { "en": "Empire Key" }, "quantity": 5, "sku": "com.xsolla.keys_2", "type": "virtual_good" }, { "description": { "en": "Take it, take it all! All of the Empires riches in one Mega Booster." }, "image_url": "https://cdn.xsolla.net/img/misc/images/55e908cb9670301ac8f89a6382433a27.png", "name": { "en": "Empire Booster Mega" }, "quantity": 1, "sku": "com.xsolla.booster_mega_2", "type": "virtual_good" }, { "description": { "en": "Test your luck to find glorious treasures from Empire's past" }, "image_url": "https://cdn.xsolla.net/img/misc/images/5bcecec17400a0d8c72dd265ff730b07.png", "name": { "en": "Empire Booster Mini" }, "quantity": 3, "sku": "com.xsolla.booster_min_2", "type": "virtual_good" } ], "description": { "en": "Empire bundle with items" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 610317, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { "amount": "150", "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_default": true, "name": { "en": "Crystals", "ru": "Crystals" }, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ] } ] }, "schema": { "description": "アイテムを持つオブジェクト。", "properties": { "items": { "items": { "$ref": "#/components/schemas/Bundles_admin_bundle_response" }, "type": "array" } }, "type": "object" } } }, "description": "バンドルのリストは正常に受信されました。" }, "Bundles_200-get-bundle-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle-list" } }, "schema": { "description": "アイテムを持つオブジェクト。", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Bundles_client_bundle" }, "type": "array" } }, "type": "object" } } }, "description": "バンドルのリストは正常に受信されました。" }, "Bundles_201-admin-create-bundle": { "content": { "application/json": { "examples": { "response": { "value": { "sku": "com.xsolla.kg_1" } } }, "schema": { "properties": { "sku": { "$ref": "#/components/schemas/Bundles_sku" } }, "type": "object" } } }, "description": "バンドルが正常に作成されました。" }, "Bundles_204-admin-delete-bundle": { "content": {}, "description": "バンドルは正常に削除されました。" }, "Bundles_204-admin-hide-bundle": { "content": {}, "description": "バンドルは正常に非表示にされました。" }, "Bundles_204-admin-show-bundle": { "content": {}, "description": "バンドルが正常に表示されました。" }, "Bundles_204-admin-update-bundle": { "content": {}, "description": "バンドルが正常に更新されました。" }, "Bundles_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": "基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。" }, "Bundles_422-invalid-request": { "content": { "application/json": { "examples": { "Custom attributes JSON can’t exceed 500 characters": { "$ref": "#/components/examples/422-custom-attributes-size-exceeded" }, "Numbers of attribute values per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded" }, "Numbers of attributes per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded" }, "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Bundles_422-invalid-request" } } }, "description": "無効なリクエストです。" }, "Cart-Free_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "注文ID。", "type": "integer" } }, "type": "object" } } }, "description": "無料注文が正常に作成されました。" }, "Cart-Payment_200-admin-fill-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "description": "The cup of tea", "groups": [ { "external_id": "cups", "name": "Cups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Cup", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [], "quantity": 2, "sku": "com.xsolla.cup01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Wonderful white T-shirt", "groups": [], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "White T-shirt", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "3.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.t-shirt01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Wonderful white T-shirt", "groups": [ { "external_id": "clothes", "name": "Clothes" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": true, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Cat's cup", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": null, "promotions": [], "quantity": 1, "sku": "com.xsolla.cup01", "type": "physical_good", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = hut01 not found", "quantity": 1, "sku": "com.xsolla.hat01" } ] } } }, "schema": { "properties": { "cart_id": { "description": "カートID。購入ページや決済APIのエンドポイントへの問い合わせに渡します。", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "カート価格。", "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" }, "warnings": { "items": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "アイテムの入ったカートは正常に返送されました。" }, "Cart-Payment_200-fill-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "warnings": [ { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found", "quantity": 1, "sku": "com.xsolla.booster_mega_21" } ] } } }, "schema": { "properties": { "cart_id": { "description": "カートID。", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "アイテム価格。", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_item_type": { "description": "アイテムタイプ。", "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "カート価格。", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" }, "warnings": { "items": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "アイテムの入ったカートは正常に返送されました。" }, "Cart-Payment_200-get-cart-json-model": { "content": { "application/json": { "examples": { "response": { "value": { "cart_id": "cart_id", "is_free": false, "items": [ { "attributes": [], "can_be_bought": true, "description": "Take it, take it all! All of Xsollas riches in one Mega Booster.", "groups": [ { "external_id": "powerups", "name": "Power Ups" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png", "is_bonus": false, "is_free": false, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Xsolla Booster Mega", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "50.0000000000000000", "amount_without_discount": "100.0000000000000000", "currency": "USD" }, "promotions": [], "quantity": 123, "sku": "com.xsolla.booster_mega_1", "type": "virtual_good", "virtual_item_type": "consumable", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ] } } }, "schema": { "properties": { "cart_id": { "description": "カートID。", "example": "cart_id", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-cart_is_free" }, "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Cart-Payment_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "type": "string" }, "groups": { "items": { "properties": { "external_id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "image_url": { "type": "string" }, "is_bonus": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "type": [ "string", "null" ] }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "アイテム価格。", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" }, "currency": { "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "type": "string" }, "virtual_item_type": { "description": "アイテムタイプ。", "type": "string" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "price": { "description": "カート価格。", "example": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "properties": { "amount": { "default": "50.0000000000000000", "type": "string" }, "amount_without_discount": { "default": "100.0000000000000000", "type": "string" }, "currency": { "default": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_cart_promotions" } }, "type": "object" } } }, "description": "アイテムの入ったカートは正常に返送されました。" }, "Cart-Payment_200-get-order": { "content": { "application/json": { "examples": { "response": { "value": { "content": { "is_free": false, "items": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.item_1" } ], "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" } }, "order_id": 1, "status": "paid" } } }, "schema": { "properties": { "content": { "description": "注文の詳細。", "properties": { "is_free": { "description": "`true`の場合で、注文は無料です。", "example": false, "type": "boolean" }, "items": { "description": "アイテムシスト。", "example": [ { "is_free": false, "price": { "amount": "30", "amount_without_discount": "30", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.item_1" } ], "items": { "properties": { "is_free": { "$ref": "#/components/schemas/value-is_free" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "30", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "30", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "quantity": { "description": "アイテム数量。", "example": 1, "type": "integer" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "some_sku", "type": "string" } }, "type": "object" }, "type": "array" }, "price": { "description": "注文価格。", "properties": { "amount": { "description": "注文割引価格。", "example": "30", "type": "string" }, "amount_without_discount": { "description": "注文価格。", "example": "30", "type": "string" }, "currency": { "description": "注文価格の通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "virtual_price": { "description": "仮想通貨での注文価格。", "properties": { "amount": { "description": "注文割引価格。", "example": "100", "type": "string" }, "amount_without_discount": { "description": "注文価格。", "example": "150", "type": "string" }, "currency": { "description": "注文に使用する仮想通貨SKU。", "example": "test_vc", "type": "string" } }, "type": "object" } }, "type": "object" }, "order_id": { "default": "Order ID.", "description": "注文ID。", "example": 1, "type": "integer" }, "status": { "description": "注文の状況：`new`/`paid`/`done`/`canceled`。", "example": "paid", "type": "string" } }, "type": "object" } } }, "description": "注文リクエストが成功しました。" }, "Cart-Payment_200-order-created": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" } } }, "schema": { "properties": { "order_id": { "description": "注文ID。", "type": "integer" }, "token": { "description": "決済トークン。", "type": "string" } }, "type": "object" } } }, "description": "注文が正常に作成されました。" }, "Cart-Payment_201-admin-create-payment-token": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" } } }, "schema": { "properties": { "order_id": { "description": "注文ID。", "example": 1, "type": "integer" }, "token": { "description": "決済トークン。", "type": "string" } }, "type": "object" } } }, "description": "決済トークンとオーダーを成功に作成しました。" }, "Cart-Payment_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": "基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。" }, "Cart-Payment_404-create-order-with-item-not-found-errors": { "content": { "application/json": { "examples": { "coupon not found": { "$ref": "#/components/examples/404-coupon-not-found" }, "item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "アイテムまたはクーポンが見つかりません。使用データが正しいか確認してください。" }, "Cart-Payment_404-get-order": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 9001, "errorMessage": "[0401-9001]: Order not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 9001, "type": "integer" }, "errorMessage": { "example": "[0401-9001]: Order not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "注文が見つかりません。`project_id`と`order_id`が正しいことを確認してください。" }, "Cart-Payment_404-item": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "アイテムが見つかりませんでした。`project_id`と`item_sku`が正しいことを確認してください。" }, "Cart-Payment_404-user": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 5008, "type": "integer" }, "errorMessage": { "example": "[0401-5008]: Could not find User", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ユーザが見つかりませんでした。`x-user-for`または`x-user-id`トークンが正しいことを確認してください。" }, "Cart-Payment_422-admin-create-payment-token": { "content": { "application/json": { "examples": { "Empty cart": { "value": { "errorCode": 1417, "errorMessage": "[0401-1417]: Empty cart! Cart shouldn't be empty!", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Invalid cart": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Invalid request body": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `name` is required", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "Item is free": { "value": { "errorCode": 1421, "errorMessage": "[0401-1421]: Item is free", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } }, "User country not provided": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: The parameter user.country.value or the header X-User-Ip must be specified", "statusCode": 422, "transactionId": "da145238620011eb8e24fe6913ff226a" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request-2" } } }, "description": "リクエスト本文とカート作成検証エラーです。\n-渡したアイテムから作成られた無効なカート。カートは空ではないことと全てのアイテムが無料ではないことを確認します。\n-無効なリクエスト本文。" }, "Cart-Payment_422-can-put-only-virtual-good-to-cart": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1421, "errorMessage": "Only Virtual Good Supported", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1421, "type": "integer" }, "errorMessage": { "example": "This type of item cannot be put to the cart. Select another type of item.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "このタイプのアイテムはカートに入れることができません。他のタイプのアイテムを選択してください。" }, "Cart-Payment_422-create-order-with-item-invalid": { "content": { "application/json": { "examples": { "code expired": { "value": { "errorCode": 9810, "errorMessage": "[0401-9810]: Sorry, this code is expired.", "statusCode": 422 } }, "code redemption limit": { "value": { "errorCode": 9804, "errorMessage": "[0401-9804]: You have reached the coupon redemption limit.", "statusCode": 422 } }, "invalid item": { "value": { "errorCode": 1411, "errorMessage": "[0401-1411]: Invalid item", "statusCode": 422 } }, "regionally restricted": { "value": { "errorCode": 9808, "errorMessage": "[0401-9808]: Coupon is not available in your region.", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1411, "type": "integer" }, "errorMessage": { "example": "[0401-1411]: Invalid item", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "無効なエラーです。" }, "Cart-Payment_422-invalid-cart": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1401, "errorMessage": "[0401-1401]: Invalid cart", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1401, "type": "integer" }, "errorMessage": { "example": "[0401-1401]: Invalid cart", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "無効なカート。カートが存在し、空でなく、すべてのアイテムが無料でないことを確認してください。" }, "Cart-Payment_422-invalid-item": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1411, "errorMessage": "[0401-1411]: Invalid item", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1411, "type": "integer" }, "errorMessage": { "example": "[0401-1411]: Invalid item", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "無効なアイテム。アイテムが存在し、オフまたは削除されてなく、フリーになっていないことを確認してください。" }, "Cart-Payment_422-non-negative-quantity": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Item quantity must be non-negative integer", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "Item quantity must be non-negative integer.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "アイテム数量は非負整数でなければなりません。" }, "Common_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": "基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。" }, "Game-Keys_200-admin-get-game-by-sku": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 1" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": false, "item_id": 1, "long_description": { "en": "Example game's long description" }, "media_list": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "name": { "en": "Game 1" }, "order": 1, "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_id": 1, "drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "drm_name": "Steam", "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 3, "keys": { "available": 3, "total": 4, "used": 1 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [ { "amount": 1199.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_1", "type": "game_key", "virtual_prices": [] }, { "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 4, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 1299.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "regions": [ { "id": 12 }, { "id": 64 } ], "sku": "com.xsolla.game_1_key_2", "type": "game_key", "virtual_prices": null } ] } } }, "schema": { "description": "ゲーム情報を持つオブジェクト。", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "アイテムが所属するグループ。", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "image_url": { "description": "画像URL。", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "type": "boolean" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 1, "type": "integer" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "スクリーンショット、ゲームプレイ動画などのゲーム追加アセット。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "メディアタイプ：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "リソースファイル。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "リスト内のゲーム順の優先順位。", "example": 1, "type": "integer" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_1", "type": "string" }, "type": { "description": "アイテムタイプ。 この場合、それは常に`unit`です。", "example": "unit", "type": "string" }, "unit_items": { "description": "異なるDRMに対応したゲームキー。", "items": { "description": "ゲームキーアイテム。特定のプラットフォーム（steam、gogなど）のゲームを表します。", "properties": { "drm_id": { "description": "DRM内部の一意のID。", "example": 1, "type": "integer" }, "drm_image": { "description": "ゲームキーDRMのアイコン。", "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "type": [ "string", "null" ] }, "drm_name": { "description": "ゲームキーDRMの名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "DRMユニークID。", "example": "steam", "type": "string" }, "is_enabled": { "description": "無効の場合、アイテムの購入やインベントリからのアクセスはできません。", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_sales_exist": { "description": "`true`の場合、ユーザーがゲームキーを購入しました。", "type": "boolean" }, "is_show_in_store": { "description": "アイテムは購入可能です。", "type": "boolean" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 1, "type": "integer" }, "keys": { "properties": { "available": { "description": "購入可能なキーの数。", "type": "integer" }, "total": { "description": "アップロードされたキーの合計数。", "type": "integer" }, "used": { "description": "販売されたキーの数。", "type": "integer" } }, "type": "object" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "order": { "description": "リスト内のゲーム順の優先順位。", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "pre_order": { "description": "先行予約の設定。", "properties": { "description": { "description": "予約注文に関する追加情報は電子メールで送信されます。", "type": [ "string", "null" ] }, "is_enabled": { "description": "無効の場合、アイテムは先行予約ではありません。", "type": "boolean" }, "release_date": { "description": "ISO 8601形式でのゲームキーのリリース日。", "type": [ "string", "null" ] } }, "type": "object" }, "prices": { "description": "実際通貨建ての価格。", "example": [ { "amount": 1299.99, "country_is": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "country_iso": { "description": "この価格が利用可能な国。[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に基づく2文字コード。", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "RUB", "type": "string" }, "is_default": { "description": "ユーザーの通貨での価格が指定されていない場合、デフォルトの価格がカタログ作成に使用されます。", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_1", "type": "string" }, "type": { "description": "アイテムタイプ。 この場合、それは常に`game_key`です。", "example": "game_key", "type": "string" }, "virtual_prices": { "example": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "items": { "properties": { "amount": { "type": "number" }, "description": { "additionalProperties": true, "description": "ゲーム説明用のローカライズを含むオブジェクト。ゲームキーは「ISO 3166-1」で指定されています。", "example": { "en": "Game 1 Example" }, "type": "object" }, "image_url": { "description": "画像URL。", "example": "https://image.example.com", "type": "string" }, "is_default": { "type": "boolean" }, "name": { "additionalProperties": true, "description": "仮想通貨用のローカライズされたオブジェクト。キーはISO 3166-1で指定されています。", "example": { "en": "Gold" }, "type": "object" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "gold", "type": "string" }, "type": { "description": "アイテムタイプ。 この場合、それは常に`virtual_currency`です。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "ゲームは正常に受信されました。" }, "Game-Keys_200-admin-get-games-list": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 1" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": false, "item_id": 1, "long_description": { "en": "Example game's long description" }, "media_list": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "name": { "en": "Game 1" }, "order": 1, "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "drm_id": 1, "drm_image": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "drm_name": "Steam", "drm_sku": "steam_key_1", "is_enabled": true, "is_free": false, "is_sales_exist": false, "is_show_in_store": false, "item_id": 3, "keys": { "available": 3, "total": 4, "used": 1 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [ { "amount": 1199.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [], "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "groups": [], "is_enabled": true, "is_free": false, "is_sales_exist": true, "is_show_in_store": false, "item_id": 4, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "name": { "en": "Game 1 Key 2" }, "order": 1, "periods": [], "pre_order": { "description": "Some description", "is_enabled": true, "release_date": "2020-08-11T10:00:00+03:00" }, "prices": [ { "amount": 1299.99, "country_iso": "RU", "currency": "RUB", "is_default": true, "is_enabled": true } ], "sku": "com.xsolla.game_1_key_2", "type": "game_key", "virtual_prices": null } ] }, { "attributes": [ { "external_id": "platform", "name": { "en-US": "Platform" }, "values": [ { "external_id": "platform_value_d847f9a494487f5e95ad218f7beecac646f15989", "value": { "de-DE": "Windows, Linux", "en-US": "Windows, Linux" } } ] } ], "description": { "en": "Example game 2" }, "groups": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "image_url": "https://image.example.com", "is_enabled": true, "is_free": false, "is_show_in_store": true, "item_id": 2, "long_description": { "en": "Example game's long description" }, "media_list": [], "name": { "en": "Game 2" }, "order": 1, "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "drm_id": 8, "drm_image": null, "drm_name": "Epic Games Store", "drm_sku": "epicgames_key_1", "is_enabled": false, "is_free": false, "is_sales_exist": true, "is_show_in_store": false, "item_id": 5, "keys": { "available": 0, "total": 0, "used": 0 }, "limits": { "per_item": { "available": 5000, "reserved": 500, "sold": 4500, "total": 10000 }, "per_user": { "limit_exceeded_visibility": "show", "total": 10 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "pre_order": { "description": null, "is_enabled": false, "release_date": null }, "prices": [], "sku": "com.xsolla.game_2_key_2", "type": "game_key", "virtual_prices": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ] } ] } ] } } }, "schema": { "description": "ゲームを持つオブジェクト。", "properties": { "items": { "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "description": "アイテムが所属するグループ。", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "image_url": { "description": "画像URL。", "example": "https://image.example.com", "type": "string" }, "is_enabled": { "description": "無効の場合、アイテムの購入やインベントリからのアクセスはできません。", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_show_in_store": { "description": "アイテムは購入可能です。", "type": "boolean" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 1, "type": "integer" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "description": "スクリーンショット、ゲームプレイ動画などのゲーム追加アセット。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "メディアタイプ：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "リソースファイル。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "リスト内のゲーム順の優先順位。", "example": 1, "type": "integer" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_1", "type": "string" }, "type": { "description": "アイテムタイプ。 この場合、それは常に`unit`です。", "example": "unit", "type": "string" }, "unit_items": { "description": "異なるDRMに対応したゲームキー。", "items": { "description": "ゲームキーアイテム。特定のプラットフォーム（steam、gogなど）のゲームを表します。", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_admin-attributes" }, "drm_id": { "description": "DRM内部の一意のID。", "example": 1, "type": "integer" }, "drm_image": { "description": "ゲームキーDRMのアイコン。", "example": "https://upload.wikimedia.org/wikipedia/en/4/48/Steam_Icon_2014.png", "type": [ "string", "null" ] }, "drm_name": { "description": "ゲームキーDRMの名称。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "DRMユニークID。", "example": "steam", "type": "string" }, "groups": { "description": "アイテムが所属するグループ。", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "example": { "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "is_enabled": { "description": "無効の場合、アイテムの購入やインベントリからのアクセスはできません。", "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_sales_exist": { "description": "`true`の場合、ユーザーがゲームキーを購入しました。", "type": "boolean" }, "is_show_in_store": { "description": "アイテムは購入可能です。", "type": "boolean" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 1, "type": "integer" }, "keys": { "properties": { "available": { "description": "購入可能なキーの数。", "type": "integer" }, "total": { "description": "アップロードされたキーの合計数。", "type": "integer" }, "used": { "description": "販売されたキーの数。", "type": "integer" } }, "type": "object" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "description": "リスト内のゲーム順の優先順位。", "example": 1, "type": "integer" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "pre_order": { "description": "先行予約の設定。", "properties": { "description": { "description": "予約注文に関する追加情報は電子メールで送信されます。", "type": [ "string", "null" ] }, "is_enabled": { "description": "無効の場合、アイテムは先行予約ではありません。", "type": "boolean" }, "release_date": { "description": "ISO 8601形式でのゲームキーのリリース日。", "type": [ "string", "null" ] } }, "type": "object" }, "prices": { "description": "実際通貨建ての価格。", "example": [ { "amount": 1299.99, "currency": "RUB", "is_default": true, "is_enabled": true } ], "items": { "properties": { "amount": { "example": 1299.99, "type": "number" }, "country_iso": { "description": "この価格が利用可能な国。[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に基づく2文字コード。", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "RUB", "type": "string" }, "is_default": { "description": "ユーザーの通貨での価格が指定されていない場合、デフォルトの価格がカタログ作成に使用されます。", "type": "boolean" }, "is_enabled": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "regions": { "$ref": "#/components/schemas/Game-Keys_regions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_1", "type": "string" }, "type": { "description": "アイテムタイプ。 この場合、それは常に`game_key`です。", "example": "game_key", "type": "string" }, "virtual_prices": { "example": [ { "amount": 1000, "description": null, "image_url": "https://i.pinimg.com/originals/91/ae/56/91ae5683045f6dbef16b1482bade938f.png", "is_default": true, "name": { "en": "Gold" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "items": { "properties": { "amount": { "type": "number" }, "description": { "additionalProperties": true, "description": "ゲーム説明用のローカライズを含むオブジェクト。ゲームキーは「ISO 3166-1」で指定されています。", "example": { "en": "Game 1 Example" }, "type": [ "object", "null" ] }, "image_url": { "description": "画像URL。", "example": "https://image.example.com", "type": "string" }, "is_default": { "type": "boolean" }, "name": { "additionalProperties": true, "description": "仮想通貨用のローカライズされたオブジェクト。キーはISO 3166-1で指定されています。", "example": { "en": "Gold" }, "type": "object" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "gold", "type": "string" }, "type": { "description": "アイテムタイプ。 この場合、それは常に`virtual_currency`です。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": [ "array", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "ゲームのリストは正常に受信されました。" }, "Game-Keys_200-get-codes": { "content": { "text/plain": { "examples": { "response": { "value": "PIN-CODE-ALL PIN-CODE-ALL-3" } }, "schema": { "example": "PIN-CODE-ALL PIN-CODE-ALL-3", "type": "string" } } }, "description": "コードは正常に受信されました。" }, "Game-Keys_200-get-drm-list": { "content": { "application/json": { "examples": { "response": { "value": { "drm": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam_key_1" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": null, "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation_key_1" } ] } } }, "schema": { "description": "ゲームを持つオブジェクト。", "properties": { "drm": { "example": [ { "drm_id": 1, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": "https://support.steampowered.com", "name": "Steam", "redeem_instruction_link": "https://support.steampowered.com", "sku": "steam_key_1" }, { "drm_id": 2, "image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "link": null, "name": "Playstation", "redeem_instruction_link": "https://support.us.playstation.com", "sku": "playstation_key_1" } ], "items": { "properties": { "drm_id": { "description": "DRM ID。", "example": 1, "type": "number" }, "image": { "description": "画像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "link": { "description": "引き換えのリンク。", "example": "https://support.us.playstation.com", "type": [ "string", "null" ] }, "name": { "description": "DRM名。", "example": "Steam", "type": "string" }, "redeem_instruction_link": { "description": "引き換えに関する説明のリンク。", "example": "https://support.us.playstation.com", "type": "string" }, "sku": { "description": "一意のDRM ID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "steam", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "DRMのリストが正常に受信されました。" }, "Game-Keys_200-get-game-keys-by-group-catalog": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_2", "groups": [ { "external_id": "all", "item_order_in_group": 1, "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_2", "type": "game_key", "virtual_prices": [] } ] } } }, "schema": { "description": "ゲームを持つオブジェクト。", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_2", "groups": [ { "external_id": "all", "name": "All games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": false, "name": "Game name", "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_2", "type": "game_key", "virtual_prices": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "アイテムの説明。", "example": "Game description", "type": "string" }, "drm_name": { "description": "DRM名。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "一意のDRM ID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "steam", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "has_keys": { "description": "`true`の場合、ゲームキーに販売用のキーがあります。", "example": false, "type": "boolean" }, "image_url": { "description": "画像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "`true`の場合、ゲームキーは先行予約で、まだ発売されていません。", "example": true, "type": "boolean" }, "name": { "description": "アイテム名。", "example": "Game name", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "release_date": { "description": "ISO 8601形式でのゲームキーのリリース日。", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_01", "type": "string" }, "type": { "description": "アイテムタイプ：`game_key`。", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "vc_test", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "ゲームキーのリストが正常に受信されました。" }, "Game-Keys_200-get-games-catalog": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 1, "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [ { "date_from": "2020-08-11T20:00:00+03:00", "date_until": null } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "release_date": null, "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" } ] } } }, "schema": { "description": "ゲームを持つオブジェクト。", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" }, { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "name": "All games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_2", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_2", "has_keys": false, "is_free": false, "is_pre_order": false, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [] } ], "unit_type": "game" } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "アイテムの説明。", "example": "Game description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "アイテム名。", "example": "Game name", "type": "string" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_01", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。", "example": "unit", "type": "string" }, "unit_items": { "items": { "properties": { "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "description": "DRM名。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "一意のDRM ID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "steam", "type": "string" }, "has_keys": { "description": "`true`の場合、ゲームキーに販売用のキーがあります。", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "`true`の場合、ゲームキーは先行予約で、まだ発売されていません。", "example": true, "type": "boolean" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "ISO 8601形式でのゲームキーのリリース日。", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_01", "type": "string" }, "type": { "description": "アイテムタイプ：`game_key`。", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "vc_test", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "unit_type": { "description": "ユニットタイプ：`game`。", "example": "game", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "ゲームのリストは正常に受信されました。" }, "Game-Keys_200-session-information": { "content": { "application/json": { "examples": { "response": { "value": { "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" } } }, "schema": { "properties": { "count_skipped": { "example": 10, "type": "integer" }, "count_total": { "example": 100, "type": "integer" }, "count_uploaded": { "example": 0, "type": "integer" }, "session_id": { "example": "fc7105b6e8ee01339582970b37697242", "type": "string" }, "status": { "example": "processing", "type": "string" } }, "type": "object" } } }, "description": "セッション情報を読み込むコードが正常に受信されました。" }, "Game-Keys_200-user-entitlement-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "description": "Description of the greatest game in the world.", "drm": "drmfree", "game_sku": "com.xsolla.key_1", "image_url": "https://none", "is_pre_order": false, "name": "The Greatest Game in the World", "project_id": 30810 } ], "total_items_count": 1 } } }, "schema": { "description": "ゲーム情報を持つオブジェクト。", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Game-Keys_entitlement_item" }, "type": "array" }, "total_items_count": { "$ref": "#/components/schemas/Pagination_total-items-count" } }, "type": "object" } } }, "description": "ユーザーが所有するゲームキーのリストが正常に受信しました。" }, "Game-Keys_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": "基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。" }, "Game-Keys_403-auth-header-not-sent": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 0, "errorMessage": "Authorization header not sent", "statusCode": 403 } } }, "schema": { "properties": { "errorCode": { "example": 0, "type": "integer" }, "errorMessage": { "example": "Authorization header not sent.", "type": "string" }, "statusCode": { "example": 403, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "認証ヘッダーが送信されていません。" }, "Game-Keys_422-invalid-request": { "content": { "application/json": { "examples": { "Numbers of attribute values per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded" }, "Numbers of attributes per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded" }, "The property `drm_sku` is required": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity. The property `drm_sku` is required", "statusCode": 422 } }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Game-Keys_422-invalid-request" } } }, "description": "無効なリクエストです。" }, "ItemGroup_200-admin-get-group": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group" } }, "schema": { "$ref": "#/components/schemas/admin-group-response-base" } } }, "description": "Item group was successfully retrieved." }, "ItemGroup_200-admin-get-group-by-item-type": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-by-item-type" } }, "schema": { "$ref": "#/components/schemas/admin-group-detail-response-by-item-type" } } }, "description": "Item group was successfully retrieved, with `items_count` filtered by the specified item type." }, "ItemGroup_200-admin-get-group-list": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-list" } }, "schema": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/admin-group-response-base" }, "type": "array" } }, "type": "object" } } }, "description": "Item groups list was successfully retrieved." }, "ItemGroup_200-admin-get-group-list-by-item-type": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/200-admin-get-group-list-by-item-type" } }, "schema": { "properties": { "groups": { "items": { "$ref": "#/components/schemas/admin-group-response-by-item-type" }, "type": "array" } }, "type": "object" } } }, "description": "Item group list was successfully retrieved. `items_count` field includes only items of the specified type." }, "ItemGroup_201-admin-create-group": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/201-admin-create-group" } }, "schema": { "properties": { "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "type": "string" } }, "type": "object" } } }, "description": "Item group was successfully created." }, "ItemGroup_204-admin-delete-group": { "description": "Item group was successfully deleted." }, "ItemGroup_204-admin-reorder-groups": { "description": "Item groups were successfully reordered." }, "ItemGroup_204-admin-reorder-items": { "description": "Items within the group were successfully reordered." }, "ItemGroup_204-admin-update-group": { "description": "Item group was successfully updated." }, "ItemGroup_401-invalid-basic-auth": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1020, "errorMessage": "[0401-1020]: Error in Authentication method occurred", "statusCode": 401, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/error-response-base" } } }, "description": "Basic authentication failed or invalid credentials were provided. Ensure that you use basic authentication and correct credentials." }, "ItemGroup_404-group-not-found": { "content": { "application/json": { "examples": { "Group not found by ID": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found", "errorMessageExtended": { "group_id_list": [ 99 ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group not found by external_id": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with external id = 'weapons' not found", "errorMessageExtended": { "external_id_list": [ "weapons" ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Items or group not found (reorder endpoints)": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group not found. Returned if the group with the specified `external_id` does not exist or belongs to another project." }, "ItemGroup_404-reorder-groups-not-found": { "content": { "application/json": { "examples": { "Group not found by ID": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with id in (99) and projectId = 123 not found", "errorMessageExtended": { "group_id_list": [ 99 ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group not found by external_id": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Group with external id = 'weapons' not found", "errorMessageExtended": { "external_id_list": [ "weapons" ], "project_id": 123 }, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group not found. Returned if the group with the specified `id` or `external_id` does not exist or belongs to another project." }, "ItemGroup_404-reorder-items-by-external-id-not-found": { "content": { "application/json": { "examples": { "Items or group not found": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "external_id_list": { "description": "List of group `external_id` used in the lookup request.", "items": { "type": "string" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group or items not found. Returned if the group with the specified `external_id` doesn't exist or belongs to another project, or if one or more `item_id` were not found in the group." }, "ItemGroup_404-reorder-items-by-id-not-found": { "content": { "application/json": { "examples": { "Items or group not found": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Items or group were not found.", "errorMessageExtended": {}, "statusCode": 404, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "allOf": [ { "$ref": "#/components/schemas/error-response-base" }, { "properties": { "errorMessageExtended": { "description": "IDs used in the failed lookup.", "properties": { "group_id_list": { "description": "List of group `id` used in the lookup request.", "items": { "type": "integer" }, "type": "array" }, "project_id": { "description": "Project ID used in the lookup request.", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": "object" } ] } } }, "description": "Item group or items not found. Returned if the group with the specified `id` does not exist or belongs to another project, or if one or more `item_id` were not found in the group." }, "ItemGroup_422-create-update": { "content": { "application/json": { "examples": { "Group already exists": { "value": { "errorCode": 4401, "errorMessage": "[0401-4401]: Item group already exists", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Group cannot be its own parent": { "value": { "errorCode": 4404, "errorMessage": "[0401-4404]: Group can't be self parent", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "Reserved external_id value": { "value": { "errorCode": 4516, "errorMessage": "[0401-4516]: Value 'tools' not allowed to be used for the property 'external_id'.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } }, "The property `external_id` is required": { "$ref": "#/components/examples/422-property-external-id-required" } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Returned for validation errors or if the data violates system rules." }, "ItemGroup_422-delete": { "content": { "application/json": { "examples": { "Cannot delete group with items": { "value": { "errorCode": 4402, "errorMessage": "[0401-4402]: Item group with items cannot be deleted.", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Cannot delete a group that contains items." }, "ItemGroup_422-ordering": { "content": { "application/json": { "examples": { "Invalid request body": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Object value found, but an array is required", "property": "" } ], "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "$ref": "#/components/schemas/422-invalid-request" } } }, "description": "The request cannot be processed. Request body failed validation." }, "Virtual-Items-Currency_200-admin-get-item": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel" }, "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } }, { "external_id": "weapon", "name": { "en": "weapon" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel" }, "media_list": [], "name": { "en": "Sword Xsolla Skin" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.swords_1", "type": "virtual_good", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" } } }, "description": "指定された仮想アイテムは正常に受信されました。" }, "Virtual-Items-Currency_200-admin-get-virtual-currencies": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Main in-game currency" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Crystals", "ru": "Crystals" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "vc_prices": [] }, { "attributes": [], "description": { "en": "Money for in-store purchases" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Gold", "ru": "Gold" }, "order": 1, "periods": [], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_1", "type": "virtual_currency", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency" }, "type": "array" } }, "type": "object" } } }, "description": "仮想通貨のリストは正常に受信されました。" }, "Virtual-Items-Currency_200-admin-get-virtual-currency": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Main in-game currency" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Crystals", "ru": "Crystals" }, "order": 1, "periods": [], "prices": [ { "amount": 1, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency" } } }, "description": "指定された仮想通貨は正常に受信されました。" }, "Virtual-Items-Currency_200-admin-get-virtual-currency-package": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 100, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Crystals x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Small crystal pack" }, "order": 1, "periods": [], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "vc_prices": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package" } } }, "description": "指定された仮想通貨パッケージは正常に受信されました。" }, "Virtual-Items-Currency_200-admin-get-virtual-currency-packages": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 100, "sku": "com.xsolla.crystal_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Crystals x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/a8682cea328afda0bd127d59eb5b9077.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Small crystal pack" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 500, "sku": "com.xsolla.crystal_2", "type": "virtual_currency" } ], "description": { "en": "Crystals x500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/431a40dd8c99290dd761508964ddbacf.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium crystal pack" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_2", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Main in-game currency" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "name": { "en": "Crystals", "ru": "Crystals" }, "quantity": 1500, "sku": "com.xsolla.crystal_3", "type": "virtual_currency" } ], "description": { "en": "Crystals x1500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/1d67a1d2f92d69e021a97effa692dff3.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Massive crystal pack" }, "order": 1, "periods": [], "prices": [ { "amount": 50, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.crystal_pack_3", "type": "bundle", "vc_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 100, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "description": { "en": "Gold x100" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/09984ff0a3ae6b367c9c886b31366950.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Small gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_1", "type": "bundle", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 500, "sku": "com.xsolla.gold_2", "type": "virtual_currency" } ], "description": { "en": "Gold x500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b5d8130bdaf28aa55c43a68aa3ca0ef4.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Medium gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 20, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_2", "type": "bundle", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "bundle_type": "virtual_currency_package", "content": [ { "description": { "en": "Money for in-store purchases" }, "image_url": "https://cdn3.xsolla.com/img/misc/images/bc1bf2bdeca78515d5d15e545d6884be.png", "name": { "en": "Gold", "ru": "Gold" }, "quantity": 1500, "sku": "com.xsolla.gold_3", "type": "virtual_currency" } ], "description": { "en": "Gold x1500" }, "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/dea74a3667807d5502a4acb8f4c879ca.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": null, "media_list": [], "name": { "en": "Large gold pack" }, "order": 1, "periods": [], "prices": [ { "amount": 50, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.gold_pack_3", "type": "bundle", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-currency-package" }, "type": "array" } }, "type": "object" } } }, "description": "仮想通貨パッケージのリストは正常に受信されました。" }, "Virtual-Items-Currency_200-admin-get-virtual-items": { "content": { "application/json": { "example": { "items": [ { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Suit up with flair showcasing your allegiance to Xsolla" }, "groups": [ { "external_id": "featured", "name": { "en": "featured" } }, { "external_id": "Xsolla", "name": { "en": "Xsolla" } }, { "external_id": "Premium", "name": { "en": "Premium" } }, { "external_id": "NonConsumableGroupCode", "name": { "en": "Non-consumable" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": null, "recurrent_schedule": null }, "long_description": { "en": "The metal coverings formerly worn by soldiers or warriors to protect the body in battle." }, "media_list": [], "name": { "en": "Maximum Armor Xsolla Skin" }, "order": 1, "periods": [], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "A strong armor forged to withstand heavy attacks." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Maximum Armor" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "Moderately protect yourself against the Empires barrage of attacks" }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "Xsolla", "name": { "en": "Xsolla" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png", "is_enabled": true, "is_free": false, "is_show_in_store": false, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises." }, "media_list": [], "name": { "en": "Xsolla Medium Armor" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Medium Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "all", "name": { "en": "Equipment" } }, { "external_id": "equipment", "name": { "en": "Nice Equipment" } }, { "external_id": "Empire", "name": { "en": "Empire" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "hours_interval": 8, "interval_type": "hourly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Large Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_large_3", "type": "virtual_good", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" }, "type": "array" } }, "type": "object" } } }, "description": "仮想アイテムのリストは正常に受信されました。" }, "Virtual-Items-Currency_200-admin-get-virtual-items-by-group": { "content": { "application/json": { "example": { "items": [ { "attributes": [], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "A strong armor forged to withstand heavy attacks" }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/67d647ad4f4e9a905bd552b0408db8a8.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "day_of_month": 28, "day_of_week": null, "displayable_reset_next_date": "2023-03-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "monthly", "reset_next_date": 1679972400, "time": "11:00:00+08:00" } } }, "long_description": null, "media_list": [], "name": { "en": "Empire Maximum Armor" }, "order": 1, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 12.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_max_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [], "description": { "en": "Moderately protect yourself against the Empires barrage of attacks" }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/7f6e216f8fcc3c1796162897c2b0db01.png", "is_enabled": true, "is_free": false, "is_show_in_store": false, "limits": { "per_item": null, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "Armor is a security-as-a-service company that provides cloud security and compliance solutions for small businesses and enterprises." }, "media_list": [], "name": { "en": "Xsolla Medium Armor" }, "order": 1, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "country_iso": "CZ", "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_1", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "interval_type": "daily", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Medium Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_med_2", "type": "virtual_good", "vc_prices": [] }, { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": { "en-US": "VALUE" } }, { "external_id": "val2", "value": { "en-US": "VALUE2" } } ] } ], "description": { "en": "Provides moderate protection in battle." }, "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } }, { "external_id": "accessory", "name": { "en": "Accessory" } } ], "image_url": "https://cdn.xsolla.net/img/misc/images/737b4c93205dc774f47dda1f73037734.png", "is_enabled": true, "is_free": false, "is_show_in_store": true, "limits": { "per_item": { "available": 455, "reserved": 5, "sold": 40, "total": 500 }, "per_user": { "limit_exceeded_visibility": "show", "total": 5 }, "recurrent_schedule": { "per_user": { "displayable_reset_next_date": "2023-02-28T11:00:00+08:00", "displayable_reset_start_date": "2023-02-28T11:00:00+08:00", "hours_interval": 8, "interval_type": "hourly", "reset_next_date": 1677553200, "time": "11:00:00+08:00" } } }, "long_description": { "en": "A strong armor forged to withstand heavy attacks." }, "media_list": [], "name": { "en": "Empire Large Armor" }, "order": 1, "periods": [], "prices": [ { "amount": 4.99, "currency": "USD", "is_default": true, "is_enabled": true }, { "amount": 20.99, "currency": "CZK", "is_default": false, "is_enabled": true } ], "regions": [], "sku": "com.xsolla.armor_lrg_2", "type": "virtual_good", "vc_prices": [] } ] }, "schema": { "properties": { "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-virtual-item" }, "type": "array" } }, "type": "object" } } }, "description": "仮想アイテムのリストは正常に受信されました。" }, "Virtual-Items-Currency_200-get-all-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "items": [ { "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": { "en": "Accessory" } } ], "name": "Big Rocket", "sku": "com.xsolla.big_rocket_1" }, { "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1" }, { "description": "description", "groups": [], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_2" } ] } } }, "schema": { "description": "仮想アイテムを持つオブジェクト。", "properties": { "items": { "example": [ { "description": "Big Rocket - description", "groups": [ { "external_id": "accessory", "name": { "en": "accessory" } } ], "name": "Big Rocket", "sku": "com.xsolla.big_rocket_1" }, { "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "Weapons" } } ], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1" }, { "description": "description", "groups": [], "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_2" } ], "items": { "properties": { "description": { "description": "アイテムの説明。", "example": "Big Rocket - description", "type": "string" }, "groups": { "properties": { "external_id": { "example": "weapons", "type": "string" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "type": "object" } }, "type": "array" }, "name": { "description": "アイテム名。", "example": "Big Rocket", "type": "string" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "com.xsolla.big_rocket_1", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "すべての仮想アイテムのリストは正常に受信されました。" }, "Virtual-Items-Currency_200-get-item-by-sku": { "content": { "application/json": { "example": { "attributes": [ { "external_id": "attr_1", "name": { "en-US": "OK" }, "values": [ { "external_id": "val1", "value": "VALUE" }, { "external_id": "val2", "value": "VALUE2" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Honshu Boshin Wakizashi - Modern Tactical Samurai / Ninja Sword - Hand Forged 1060 Carbon Steel - Full Tang, Fully Functional, Battle Ready - Black TPR, Steel Guard and Pommel" }, "groups": [ { "external_id": "weapons", "name": "weapons" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/8ab44fe99038a56de01950ba4a971b77.png", "is_free": false, "item_id": 488833, "limits": { "per_item": null, "per_user": { "available": 1, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1761840000 }, "total": 3 } }, "name": { "en": "Sword Xsolla Skin" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.swords_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [], "vp_rewards": [] }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_item" } } }, "description": "仮想アイテムは正常に受信されました。" }, "Virtual-Items-Currency_200-get-items-by-group-id": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Big Rocket - description", "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": { "en": "Rating" }, "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "item_order_in_group": 2, "name": "weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ], "vp_rewards": [] } ] } } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] } ], "can_be_bought": true, "description": "Big Rocket - description", "groups": [ { "external_id": "weapons", "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_item": null, "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ] }, { "attributes": [ { "external_id": "stack_size", "name": "Stack size", "values": [ { "value": "5" } ] }, { "external_id": "rating", "name": "Rating", "values": [ { "value": "3.9" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "value": "Strategy" }, { "value": "Tactical" }, "Turn-based" ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "name": { "en": "weapons" } } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "アイテムの説明。", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "アイテム名。", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "アイテムタイプ：`consumable`/`expiration`/`permanent`/`lootboxes`/`physical`。", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non_consumable", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "指定されたグループのリストは正常に受信されました。" }, "Virtual-Items-Currency_200-get-items-groups": { "content": { "application/json": { "examples": { "response": { "value": { "groups": [ { "description": "All weapons available in the game", "external_id": "weapons", "image_url": "https://example.com/groups/weapons.png", "name": "Weapons", "order": 1 }, { "description": "Protective equipment", "external_id": "armor", "image_url": "https://example.com/groups/armor.png", "name": "Armor", "order": 2 }, { "description": "Potions, food, and other single-use items", "external_id": "consumables", "image_url": null, "name": "Consumables", "order": 3 } ] } } }, "schema": { "properties": { "groups": { "example": [ { "description": "All weapons available in the game", "external_id": "weapons", "image_url": null, "name": "Weapons", "order": 1 }, { "description": "Super description", "external_id": "group_external_id", "image_url": null, "name": "Super", "order": 1 } ], "items": { "properties": { "children": { "description": "子供グループ。", "example": [ { "children": [ { "children": [], "description": "Accessory", "external_id": "accessory", "image_url": null, "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "description": "Background description", "external_id": "background", "image_url": null, "level": 1, "name": "Background", "order": 1, "parent_external_id": "weapons" } ], "items": { "properties": { "children": { "description": "子供グループ。", "example": [ { "children": [], "description": "Accessory", "external_id": "accessory", "image_url": null, "level": 2, "name": "Accessory", "order": 1, "parent_external_id": "background" } ], "items": { "properties": { "children": { "description": "子供グループ。", "example": [], "items": { "type": "string" }, "type": "array" }, "description": { "description": "グループの説明。", "example": "Accessory", "type": "string" }, "external_id": { "description": "外部グループID。", "example": "accessory", "type": "string" }, "image_url": { "description": "画像URL。", "example": null, "type": [ "string", "null" ] }, "level": { "description": "グループのネスティングレベル。", "example": 2, "type": "integer" }, "name": { "description": "グループ名。", "example": "Accessory", "type": "string" }, "order": { "description": "配列順序を定義します。", "example": 1, "type": "integer" }, "parent_external_id": { "description": "親外部グループID。", "example": "background", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "description": { "description": "グループの説明。", "example": "Background description", "type": "string" }, "external_id": { "description": "外部グループID。", "example": "background", "type": "string" }, "image_url": { "description": "グループ画像のURL。", "example": null, "type": [ "string", "null" ] }, "level": { "description": "グループのネスティングレベル。", "example": 1, "type": "integer" }, "name": { "description": "グループ名。", "example": "Background", "type": "string" }, "order": { "description": "配列順序を定義します。", "example": 1, "type": "integer" }, "parent_external_id": { "description": "親外部グループID。", "example": "weapons", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "description": { "description": "グループの説明。", "example": "All weapons available in the game", "type": "string" }, "external_id": { "description": "外部グループID。", "example": "weapons", "type": "string" }, "image_url": { "description": "画像URL。", "example": null, "type": [ "string", "null" ] }, "level": { "description": "グループのネスティングレベル。", "example": 0, "type": "integer" }, "name": { "description": "グループ名。", "example": "Weapons", "type": "string" }, "order": { "description": "配列順序を定義します。", "example": 1, "type": "integer" }, "parent_external_id": { "description": "親外部グループID。", "example": null, "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "グループのリストは正常に受信されました。" }, "Virtual-Items-Currency_200-get-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": { "en": "Big Rocket - description" }, "groups": [ { "external_id": "accessory", "item_order_in_group": 1, "name": "accessory" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": { "en": "Big Rocket" }, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" }, { "quantity": 1, "sku": "com.xsolla.phys_good_1", "type": "physical_good" }, { "bundle_type": "standard", "image_url": "https://cdn.xsolla.net/img/misc/images/9676f06265375087e607cb79c5283688.png", "name": "Super Lootbox with items", "quantity": 1, "sku": "com.xsolla.SuperLootboxBundle_1", "type": "bundle" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": null, "name": "Bonus promotion" } ], "sku": "com.xsolla.big_rocket_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": { "en": "Rating" }, "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "can_be_bought": true, "description": { "en": "description" }, "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "Weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": { "en": "SHOTGUN FOR TRUE RAIDERS" }, "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "description": "description", "image_url": "http://image.png", "is_default": false, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.vc_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": { "en": "description" }, "groups": [], "image_url": "http://image.png", "is_free": true, "limits": null, "name": { "en": "SHOTGUN FOR TRUE RAIDERS" }, "periods": [], "price": null, "promotions": [], "sku": "com.xsolla.shotgun_raider_2", "type": "virtual_good", "virtual_item_type": "non_renewing_subscription", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_item-list" } } }, "description": "仮想アイテムのリストは正常に受信されました。" }, "Virtual-Items-Currency_200-get-virtual-currency": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "attr1", "name": { "en-US": "Attribute" }, "values": [ { "external_id": "val1", "value": "Value" }, { "external_id": "val2", "value": "Value" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Crystals - short description", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "is_free": false, "item_id": 451414, "limits": null, "name": "Crystals", "periods": [ { "date_from": "2023-08-11T10:00:00+03:00", "date_until": "2023-08-11T20:00:00+03:00" } ], "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.crystal_1", "type": "virtual_currency", "virtual_prices": [] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency" } } }, "description": "仮想通貨は正常に受信されました。" }, "Virtual-Items-Currency_200-get-virtual-currency-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] } ], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Big Rocket - short description", "groups": [ { "external_id": "weapons", "item_order_in_group": 1, "name": "weapons" } ], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "limits": null, "name": "Big Rocket", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100.99", "amount_without_discount": "100.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency", "virtual_prices": [ { "amount": 100, "amount_without_discount": 100, "description": "description", "image_url": "http://image.png", "is_default": true, "name": "SHOTGUN FOR TRUE RAIDERS", "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [ { "external_id": "stack_size", "name": { "en": "Stack size" }, "values": [ { "external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85", "value": "5" } ] }, { "external_id": "rating", "name": { "en": "Rating" }, "values": [ { "external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85", "value": "3.9" } ] } ], "can_be_bought": true, "description": "description", "groups": [ { "external_id": "weapons", "item_order_in_group": 2, "name": "weapons" } ], "image_url": "http://image.png", "is_free": false, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "101.0", "amount_without_discount": "101.0", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.shotgun_raider_2", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "description", "groups": [], "image_url": "http://image.png", "is_free": true, "limits": null, "name": "SHOTGUN FOR TRUE RAIDERS", "periods": [], "price": null, "promotions": [], "sku": "com.xsolla.shotgun_raider_3", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-list" } } }, "description": "仮想通貨リストは正常に受信されました。" }, "Virtual-Items-Currency_200-get-virtual-currency-package": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "Crystal - short description", "image_url": "https://cdn3.xsolla.com/img/misc/images/da33ab6cc1d7e5899cfdc5b6b6180fad.png", "item_id": 488831, "limits": null, "name": "Crystals", "quantity": 10, "sku": "com.xsolla.crystals_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Crystal Pack Short Description", "groups": [], "image_url": "http://vc_package_image.png", "is_free": false, "item_id": 488832, "limits": { "per_item": null, "per_user": { "available": 1, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1690732800 }, "total": 1 } }, "name": "Crystal Pack", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "100", "amount_without_discount": "100", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.crystal_pack_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package" } } }, "description": "仮想通貨パッケージは正常に受信されました。" }, "Virtual-Items-Currency_200-get-virtual-currency-packages-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "Big Rocket - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "name": "Big Rocket", "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency" } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "VC Short Package Description", "groups": [ { "external_id": "gift", "item_order_in_group": 1, "name": "Gift" } ], "image_url": "http://vc_package_image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "VC Name first package", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "2.0000", "amount_without_discount": "2.0000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.vc_package_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "description", "image_url": "http://image.png", "name": "SHOTGUN FOR TRUE RAIDERS", "quantity": 200, "sku": "com.xsolla.shotgun_raider_1", "type": "virtual_currency" } ], "description": "VC Short Package Description", "groups": [ { "external_id": "gift", "item_order_in_group": 2, "name": "Gift" } ], "image_url": "http://vc_package_image.png", "is_free": false, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "VC Name third package", "periods": [ { "date_from": null, "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "4.0000", "amount_without_discount": "4.0000", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.vc_package_3", "type": "bundle", "virtual_prices": [], "vp_rewards": [] } ] } } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-packages" } } }, "description": "仮想通貨パッケージのリストは正常に受信されました。" }, "Virtual-Items-Currency_200-quick-purchase": { "content": { "application/json": { "examples": { "response": { "value": { "order_id": 641 } } }, "schema": { "properties": { "order_id": { "description": "注文ID。", "type": "integer" } }, "type": "object" } } }, "description": "迅速な仮想購入に成功しました。" }, "Virtual-Items-Currency_201-created": { "content": { "application/json": { "examples": { "response": { "value": { "sku": "com.xsolla.item_1" } } }, "schema": { "example": { "sku": "com.xsolla.item_1" }, "properties": { "sku": { "example": "new-sku", "type": "string" } }, "type": "object" } } }, "description": "仮想アイテムは正常に作成されました。" }, "Virtual-Items-Currency_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": "基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。" }, "Virtual-Items-Currency_404-item": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_12222 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "アイテムが見つかりませんでした。`project_id`と`item_sku`が正しいことを確認してください。" }, "Virtual-Items-Currency_404-item-group": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4403, "errorMessage": "[0401-4403]: Item group not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4403, "type": "integer" }, "errorMessage": { "example": "[0401-4403]: Item group not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "グループが見つかりませんでした。`external_id`が正しく、グループがオフになったり削除されたりしていないことを確認してください。" }, "Virtual-Items-Currency_422-invalid-request": { "content": { "application/json": { "examples": { "Custom attributes JSON can’t exceed 500 characters": { "$ref": "#/components/examples/422-custom-attributes-size-exceeded" }, "Numbers of attribute values per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attribute-values-per-item-exceeded" }, "Numbers of attributes per item exceeded": { "$ref": "#/components/examples/422-numbers-of-attributes-per-item-exceeded" }, "The property `sku` is required": { "$ref": "#/components/examples/422-property-sku-is-required" }, "Value limit exceeded": { "$ref": "#/components/examples/422-value-limit-exceeded" } }, "schema": { "$ref": "#/components/schemas/Virtual-Items-Currency_422-invalid-request" } } }, "description": "無効なリクエストです。" }, "Virtual-Items-Currency_422-not-enough-virtual-currency": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 5006, "errorMessage": "[0401-5006]: Not enough virtual currency", "statusCode": 422 } } }, "schema": { "properties": { "errorCode": { "example": 5006, "type": "integer" }, "errorMessage": { "example": "[0401-5006]: Not enough virtual currency", "type": "string" }, "statusCode": { "example": 422, "type": "integer" } }, "type": "object" } } }, "description": "十分な仮想通貨がありません。" }, "connector-422-validation-failed": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 1803, "errorMessage": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain", "statusCode": 422, "transactionId": "x-x-x-x-transactionId-mock-x-x-x" } } }, "schema": { "properties": { "errorCode": { "example": 1803, "type": "integer" }, "errorMessage": { "example": "[0410-1803]: File content-type doesn't allowed. Allowed content types: application/json; current content type: text/plain", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "リクエスト本文、ファイルプロパティ、またはファイルコンテンツのパラメータが正しくないために発生する検証エラー。" }, "sellable-item-by-id_404": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 259774 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "アイテムが見つかりません。`project_id`と`item_id`が正しいことを確認してください。" }, "sellable-item-by-sku_404": { "content": { "application/json": { "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'electric_shiel' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "アイテムが見つかりません。`project_id`と`sku`が正しいことを確認してください。" }, "sellable_items_200-get-item-by-id": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 10, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } } }, "schema": { "description": "販売可能なアイテムを持つオブジェクト。", "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "description": "`true`の場合、ユーザーはアイテムを購入することができます。", "example": true, "type": "boolean" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "アイテムの説明。", "example": "Electric shield", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "アイテム名。", "example": "Electric shield", "type": "string" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "9.99", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "electric_shield", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`。", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "仮想通貨の説明。", "example": null, "type": [ "string", "null" ] }, "image_url": { "description": "仮想通貨のイメージ。", "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 259774, "type": "integer" }, "name": { "description": "仮想通貨名。", "example": "Gold", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "gold", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" } } }, "description": "販売可能なアイテムが正常に受信されました。" }, "sellable_items_200-get-items-by-group-id": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": true, "items": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 1, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shields_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "item_order_in_group": 2, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 3, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 4, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "limits": { "per_user": { "available": 3, "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.wooden_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] } ] } } }, "schema": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_1", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_1", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "clan_value_point_sku_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_4", "type": "virtual_currency" } ], "vp_rewards": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "description": "`true`の場合、ユーザーはアイテムを購入することができます。", "example": true, "type": "boolean" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "アイテムの説明。", "example": "Electric shield", "type": [ "string", "null" ] }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "アイテム名。", "example": "Electric shield", "type": "string" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "9.99", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "com.xsolla.electric_shield_1", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`。", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non_consumable", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "仮想通貨の説明。", "example": null, "type": [ "string", "null" ] }, "image_url": { "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 259774, "type": "integer" }, "name": { "description": "仮想通貨名。", "example": "Gold", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "com.xsolla.gold_1", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "指定されたグループの販売可能なアイテムのリストは正常に受信されました。" }, "sellable_items_200-get-items-list": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_free": false, "item_id": 259765, "limits": null, "name": "Gold", "price": { "amount": "1.00", "amount_without_discount": "1.00", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.gold_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_free": false, "item_id": 259766, "name": "Silver", "price": { "amount": "0.50", "amount_without_discount": "0.50", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.silver_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_free": false, "item_id": 259767, "name": "Bronze", "price": { "amount": "0.10", "amount_without_discount": "0.10", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "name": "Gold", "quantity": 10, "sku": "com.xsolla.gold_2", "type": "virtual_currency" } ], "description": "Chest of gold", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png", "is_free": false, "item_id": 259768, "name": "Chest of gold", "price": { "amount": "7.99", "amount_without_discount": "7.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.gold_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_2", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.silver_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_1", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.bronze_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Sword", "groups": [ { "external_id": "swords", "item_order_in_group": 1, "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png", "is_free": false, "item_id": 259771, "name": "Sword", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.sword_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 50, "amount_without_discount": 50, "calculated_price": { "amount": "50.00", "amount_without_discount": "50.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "item_order_in_group": 2, "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Bow", "groups": [ { "external_id": "bows", "item_order_in_group": 1, "name": "Bows" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png", "is_free": false, "item_id": 259773, "name": "Bow", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.bow_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 100, "amount_without_discount": 100, "calculated_price": { "amount": "100.00", "amount_without_discount": "100.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "item_order_in_group": 1, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_5", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_5", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "item_order_in_group": 2, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.royal_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_6", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_6", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_6", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 3, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_7", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_7", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_7", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "item_order_in_group": 4, "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_8", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_8", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_8", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_10", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_10", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_10", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "quantity": 1, "sku": "com.xsolla.ancient_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_11", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_11", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ] } ], "description": "Chest of armour", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png", "is_free": false, "item_id": 259778, "name": "Chest of armor", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.armor_chest_1", "total_content_price": { "amount": "11.98", "amount_without_discount": "11.98", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_9", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_9", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_9", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_13", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_13", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_13", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "promotions": [], "quantity": 10, "sku": "com.xsolla.silver_chest_2", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "promotions": [], "quantity": 100, "sku": "com.xsolla.bronze_chest_2", "type": "bundle", "virtual_prices": [] } ], "description": "Treasure Chest", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png", "is_free": false, "item_id": 259779, "name": "Treasure Chest", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { "bonus": [ { "image_url": "https://cdn.xsolla.net/img/misc/images/2fc5c491a47413a8e8000447889093c2.png", "name": "Xsolla Minigun", "quantity": 1, "sku": "com.xsolla.minigun_1", "type": "virtual_good" } ], "date_end": "2026-04-15T16:16:00+03:00", "date_start": "2020-04-15T16:16:00+03:00", "discount": { "percent": "50.00" }, "name": "Bonus promotion" } ], "sku": "com.xsolla.treasure_chest_1", "total_content_price": { "amount": "802.89", "amount_without_discount": "802.89", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_12", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_12", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_12", "type": "virtual_currency" } ], "vp_rewards": [] } ] } } }, "schema": { "description": "販売可能なアイテムを持つオブジェクト。", "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "example": [ { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_free": false, "item_id": 259765, "limits": { "per_user": { "available": 3, "limit_exceeded_visibility": "show", "recurrent_schedule": { "interval_type": "weekly", "reset_next_date": 1746057600 }, "total": 5 } }, "name": "Gold", "price": { "amount": "1.00", "amount_without_discount": "1.00", "currency": "USD" }, "sku": "com.xsolla.gold_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_free": false, "item_id": 259766, "limits": null, "name": "Silver", "price": { "amount": "0.50", "amount_without_discount": "0.50", "currency": "USD" }, "sku": "com.xsolla.silver_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_free": false, "item_id": 259767, "limits": null, "name": "Bronze", "price": { "amount": "0.10", "amount_without_discount": "0.10", "currency": "USD" }, "sku": "com.xsolla.bronze_1", "type": "virtual_currency", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": null, "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "item_id": 259765, "name": "Gold", "quantity": 10, "sku": "com.xsolla.gold_1", "type": "virtual_currency" } ], "description": "Chest of gold", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/61b8d0785093017ce1f50ebed55c42a9.png", "is_free": false, "item_id": 259768, "limits": null, "name": "Chest of gold", "price": { "amount": "7.99", "amount_without_discount": "7.99", "currency": "USD" }, "sku": "com.xsolla.gold_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_1", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "limits": null, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.silver_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "limits": null, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "sku": "com.xsolla.bronze_chest_1", "type": "bundle", "virtual_prices": [], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Sword", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/a558727a420cad609556e4449b9ecb12.png", "is_free": false, "item_id": 259771, "limits": null, "name": "Sword", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "sku": "com.xsolla.sword_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_2", "type": "virtual_currency" }, { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_2", "type": "virtual_currency" }, { "amount": 50, "amount_without_discount": 50, "calculated_price": { "amount": "50.00", "amount_without_discount": "50.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_2", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "limits": null, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "sku": "com.xsolla.saber_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_3", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_3", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_3", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Bow", "groups": [ { "external_id": "bows", "name": "Bows" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/3bb3b0a5254ad15134c891108898363f.png", "is_free": false, "item_id": 259773, "limits": null, "name": "Bow", "price": { "amount": "4.99", "amount_without_discount": "4.99", "currency": "USD" }, "sku": "com.xsolla.bow_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 5, "amount_without_discount": 5, "calculated_price": { "amount": "5.00", "amount_without_discount": "5.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_4", "type": "virtual_currency" }, { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_4", "type": "virtual_currency" }, { "amount": 100, "amount_without_discount": 100, "calculated_price": { "amount": "100.00", "amount_without_discount": "100.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_4", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_5", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_5", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_5", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Royal shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/ed417975312a52efeeab8b039ff25cb1.png", "is_free": false, "item_id": 259775, "name": "Royal shield", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.royal_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_6", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_6", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_6", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "sku": "com.xsolla.ancient_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_7", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_7", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_7", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "can_be_bought": true, "description": "Wooden helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/40d2812e52ad9d988ac20fc842fc66f0.png", "is_free": false, "item_id": 259777, "name": "Wooden helmet", "price": { "amount": "0.99", "amount_without_discount": "0.99", "currency": "USD" }, "sku": "com.xsolla.wooden_helmet_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 1, "amount_without_discount": 1, "calculated_price": { "amount": "1.00", "amount_without_discount": "1.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_8", "type": "virtual_currency" }, { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_8", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_8", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Electric shield", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.electric_shield_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_10", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_10", "type": "virtual_currency" }, { "amount": 200, "amount_without_discount": 200, "calculated_price": { "amount": "200.00", "amount_without_discount": "200.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_10", "type": "virtual_currency" } ] }, { "attributes": [], "can_be_bought": true, "description": "Ancient helmet", "groups": [ { "external_id": "armour", "name": "Armour" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/e70e16d9626f435e519fc8e1cc1e7176.png", "is_free": false, "item_id": 259776, "name": "Ancient helmet", "price": { "amount": "1.99", "amount_without_discount": "1.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.ancient_helmet_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 2, "amount_without_discount": 2, "calculated_price": { "amount": "2.00", "amount_without_discount": "2.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_11", "type": "virtual_currency" }, { "amount": 4, "amount_without_discount": 4, "calculated_price": { "amount": "4.00", "amount_without_discount": "4.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_11", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ] } ], "description": "Chest of armour", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/5212202f9b8c9dbd254652d6cbeba03e.png", "is_free": false, "item_id": 259778, "name": "Chest of armor", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "sku": "com.xsolla.armor_chest_1", "total_content_price": { "amount": "11.98", "amount_without_discount": "11.98", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_9", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_9", "type": "virtual_currency" }, { "amount": 400, "amount_without_discount": 400, "calculated_price": { "amount": "400.00", "amount_without_discount": "400.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_9", "type": "virtual_currency" } ], "vp_rewards": [] }, { "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { "attributes": [], "can_be_bought": true, "description": "Saber", "groups": [ { "external_id": "swords", "name": "Swords" } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/edd914d60301d77b94926478d253fcb6.png", "is_free": false, "item_id": 259772, "name": "Saber", "price": { "amount": "3.99", "amount_without_discount": "3.99", "currency": "USD" }, "quantity": 1, "sku": "com.xsolla.saber_2", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { "amount": 3, "amount_without_discount": 3, "calculated_price": { "amount": "3.00", "amount_without_discount": "3.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_13", "type": "virtual_currency" }, { "amount": 7, "amount_without_discount": 7, "calculated_price": { "amount": "7.00", "amount_without_discount": "7.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_13", "type": "virtual_currency" }, { "amount": 70, "amount_without_discount": 70, "calculated_price": { "amount": "70.00", "amount_without_discount": "70.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_13", "type": "virtual_currency" } ] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "item_id": 259766, "name": "Silver", "quantity": 50, "sku": "com.xsolla.silver_14", "type": "virtual_currency" } ], "description": "Chest of silver", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/f0b59a3370404e8881107249051b70bd.png", "is_free": false, "item_id": 259769, "name": "Chest of silver", "price": { "amount": "19.99", "amount_without_discount": "19.99", "currency": "USD" }, "quantity": 10, "sku": "com.xsolla.silver_chest_2", "type": "bundle", "virtual_prices": [] }, { "attributes": [], "bundle_type": "virtual_currency_package", "can_be_bought": true, "content": [ { "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "item_id": 259767, "name": "Bronze", "quantity": 100, "sku": "com.xsolla.bronze_11", "type": "virtual_currency" } ], "description": "Chest of bronze", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/b32eb5b1f4f0c202ea6ac4e21c2eae18.png", "is_free": false, "item_id": 259770, "name": "Chest of bronze", "price": { "amount": "5.99", "amount_without_discount": "5.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.bronze_chest_2", "type": "bundle", "virtual_prices": [] } ], "description": "Treasure Chest", "groups": [], "image_url": "https://cdn3.xsolla.com/img/misc/images/7b1c0136d91398f9ab17924deee5eeec.png", "is_free": false, "item_id": 259779, "name": "Treasure Chest", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "sku": "com.xsolla.treasure_chest_1", "total_content_price": { "amount": "802.89", "amount_without_discount": "802.89", "currency": "USD" }, "type": "bundle", "virtual_prices": [ { "amount": 10, "amount_without_discount": 10, "calculated_price": { "amount": "10.00", "amount_without_discount": "10.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "is_default": true, "item_id": 259765, "name": "Gold", "sku": "com.xsolla.gold_12", "type": "virtual_currency" }, { "amount": 20, "amount_without_discount": 20, "calculated_price": { "amount": "20.00", "amount_without_discount": "20.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/015e4f4ea4deb1e2c92d5c21a4d58309.png", "is_default": false, "item_id": 259766, "name": "Silver", "sku": "com.xsolla.silver_12", "type": "virtual_currency" }, { "amount": 40, "amount_without_discount": 40, "calculated_price": { "amount": "40.00", "amount_without_discount": "40.00" }, "description": "", "image_url": "https://cdn3.xsolla.com/img/misc/images/b0beedd5763b612bd3a5631e6cb1d1ff.png", "is_default": false, "item_id": 259767, "name": "Bronze", "sku": "com.xsolla.bronze_12", "type": "virtual_currency" } ], "vp_rewards": [] } ], "items": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "bundle_type": { "description": "バンドルタイプ。アイテムタイプがバンドルの場合に返されます。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "can_be_bought": { "description": "`true`の場合、ユーザーはアイテムを購入することができます。", "example": true, "type": "boolean" }, "content": { "items": { "items": { "$ref": "#/components/schemas/Bundles_client_content" }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "アイテムの説明。", "example": "Electric shield", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 259774, "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "アイテム名。", "example": "Electric shield", "type": "string" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "9.99", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "9.99", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "com.xsolla.electric_shield_1", "type": "string" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`/`game_key`/`physical_good`。", "enum": [ "virtual_good", "virtual_currency", "bundle", "game_key", "physical_good" ], "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 10, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 10, "type": "integer" }, "calculated_price": { "properties": { "amount": { "type": "string" }, "amount_without_discount": { "type": "string" } }, "type": "object" }, "description": { "description": "仮想通貨の説明。", "example": null, "type": [ "string", "null" ] }, "image_url": { "description": "仮想通貨のイメージ。", "example": "https://cdn3.xsolla.com/img/misc/images/e2e9ce8b00eb0190c161c4258b899101.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "item_id": { "description": "アイテム作成時に付与される内部一意のアイテムID。", "example": 259774, "type": "integer" }, "name": { "description": "仮想通貨名。", "example": "Gold", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "com.xsolla.gold_1", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "販売可能なアイテムのリストは正常に受信されました。" } }, "schemas": { "404-not-found": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0000-0000]: Entity not found", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "422-invalid-request": { "properties": { "errorCode": { "description": "エラーコード。", "example": 1102, "type": "integer" }, "errorMessage": { "description": "Short error description.", "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "$ref": "#/components/schemas/error-message-extended-validation" }, "statusCode": { "description": "HTTP response status.", "example": 422, "type": "integer" }, "transactionId": { "description": "Request ID. The ID used to track and associate log entries related to this specific request or operation. This ID can be helpful for troubleshooting, debugging, and auditing purposes.", "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "required": [ "statusCode", "errorCode", "errorMessage", "transactionId" ], "type": "object" }, "422-invalid-request-2": { "properties": { "errorCode": { "description": "エラーコード。", "example": 1102, "type": "number" }, "errorMessage": { "description": "読み取り可能なエラーメッセージ。", "example": "[0401-1102]: Unprocessable Entity. The property `external_id` is required", "type": "string" }, "statusCode": { "description": "応答状態コード。", "example": 422, "type": "number" }, "transactionId": { "description": "リクエストの一意ID。", "example": "da145238620011eb8e24fe6913ff226a", "type": "string" } }, "type": "object" }, "Bundles_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Bundles_admin-attributes": { "description": "属性リスト。", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Bundles_admin-post-put-attributes": { "description": "属性のリスト。\n
注意。アイテムの属性は20個以上指定することはできません。制限を超えようとすると、エラーが発生します。
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" }, "maxItems": 20, "type": "array" }, "Bundles_admin-regions": { "items": { "properties": { "id": { "example": 1, "minimum": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Bundles_admin-response-virtual_price": { "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_default": { "$ref": "#/components/schemas/Bundles_currency-is_default" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "type": { "$ref": "#/components/schemas/Bundles_vc-type" } }, "type": "object" }, "Bundles_admin_bundle_request": { "description": "指定されたバンドル。", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_admin-post-put-attributes" }, "bundle_type": { "$ref": "#/components/schemas/Bundles_bundle_type" }, "content": { "$ref": "#/components/schemas/Bundles_admin_content_request" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_request" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_enabled": { "$ref": "#/components/schemas/Bundles_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Bundles_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/bundle-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_media_list" }, { "type": "null" } ] }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Bundles_prices" }, "regions": { "$ref": "#/components/schemas/Bundles_admin-regions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "vc_prices": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_vc_prices" }, { "type": "null" } ] } }, "required": [ "sku", "name", "description" ], "type": "object" }, "Bundles_admin_bundle_response": { "description": "指定されたバンドル。", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_admin-attributes" }, "bundle_type": { "$ref": "#/components/schemas/bundle_type" }, "content": { "items": { "$ref": "#/components/schemas/Bundles_admin_content_response" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_enabled": { "$ref": "#/components/schemas/Bundles_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Bundles_is_show_in_store" }, "item_id": { "$ref": "#/components/schemas/Bundles_item_id" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "anyOf": [ { "$ref": "#/components/schemas/Bundles_media_list" }, { "type": "null" } ] }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Bundles_prices" }, "regions": { "$ref": "#/components/schemas/Bundles_admin-regions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "virtual_prices": { "items": { "$ref": "#/components/schemas/Bundles_admin-response-virtual_price" }, "type": "array" } }, "type": "object" }, "Bundles_admin_content_request": { "items": { "example": { "quantity": 1, "sku": "com.xsolla.kg_1" }, "properties": { "quantity": { "default": 1, "description": "バンドル内の選択されたアイテムの数量。", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" } }, "required": [ "sku" ], "type": "object" }, "minItems": 1, "type": "array" }, "Bundles_admin_content_response": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "quantity": { "default": 1, "description": "バンドル内のアイテムタイプの数量。", "minimum": 1, "type": "integer" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "type": { "$ref": "#/components/schemas/Bundles_type" } }, "type": "object" }, "Bundles_amount": { "description": "割引を適用したアイテム価格。", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Bundles_amount_without_discount": { "description": "アイテム価格。", "example": "100.99", "pattern": "^\\d*\\.?\\d*$", "type": "string" }, "Bundles_bundle_type": { "default": "standard", "description": "バンドルタイプ。`standard`を使用してアイテムのバンドルを作成し、バンドルに含まれるアイテムの SKU を指定します。\n `partner_side_content`を使用して空のバンドルを作成し、[ウェブフック](https://developers.xsolla.com/ja/webhooks/operation/personalized-partner-catalog/)を使用してユーザー側でアイテムを追加します。このタイプは、[パートナー側でのカタログ個人用設定](https://developers.xsolla.com/ja/doc/shop-builder/features/personalization/#guides_personalization_on_partner_side)でのみ使用されます。", "enum": [ "standard", "partner_side_content" ], "example": "standard", "type": "string" }, "Bundles_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" }, "Bundles_client_bundle": { "description": "指定されたバンドル。", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "bundle_type": { "$ref": "#/components/schemas/Bundles_bundle_type" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "$ref": "#/components/schemas/Bundles_client_content" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/Bundles_client_description" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "$ref": "#/components/schemas/Bundles_image_url" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "$ref": "#/components/schemas/Bundles_item_id" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits_with_hourly" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Bundles_media_list" }, "name": { "$ref": "#/components/schemas/Bundles_client_name" }, "order": { "$ref": "#/components/schemas/Bundles_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "$ref": "#/components/schemas/Bundles_price" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "$ref": "#/components/schemas/Bundles_sku" }, "total_content_price": { "$ref": "#/components/schemas/Bundles_total_content_price" }, "type": { "$ref": "#/components/schemas/Bundles_type" }, "virtual_prices": { "$ref": "#/components/schemas/Bundles_virtual_prices" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "Bundles_client_content": { "description": "バンドルパッケージのコンテンツ。", "example": [ { "attributes": [], "description": "Big Rocket - short description.", "groups": [], "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "is_free": false, "name": "Big Rocket", "price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "quantity": 100, "sku": "com.xsolla.big_rocket_1", "type": "virtual_currency" } ], "items": { "description": "パッケージ内のアイテム。", "properties": { "attributes": { "$ref": "#/components/schemas/Bundles_client-attributes" }, "description": { "description": "アイテムの説明。", "example": "Big Rocket - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/Bundles_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits_with_hourly" }, "name": { "description": "アイテム名。", "example": "Big Rocket", "type": "string" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引を適用したアイテム価格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品価格の通貨。3文字のコード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "quantity": { "description": "パッケージ内のアイテムの数量。", "example": 250, "type": "integer" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`。", "example": "virtual_currency", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "割引を適用された仮想通貨建てのアイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "vc_test", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Bundles_client_description": { "description": "アイテムの説明。", "example": "Big Rocket - description.", "type": [ "string", "null" ] }, "Bundles_client_name": { "description": "アイテム名。", "example": "Big Rocket", "type": "string" }, "Bundles_currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" }, "Bundles_currency-is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "Bundles_groups_request": { "default": [], "description": "アイテムが属するグループ。\n
注。文字列の値はグループ `external_id`を指します。
", "example": [ "honor" ], "items": { "type": "string" }, "type": "array" }, "Bundles_groups_response": { "default": [], "description": "アイテムが所属するグループ。", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "description": "アイテム名。キーと値のペアを含める必要があり、\nキーは \"^[a-z]\" 書式のロケール{2}で、値は文字列です。", "example": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Bundles_image_url": { "description": "画像URL。", "example": "https://image.example.com", "type": [ "string", "null" ] }, "Bundles_is_enabled": { "default": true, "description": "無効の場合、アイテムを検索して購入することはできません。", "example": true, "type": "boolean" }, "Bundles_is_show_in_store": { "default": false, "description": "アイテムは購入可能です。", "example": true, "type": "boolean" }, "Bundles_item_id": { "description": "内部の一意のアイテムID。", "example": 1, "maxLength": 255, "minLength": 1, "type": "integer" }, "Bundles_media_list": { "description": "バンドルの追加アセット。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "メディアタイプ：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "リソースファイル。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "Bundles_order": { "default": 1, "description": "リスト内のバンドル順の優先順位。", "example": 1, "type": "integer" }, "Bundles_price": { "description": "アイテム価格。", "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount" }, "amount_without_discount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } }, "required": [ "amount", "amount_without_discount", "currency" ], "type": [ "object", "null" ] }, "Bundles_prices": { "description": "実際通貨建ての価格。", "items": { "properties": { "amount": { "$ref": "#/components/schemas/Bundles_amount_without_discount" }, "country_iso": { "description": "この価格が利用可能な国。[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に基づく2文字コード。", "example": "US", "type": [ "string", "null" ] }, "currency": { "$ref": "#/components/schemas/Bundles_currency" }, "is_default": { "description": "ユーザーの通貨での価格が指定されていない場合、デフォルトの価格がカタログ作成に使用されます。", "type": "boolean" }, "is_enabled": { "description": "価格が有効になりました。", "type": "boolean" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "Bundles_sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "bundle_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Bundles_total_content_price": { "description": "バンドルコンテンツ価格の合計。", "properties": { "amount": { "description": "バンドルコンテンツの価格を割引いた場合の合計。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "バンドルコンテンツ価格の合計。", "example": "100.99", "type": "string" }, "currency": { "$ref": "#/components/schemas/Bundles_currency" } }, "type": [ "object", "null" ] }, "Bundles_type": { "description": "アイテムタイプ。", "example": "bundle", "type": "string" }, "Bundles_vc-type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" }, "Bundles_vc_prices": { "items": { "properties": { "amount": { "type": "integer" }, "is_default": { "type": "boolean" }, "is_enabled": { "type": "boolean" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "gold", "type": "string" } }, "required": [ "amount", "currency", "is_default", "is_enabled" ], "type": "object" }, "type": "array" }, "Bundles_virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "割引を適用された仮想通貨建てのアイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "仮想通貨建てのアイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Most popular gold", "type": [ "string", "null" ] }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": [ "string", "null" ] }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "Gold", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "gold", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "Can_be_bought": { "description": "`true`の場合、ユーザーはアイテムを購入することができます。", "example": true, "type": "boolean" }, "Cart": { "additionalProperties": false, "properties": { "country": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従った2文字の大文字の国名コード。[エクソーラがサポートする国](https://developers.xsolla.com/ja/doc/shop-builder/references/supported-countries/)の詳細情報については、ドキュメントを確認してください。
例：`country=US`", "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "currency": { "description": "カートに表示されるアイテム価格の通貨。[ISO4217規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "items": { "items": { "properties": { "quantity": { "description": "アイテムの数量。", "example": 2, "minimum": 1, "type": "number" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "t-shirt", "minLength": 1, "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "items" ], "type": "object" }, "Cart-Payment_admin-user-request-body": { "additionalProperties": false, "properties": { "age": { "description": "ユーザーの年齢。", "type": "integer" }, "country": { "properties": { "allow_modify": { "default": false, "description": "ユーザーが決済UIで国を変更できるかどうか。", "example": false, "type": "boolean" }, "value": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従った2文字の大文字の国名コード。`X-User-Ip`ヘッダーにIPアドレスが渡されない場合は必須です。[エクソーラがサポートする国](https://developers.xsolla.com/ja/doc/shop-builder/references/supported-countries/)の詳細情報については、ドキュメントを確認してください。
例：`country=US`", "example": "US", "type": "string" } }, "type": "object" }, "email": { "properties": { "value": { "description": "ユーザーのメールアドレス。RFC822プロトコルに基づく有効である必要があります。", "format": "email", "maxLength": 255, "minLength": 3, "type": "string" } }, "type": "object" }, "id": { "properties": { "value": { "description": "ユーザーID。テストでは、任意の値を渡すことができます。実際の支払いを受け入れるには、システムのユーザーID値を使用する必要があります。このIDは[ユーザー認証](https://developers.xsolla.com/ja/webhooks/operation/user-validation/)ウェブフックで渡されます。", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "is_legal": { "description": "ユーザーが法人かを示します。", "type": "boolean" }, "legal": { "description": "法人情報を含むオブジェクトです。`user.is_legal`が`true`の場合は、オブジェクトとその全パラメーターが必要です。", "properties": { "address": { "description": "最後まで記載した法的住所です。", "type": "string" }, "country": { "description": "設立国。[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従って大文字2文字の国コードを使用します。", "type": "string" }, "name": { "description": "法人のフルネームです。", "type": "string" }, "vat_id": { "description": "納税者個別のID。", "type": "string" } }, "type": "object" }, "name": { "properties": { "value": { "description": "ユーザーのスクリーンネーム。", "maxLength": 255, "minLength": 1, "type": "string" } }, "type": "object" }, "phone": { "properties": { "allow_modify": { "default": false, "description": "ユーザーが決済UIで電話を変更できるかどうか。トークンに `phone.value` が渡された場合、デフォルトでは`false`となります。", "example": false, "type": "boolean" }, "hidden": { "default": true, "example": false, "type": "boolean" }, "value": { "description": "ユーザーの電話番号。", "type": "string" } }, "required": [ "value" ], "type": "object" }, "steam_id": { "properties": { "value": { "description": "Steam ID。", "maxLength": 17, "minLength": 17, "pattern": "^\\d{17}$", "type": "string" } }, "required": [ "value" ], "type": "object" }, "tracking_id": { "properties": { "value": { "description": "一意の追跡ID（マーケティングキャンペーンで使用）。", "maxLength": 32, "minLength": 32, "pattern": "^[A-Za-z0-9]{32}$", "type": "string" } }, "required": [ "value" ], "type": "object" } }, "required": [ "id" ], "type": "object" }, "Cart-Payment_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" }, "Cart-Payment_custom_parameters": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "array" }, { "type": "object" } ] }, "description": "キーと値のペアの有効なJSONセットとして表されたカスタムパラメータ。
\nこのフィールドを通じて追加のパラメータを渡すことで、不正対策フィルターを設定することができます。[ペイステーションに関するドキュメントンをご覧ください](https://developers.xsolla.com/ja/doc/pay-station/features/antifraud/)。", "example": { "custom_parameters": { "bool_param": true, "int_param": 100, "null_param": null, "string_param": "example" } }, "maxProperties": 200, "minProperties": 1, "type": [ "object", "null" ] }, "Cart-Payment_custom_parameters_token": { "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "boolean" }, { "type": "null" } ] }, "description": "キーと値のペアの有効なJSONセットとして表されたカスタムパラメータ。
\nこのフィールドを通じて追加のパラメータを渡すことで、不正対策フィルターを設定することができます。[ペイステーションに関するドキュメントンをご覧ください](https://developers.xsolla.com/ja/doc/pay-station/features/antifraud/)。", "example": { "custom_parameters": { "bool_param": true, "int_param": 100, "null_param": null, "number_param": 12.5, "string_param": "example" } }, "maxProperties": 200, "minProperties": 1, "type": [ "object", "null" ] }, "Cart-Payment_redirect_policy": { "properties": { "delay": { "description": "ユーザーが自動的に戻り先URLにリダイレクトされるまでの遅延期間。", "example": 0, "type": "integer" }, "redirect_button_caption": { "description": "ローカライズされたリダイレクトボタンのキャプション。", "example": "Text button", "type": "string" }, "redirect_conditions": { "description": "ユーザーがリターンURLにリダイレクトする引き金となる決済状態。", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "example": "none", "type": "string" }, "status_for_manual_redirection": { "description": "ユーザーをリターンURLにリダイレクトしてボタンクリックの表示をトリガーする決済状態。", "enum": [ "none", "successful", "successful_or_canceled", "any" ], "example": "none", "type": "string" } }, "type": "object" }, "Cart-Payment_settings_currency": { "description": "ご希望の決済通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に従った3文字の通貨コード。[エクソーラがサポートする通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)の詳細については、ドキュメントを参照してください。", "type": "string" }, "Cart-Payment_settings_external_id": { "description": "トランザクションexternal ID。", "maxLength": 255, "minLength": 1, "type": "string" }, "Cart-Payment_settings_locale": { "description": "インターフェース言語。小文字の2文字[言語コード](https://developers.xsolla.com/ja/doc/pay-station/features/localization/)。", "type": "string" }, "Cart-Payment_settings_payment_method": { "description": "決済方法ID。決済方法によっては特定の通貨のみをサポートする場合があるため、決済インターフェースにおける通貨の表示を決定します。", "minimum": 1, "type": "integer" }, "Cart-Payment_settings_return_url": { "description": "ページを使用して決済後にユーザーをリダイレクトします。パラメーター`user_id`、`foreigninvoice`、`invoice_id`と`status`は、自動的にリンクに追加されます。", "format": "uri", "maxLength": 1000, "type": "string" }, "Cart-Payment_settings_sandbox": { "default": false, "description": "支払い処理をテストする場合は、`true`に設定します。この場合、https://sandbox-secure.xsolla.comを使用してテスト決済UIにアクセスします。", "type": "boolean" }, "Cart-Payment_settings_ui": { "additionalProperties": false, "description": "インターフェイス設定。", "properties": { "currency_format": { "description": "`code`に設定すると、決済UIに3 文字の[ISO 4217](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)通貨コードが表示されます。 デフォルトでは、3文字の通貨コードの代わりに通貨記号が表示されます。", "type": "string" }, "desktop": { "additionalProperties": false, "description": "デスクトップ版のインターフェース設定。", "properties": { "header": { "additionalProperties": false, "description": "ヘッダー設定。", "properties": { "close_button": { "default": false, "description": "デスクトップ決済UIに**閉じる**ボタンを表示するかどうか。このボタンは決済UIを閉じて、`settings.return_url`パラメータで指定したURLにリダイレクトします。デフォルトは`false`です。", "type": "boolean" }, "is_visible": { "description": "決済インターフェースにヘッダーを表示するかどうかを示します。", "type": "boolean" }, "type": { "default": "normal", "description": "ヘッダーを表示する方法。`compact`（プロジェクト名とユーザーIDを隠す）または`normal`（デフォルト）に指定できます。", "enum": [ "compact", "normal" ], "type": "string" }, "visible_logo": { "description": "`true`の場合、ロゴはヘッダーに表示されます。画像をアップロードするには、[パブリッシャーアカウント](https://publisher.xsolla.com/)でプロジェクトを開き、ペイステーション > 設定セクションにアクセスしてください。", "type": "boolean" }, "visible_name": { "description": "ヘッダーにプロジェクト名を表示するかどうかを示します。", "type": "boolean" }, "visible_purchase": { "default": true, "description": "ヘッダーに購入説明（`purchase.description.value`）を表示するか示します。デフォルトは`true`です。", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "header": { "properties": { "visible_virtual_currency_balance": { "additionalProperties": false, "default": true, "description": "この要素を決済インターフェースで非示にできるかどうかを示します。", "type": "boolean" } }, "type": "object" }, "is_cart_open_by_default": { "default": false, "description": "モバイル版の決済UIを開いた時のカート内のアイテムリストの表示。`true`の場合、リストは拡張ビューで表示されます。`false`（デフォルト）またはパラメータが渡されない場合、リストは折りたたまれたビューで表示されます。", "type": "boolean" }, "is_independent_windows": { "default": false, "description": "埋め込みランチャーのブラウザ（WebView）から、ユーザーのデフォルトのブラウザにリダイレクトして購入させるかどうか。", "type": "boolean" }, "is_payment_methods_list_mode": { "default": false, "description": "決済UIを開く際に、ユーザーの国で利用可能な決済方法のリストを表示するかどうか。`false`の場合（デフォルト）、`settings.payment_method`パラメータで渡された決済方法、または[PayRankアルゴリズム](https://developers.xsolla.com/ja/solutions/payments/payment-ui-management/top-payment-methods-management/)で選択された方法が表示されます。", "type": "boolean" }, "is_prevent_external_link_open": { "default": false, "description": "リンクを外部リソースにリダイレクトするかどうかを無効にします。外部リンクをクリックすると、`external-link-open`イベントが`postMessage`メカニズムを介して送信されます。`url`パラメータには、リダイレクト先のリンクのアドレスが渡されます。", "type": "boolean" }, "is_show_close_widget_warning": { "default": true, "description": "支払いページを閉じる前に、**×**アイコンの上にカーソルを置いたときに取引処理に関する警告を表示するかどうか。`false`が渡された場合、またはパラメータが渡されなかった場合、警告は表示されません。", "type": "boolean" }, "is_three_ds_independent_windows": { "default": false, "description": "3-Dセキュア検証が新しいブラウザウィンドウで開くかどうか。セットアップでコンテンツセキュリティポリシー（CSP）が適用される場合は、`true`に設定します。", "type": "boolean" }, "layout": { "description": "決済UIの主要要素の位置。ゲーム内で決済UIを開いたり、注文や決済方法に関する情報の列を入れ替えたりすることができます。詳細については、[カスタマイズに関する説明](https://developers.xsolla.com/ja/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_layout)を参照してください。", "enum": [ "embed", "column_reverse", "embed_column_reverse" ], "type": "string" }, "mobile": { "properties": { "header": { "additionalProperties": false, "properties": { "close_button": { "default": false, "description": "モバイル決済UIに**閉じる**ボタンを表示するかどうか。このボタンは決済UIを閉じて、`settings.return_url`パラメータで指定したURLにリダイレクトします。", "type": "boolean" } }, "type": "object" } }, "type": "object" }, "mode": { "description": "決済UIのインターフェースモード。`user_account`のみに指定できます：ヘッダーにはユーザーアカウントのナビゲーションメニューのみが含まれています。ユーザーは商品を選択したり、決済を行うことはできません。このモードは、デスクトップ上でのみ使用できます。", "enum": [ "user_account" ], "type": "string" }, "theme": { "default": "63295a9a2e47fab76f7708e1", "description": "決済UIのテーマ。ライトテーマ（デフォルト）の場合は`63295a9a2e47fab76f7708e1`、ダークテーマの場合は`63295aab2e47fab76f7708e3`を指定できます。[カスタムテーマを作成](https://developers.xsolla.com/ja/doc/pay-station/features/ui-theme-customization/#pay_station_ui_theme_customization_in_token)して、そのIDをこのパラメータに渡すこともできます。", "enum": [ "63295a9a2e47fab76f7708e1", "63295aab2e47fab76f7708e3" ], "type": "string" }, "user_account": { "additionalProperties": false, "description": "ユーザーアカウントの詳細。", "properties": { "info": { "additionalProperties": false, "description": "**私のアカウント** ページ。", "properties": { "enable": { "default": false, "description": "サブメニューを表示するかどうかを示します。デフォルトでは`false`です。", "type": "boolean" }, "order": { "description": "メニュー内のサブメニューの位置。", "minimum": 1, "type": "integer" } }, "required": [ "enable", "order" ], "type": "object" }, "payment_accounts": { "additionalProperties": false, "description": "**お客様の決済アカウント** サブメニュー。", "properties": { "enable": { "default": false, "description": "サブメニューを表示するかどうかを示します。デフォルトでは`false`です。", "type": "boolean" } }, "required": [ "enable" ], "type": "object" }, "subscriptions": { "additionalProperties": false, "description": "**サブスクリプションの管理** サブメニュー。", "properties": { "enable": { "default": false, "description": "サブメニューを表示するかどうかを示します。デフォルトでは`false`です。", "type": "boolean" }, "order": { "description": "メニュー内のサブメニューの位置。", "minimum": 1, "type": "integer" } }, "required": [ "enable", "order" ], "type": "object" } }, "type": "object" } }, "type": "object" }, "Cart_admin_payment": { "additionalProperties": false, "properties": { "items": { "items": { "properties": { "quantity": { "description": "アイテムの数量。", "example": 2, "minimum": 1, "type": "number" }, "sku": { "description": "一意のアイテムID。SKUは半角英数字、ピリオド、ダッシュ、およびアンダースコアのみ使用できます。\n
注意

同一のSKUを複数販売するには、purchase.items[].quantityパラメータに必要な数量を指定してください。配列内での重複するSKUはサポートされておらず、トークン作成時には最初の出現箇所のみが使用されます。この場合、エラーは返されません。
", "example": "t-shirt", "minLength": 1, "type": "string" } }, "required": [ "sku", "quantity" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "items" ], "type": "object" }, "Catalog_cart_promotions": { "description": "カート全体に適用されたプロモーション。この配列は、次の場合に返されます：\n\n* プロモーションがカート合計金額に影響する場合。例えば、**購入割引設定**が適用されたプロモーションコード。\n\n* プロモーションがボーナスアイテムをカートに追加する場合。\n\n注文レベルに適用されるプロモーションがない場合は、空の配列が返されます。", "items": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "ボーナスバンドルアイテムタイプ。ボーナスアイテムタイプ`bundle`のみで利用可能です。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "ボーナスアイテムの画像URLです。ボーナスアイテムのタイプ `physical_good` では使用できません。ー", "type": "string" }, "name": { "description": "ボーナスアイテムの名前です。ボーナスアイテムのタイプ`physical_good`では使用できません。", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "ボーナスアイテムタイプ。", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ], "type": "string" } }, "type": "object" }, "type": "array" }, "date_end": { "format": "date-time", "type": [ "string", "null" ] }, "date_start": { "format": "date-time", "type": [ "string", "null" ] }, "discount": { "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "limits": { "properties": { "per_user": { "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "Catalog_item_limits": { "description": "アイテム制限。", "properties": { "per_item": { "description": "アイテムのアイテム制限。", "properties": { "available": { "description": "すべてのユーザーが購入できるアイテムの残り数。", "example": 3, "type": "integer" }, "total": { "description": "すべてのユーザーが購入できるアイテムの最大数。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "ユーザーのアイテム制限。", "properties": { "available": { "description": "現在のユーザーが購入できるアイテムの残り数。", "example": 3, "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "1ユーザーあたりのユーザーが購入できるアイテムの最大数。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_limits_with_hourly": { "description": "アイテム制限。", "properties": { "per_item": { "description": "アイテムのアイテム制限。", "properties": { "available": { "description": "すべてのユーザーが購入できるアイテムの残り数。", "example": 3, "type": "integer" }, "total": { "description": "すべてのユーザーが購入できるアイテムの最大数。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "ユーザーのアイテム制限。", "properties": { "available": { "description": "現在のユーザーが購入できるアイテムの残り数。", "example": 3, "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "1ユーザーあたりのユーザーが購入できるアイテムの最大数。", "example": 5, "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "Catalog_item_promotions": { "description": "カート内の特定アイテムに適用されるプロモーション。この配列は、以下のケースで返されます：\n\n* 特定のアイテムに対して、割引キャンペーンが構成されている場合。\n\n* **選択されたアイテムの割引**設定を持つプロモーションコードが適用された場合。\n\nアイテムレベルのプロモーションが適用されない場合は、空の配列が返されます。", "items": { "properties": { "bonus": { "items": { "properties": { "bundle_type": { "description": "ボーナスバンドルアイテムタイプ。ボーナスアイテムタイプ`bundle`のみで利用可能です。", "enum": [ "standard", "virtual_currency_package" ], "type": "string" }, "image_url": { "description": "ボーナスアイテムの画像URLです。ボーナスアイテムのタイプ `physical_good` では使用できません。ー", "type": "string" }, "name": { "description": "ボーナスアイテムの名前です。ボーナスアイテムのタイプ`physical_good`では使用できません。", "type": "string" }, "quantity": { "type": "integer" }, "sku": { "type": "string" }, "type": { "description": "ボーナスアイテムタイプ。", "enum": [ "virtual_good", "virtual_currency", "bundle", "physical_good", "game_key", "nft" ], "type": "string" } }, "type": "object" }, "type": "array" }, "date_end": { "format": "date-time", "type": [ "string", "null" ] }, "date_start": { "format": "date-time", "type": [ "string", "null" ] }, "discount": { "properties": { "percent": { "type": [ "string", "null" ] }, "value": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "limits": { "properties": { "per_user": { "properties": { "available": { "type": "integer" }, "total": { "type": "integer" } }, "type": "object" } }, "type": "object" }, "name": { "type": "string" } }, "type": "object" }, "type": "array" }, "Common_admin-image_url": { "description": "画像URL。", "example": "https://image.example.com", "type": "string" }, "Game-Keys_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Game-Keys_admin-attribute-external_id": { "description": "一意の属性ID。`external_id`には、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "Game-Keys_admin-attributes": { "description": "属性リスト。", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Game-Keys_admin-post-put-attributes": { "description": "属性のリスト。\n
注意。アイテムの属性は20個以上指定することはできません。制限を超えようとすると、エラーが発生します。
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" }, "maxItems": 20, "type": "array" }, "Game-Keys_client-attributes": { "default": [], "description": "ゲームに対応する属性と値のリスト。\n\n
注意。この部分は、`additional_fields[]=attributes`クエリパラメータを送信した場合のみ利用可能なレスポンスです。
", "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/Game-Keys_admin-attribute-external_id" }, "name": { "description": "属性名。", "example": "Genre", "type": "string" }, "values": { "items": { "properties": { "external_id": { "$ref": "#/components/schemas/Game-Keys_value-external_id" }, "value": { "description": "属性値。", "example": "Strategy", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "Game-Keys_client_name": { "description": "ゲームパッケージ名。", "example": "The Greatest Game in the World", "type": "string" }, "Game-Keys_description": { "description": "ゲームパッケージ説明。", "example": "Description of the greatest game in the world.", "type": "string" }, "Game-Keys_drm_sku": { "description": "一意のDRM ID。", "enum": [ "steam", "playstation", "xbox", "uplay", "origin", "drmfree", "gog", "epicgames", "nintendo_eshop", "discord_game_store", "oculus", "rockstar", "viveport", "stadia" ], "example": "steam", "type": "string" }, "Game-Keys_entitlement_item": { "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_client-attributes" }, "description": { "$ref": "#/components/schemas/Game-Keys_description" }, "drm": { "$ref": "#/components/schemas/Game-Keys_drm_sku" }, "game_sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" }, "image_url": { "$ref": "#/components/schemas/Game-Keys_image_url" }, "is_pre_order": { "description": "ゲームが先行予約状態であるかどうか。", "example": false, "type": "boolean" }, "name": { "$ref": "#/components/schemas/Game-Keys_client_name" }, "project_id": { "$ref": "#/components/schemas/Game-Keys_project_id" } }, "type": "object" }, "Game-Keys_game_sku": { "description": "一意のキーパッケージID。", "example": "theGreatestGameSku", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Game-Keys_image_url": { "description": "画像URL。", "example": "https://none", "type": "string" }, "Game-Keys_project_id": { "description": "プロジェクトID。このパラメータは、[パブリッシャーアカウント](https://publisher.xsolla.com/)のプロジェクト名の横にあります。", "example": 44056, "type": "integer" }, "Game-Keys_regions": { "items": { "properties": { "id": { "example": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Game-Keys_schemas-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" }, "Game-Keys_value-external_id": { "description": "属性の一意の値ID。`external_id`には、英小文字、ダッシュ、およびアンダースコアのみが含まれます。", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "Game-key-item-limit": { "description": "アイテム制限。", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/game_key_recurrent_schedule" } }, "type": "object" }, "Pagination_has-more": { "description": "ページ数がもっとあることを示す指標として使用されます。", "example": true, "type": "boolean" }, "Pagination_total-items-count": { "description": "システムでのアイテムの合計数。", "example": 10, "type": "integer" }, "Promotions_coupon_code": { "default": "WINTER2021", "description": "大文字と小文字を区別する一意のコードです。文字と数字が含まれます。", "example": "WINTER2021", "maxLength": 128, "minLength": 1, "pattern": "^[a-zA-Z0-9]+$", "type": "string" }, "Regions_200-region-model": { "example": { "value": { "countries": [ "JP", "CN", "VN" ], "id": 44, "name": { "de-DE": "Asien", "en-US": "Asia" } } }, "properties": { "countries": { "$ref": "#/components/schemas/Regions_countries" }, "id": { "$ref": "#/components/schemas/Regions_region_id" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "type": "object" }, "Regions_200-region-short-model": { "properties": { "id": { "$ref": "#/components/schemas/Regions_region_id" }, "name": { "$ref": "#/components/schemas/Regions_name" } }, "type": "object" }, "Regions_countries": { "description": "地域に追加する国のリスト。\n
[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従った2文字の大文字の国名コード。\n[エクソーラがサポートする国](https://developers.xsolla.com/ja/doc/shop-builder/references/supported-countries/)の詳細情報については、ドキュメントを確認してください。\n
例：`[\"JP\", \"CN\", \"VN\"]`", "items": { "type": "string" }, "type": "array" }, "Regions_name": { "additionalProperties": { "type": "string" }, "default": { "de-DE": "Asien", "en-US": "Asia" }, "description": "地域名。キーと値のペアを含む必要があります。キーは\"^[a-z]{2}-[A-Z]{2}$\"フォーマットのロケール、値は文字列です。", "example": { "de-DE": "Asien", "en-US": "Asia" }, "type": "object" }, "Regions_region_id": { "description": "地域ID。プロジェクト内での一意の地域識別子。", "example": 42, "type": "integer" }, "User-limit-item": { "properties": { "per_user": { "properties": { "available": { "description": "ユーザーが購入できるアイテムの残りの数。", "example": 9, "type": "integer" }, "total": { "description": "ユーザーが購入できるアイテムの最大数。", "example": 10, "type": "integer" } }, "type": "object" } }, "type": "object" }, "User-limit_available": { "description": "適用された制限内でユーザーが利用できる残りのアイテム数またはプロモーション利用回数。", "minimum": 1, "type": "integer" }, "User-limit_available_flexible": { "description": "適用された制限内でユーザーが利用できる残りのアイテム数またはプロモーション利用回数。", "minimum": 0, "type": "integer" }, "User-limit_user": { "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "required": [ "user_external_id" ], "type": "object" }, "User-limit_user-external-id": { "description": "ユーザーexternal ID。", "minLength": 1, "pattern": "^\\S+$", "type": "string" }, "User-limit_user_flexible": { "properties": { "user_external_id": { "$ref": "#/components/schemas/User-limit_user-external-id" } }, "type": [ "object", "null" ] }, "Virtual-Currency-Package-item-limit": { "description": "アイテム制限。", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_currency_package_recurrent_schedule" } }, "type": "object" }, "Virtual-Currency-item-limit": { "description": "アイテム制限。", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_currency_recurrent_schedule" } }, "type": "object" }, "Virtual-Item-item-limit": { "description": "アイテム制限。", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/virtual_item_recurrent_schedule" } }, "type": "object" }, "Virtual-Items-Currency_422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "Virtual-Items-Currency_admin-attributes": { "allOf": [ { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-attributes" }, { "description": "属性リスト。" } ] }, "Virtual-Items-Currency_admin-create-vc_prices": { "description": "Array of virtual currency prices.", "items": { "example": { "amount": 10, "is_default": true, "is_enabled": true, "sku": "com.xsolla.gold_1" }, "properties": { "amount": { "description": "仮想通貨建てのアイテム価格。", "type": "integer" }, "is_default": { "default": false, "description": "Whether it is the default price in virtual currency.", "type": "boolean" }, "is_enabled": { "default": true, "description": "Whether this price is used for displaying in the catalog and for purchasing the item. If `false`, the price is not used.", "type": "boolean" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku" } }, "required": [ "amount", "sku", "is_default", "is_enabled" ], "type": "object" }, "type": [ "array", "null" ] }, "Virtual-Items-Currency_admin-create-virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Currency-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "required": [ "sku", "name" ], "type": "object" }, "Virtual-Items-Currency_admin-create-virtual-currency-package": { "anyOf": [ { "required": [ "prices" ] }, { "required": [ "vc_prices" ] } ], "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "content": { "description": "仮想通貨パッケージには、1ポジションの仮想通貨のみが含まれている必要があります。", "items": { "properties": { "quantity": { "type": "integer" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" } }, "type": "object" }, "maxLength": 1, "minLength": 1, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Currency-Package-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "required": [ "sku", "name", "description", "content" ], "type": "object" }, "Virtual-Items-Currency_admin-create-virtual-item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-post-put-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-create" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-admin-image_url" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/Virtual-Item-item-limit" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "prices": { "$ref": "#/components/schemas/Virtual-Items_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-create-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-get-vc_prices": { "items": { "example": { "amount": 10, "is_default": true, "sku": "com.xsolla.gold_1" }, "properties": { "amount": { "description": "金額。", "exclusiveMinimum": 0, "type": "number" }, "is_default": { "default": false, "type": "boolean" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_schemas-sku" } }, "required": [ "sku", "amount" ], "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-groups-create": { "description": "List of [group external IDs](/ja/api/catalog/item-groups-admin/admin-get-item-group-list/#!path=groups/external_id&t=response) the item belongs to.\n\nExample: [\"horror\", \"action\"]", "items": { "properties": { "external_id": { "example": "accessory", "type": "string" }, "name": { "example": "Accessory", "type": "string" } }, "type": "string" }, "type": "array" }, "Virtual-Items-Currency_admin-groups-response": { "default": [], "description": "アイテムが所属するグループ。", "example": [ { "external_id": "horror", "name": { "en": "Horror" } } ], "items": { "properties": { "external_id": { "example": "horror", "type": "string" }, "name": { "additionalProperties": { "type": "string" }, "default": { "en": "Horror" }, "description": "アイテム名。キーと値のペアを含める必要があり、\nキーは \"^[a-z]\" 書式のロケール{2}で、値は文字列です。", "example": { "de": "Horror", "en": "Horror" }, "type": "object" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-image_url": { "description": "画像URL。", "type": "string" }, "Virtual-Items-Currency_admin-media_list": { "description": "スクリーンショット、ゲームプレイ動画などのアイテム追加アセット。", "example": [ { "type": "image", "url": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg" } ], "items": { "properties": { "type": { "description": "メディアタイプ：`image`/`video`。", "enum": [ "image", "video" ], "example": "image", "type": "string" }, "url": { "description": "リソースファイル。", "example": "https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg", "type": "string" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-post-put-attributes": { "description": "属性のリスト。\n
注意。アイテムの属性は20個以上指定することはできません。制限を超えようとすると、エラーが発生します。
", "items": { "$ref": "#/components/schemas/admin-post-put-attribute-item" }, "maxItems": 20, "type": "array" }, "Virtual-Items-Currency_admin-prices": { "items": { "example": { "amount": 10.5, "country_iso": "US", "currency": "USD", "is_default": true, "is_enabled": true }, "properties": { "amount": { "description": "Item price in real currency.", "example": 10.5, "exclusiveMinimum": 0, "type": "number" }, "country_iso": { "description": "この価格が利用可能な国。[ISO 3166-1 alpha 2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に基づく2文字コード。", "example": "US", "type": [ "string", "null" ] }, "currency": { "description": "商品価格の通貨。3文字のコード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" }, "is_default": { "default": false, "description": "Whether it is the default price in real currency. Refer to our [documentation](https://developers.xsolla.com/ja/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) for detailed information on price settings.", "type": "boolean" }, "is_enabled": { "default": true, "description": "Whether this price is used for displaying in the catalog and for purchasing the item. If `false`, the price is not used and another price is applied. Refer to our [documentation](https://developers.xsolla.com/ja/items-catalog/catalog-features/pricing-policy/#pricing_policy_country_determination) for detailed information on price settings.", "example": true, "type": "boolean" } }, "required": [ "amount", "currency" ], "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-regions": { "description": "Array of regions where the item is available. If the array is empty or not passed, the item is available in all regions.", "items": { "properties": { "id": { "description": "Region ID within the project.\n\nRefer to the [regional sale restriction documentation](https://developers.xsolla.com/ja/items-catalog/catalog-features/regional-restrictions/) and [region management API calls](https://developers.xsolla.com/ja/api/catalog/common-regions) for detailed information.", "example": 1, "minimum": 1, "type": "integer" } }, "type": "object" }, "type": "array" }, "Virtual-Items-Currency_admin-virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-virtual-currency-package": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "bundle_type": { "default": "virtual_currency_package", "example": "virtual_currency_package", "type": "string" }, "content": { "items": { "properties": { "description": { "$ref": "#/components/schemas/description-localization-object" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "quantity": { "type": "integer" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" } }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_admin-virtual-item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-attributes" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "$ref": "#/components/schemas/description-localization-object" }, "groups": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-groups-response" }, "image_url": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-image_url" }, "is_enabled": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_enabled" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_paid_randomized_reward": { "$ref": "#/components/schemas/value-is_paid_randomized_reward" }, "is_show_in_store": { "$ref": "#/components/schemas/Virtual-Items-Currency_is_show_in_store" }, "limits": { "$ref": "#/components/schemas/admin-item-limit-response" }, "long_description": { "$ref": "#/components/schemas/long-description-localization-object" }, "media_list": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-media_list" }, "name": { "$ref": "#/components/schemas/name-localization-object" }, "order": { "$ref": "#/components/schemas/Virtual-Items-Currency_order" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "prices": { "$ref": "#/components/schemas/Virtual-Items_admin-prices" }, "regions": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-regions" }, "sku": { "$ref": "#/components/schemas/Virtual-Items-Currency_sku" }, "type": { "$ref": "#/components/schemas/Virtual-Items-Currency_type" }, "vc_prices": { "$ref": "#/components/schemas/Virtual-Items-Currency_admin-get-vc_prices" } }, "type": "object" }, "Virtual-Items-Currency_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": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "属性名。", "example": "Genre", "type": "object" }, "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" }, "Virtual-Items-Currency_is_enabled": { "default": true, "description": "Whether the item is available. If `false`, the item can't be purchased in the store or obtained as part of a bundle or within a marketing campaign. Refer to our [documentation](https://developers.xsolla.com/ja/items-catalog/catalog-features/items-availability/) for detailed information about item availability.", "example": true, "type": "boolean" }, "Virtual-Items-Currency_is_show_in_store": { "default": false, "description": "Whether the item is displayed in the catalog. If `false` and `is_enabled: true`, the item is not visible in the catalog but can be obtained as part of a bundle or within marketing campaigns. Refer to our [documentation](https://developers.xsolla.com/ja/items-catalog/catalog-features/items-availability/) for detailed information about item availability.", "example": true, "type": "boolean" }, "Virtual-Items-Currency_item": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "アイテムの説明。", "example": "Big Rocket - description", "type": "object" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "description": "アイテムID。", "type": "number" }, "limits": { "$ref": "#/components/schemas/client-item-limit-response" }, "name": { "additionalProperties": { "type": [ "string", "null" ] }, "description": "アイテム名。", "example": "Big Rocket", "type": "object" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品価格の通貨。3文字のコード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "big_rocket", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`。", "example": "virtual_good", "type": "string" }, "virtual_item_type": { "description": "Type of virtual item.\n\nPossible values:\n- `consumable` — An item that disappears from the inventory after use (e.g., ammo).\n- `non_consumable` — An item that stays in the inventory for an unlimited period of time.\n- `non_renewing_subscription` — Time-limited item that can represent access to services or content for a limited period of time.", "enum": [ "consumable", "non_consumable", "non_renewing_subscription" ], "example": "non-consumable", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "vc_test", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "Virtual-Items-Currency_item-list": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_item" }, "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_order": { "default": 1, "description": "Item display order in the catalog. The higher the value, the lower the item appears in the list.\nIf the values are the same, items are sorted by creation date, with newer items displayed higher.", "example": 1, "type": "integer" }, "Virtual-Items-Currency_schemas-admin-attributes": { "description": "属性リスト。", "items": { "$ref": "#/components/schemas/attribute" }, "type": "array" }, "Virtual-Items-Currency_schemas-admin-image_url": { "description": "画像URL。", "example": "https://image.example.com", "type": "string" }, "Virtual-Items-Currency_schemas-sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "bundle_1", "type": "string" }, "Virtual-Items-Currency_sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "booster_mega_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9_\\-–.]*$", "type": "string" }, "Virtual-Items-Currency_type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。", "type": "string" }, "Virtual-Items-Currency_virtual-currency": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "アイテムの説明。", "example": "Crystals - description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "アイテム名。", "example": "Big Rocket", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品価格の通貨。3文字のコード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" } }, "type": [ "object", "null" ] }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "big_rocket", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`。", "example": "virtual_currency", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "example": [ { "amount": 100, "amount_without_discount": 100, "image_url": "http://image.png", "is_default": true, "sku": "com.xsolla.crystals_1" } ], "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Crystals - description", "type": "string" }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "Crystals", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-list": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency" }, "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-package": { "properties": { "attributes": { "$ref": "#/components/schemas/Virtual-Items-Currency_client-attributes" }, "bundle_type": { "description": "バンドルタイプ：`standard`/`virtual_currency_package`。", "example": "virtual_currency_package", "type": "string" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "content": { "description": "仮想通貨パッケージの内容。", "example": [ { "description": "Crystal Pack - short description", "image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "name": "Crystal Pack", "quantity": 100, "sku": "com.xsolla.crystal_pack_1", "type": "virtual_currency" } ], "items": { "description": "パッケージ内の仮想通貨。", "properties": { "description": { "description": "アイテムの説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "画像URL。", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "アイテム名。", "example": "Big Rocket", "type": "string" }, "quantity": { "description": "パッケージ内の仮想通貨の数量。", "example": 250, "type": "integer" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。", "example": "com.xsolla.big_rocket_1", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "custom_attributes": { "$ref": "#/components/schemas/item-custom-attributes-response" }, "description": { "description": "アイテムの説明。", "example": "Crystal Pack Description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "item_id": { "type": "integer" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "アイテム名。", "example": "Crystal Pack", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods-response" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "100.99", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "100.99", "type": "string" }, "currency": { "description": "商品価格の通貨。3文字のコード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "crystal-pack", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`。", "example": "bundle", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "vc_test", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "type": "array" } }, "type": "object" }, "Virtual-Items-Currency_virtual-currency-packages": { "properties": { "has_more": { "$ref": "#/components/schemas/Pagination_has-more" }, "items": { "items": { "$ref": "#/components/schemas/Virtual-Items-Currency_virtual-currency-package" }, "type": "array" } }, "type": "object" }, "Virtual-Items_admin-prices": { "items": { "example": { "amount": 10.5, "currency": "USD", "is_default": true, "is_enabled": true }, "properties": { "amount": { "description": "金額。", "exclusiveMinimum": 0, "type": "number" }, "country_iso": { "description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に従った2文字の大文字の国名コード。[エクソーラがサポートする国](https://developers.xsolla.com/ja/doc/shop-builder/references/supported-countries/)の詳細情報については、ドキュメントを確認してください。
例：`country=US`", "example": "US", "type": "string" }, "currency": { "description": "商品価格の通貨。3文字のコード[ISO4217 規格](https://en.wikipedia.org/wiki/ISO_4217)詳細については、ドキュメントを参照してください。[エクソーラでサポートされている通貨](https://developers.xsolla.com/ja/doc/pay-station/references/supported-currencies/)。", "example": "USD", "type": "string" }, "is_default": { "default": false, "type": "boolean" }, "is_enabled": { "default": true, "type": "boolean" } }, "required": [ "amount", "currency" ], "type": "object" }, "type": "array" }, "admin-attribute-external_id": { "description": "一意の属性ID。`external_id`には、小文字と大文字のラテン英数字、ダッシュ、およびアンダースコアのみが含まれます。", "example": "attribute_1", "maxLength": 255, "minLength": 1, "pattern": "^[a-zA-Z0-9-_]+$", "type": "string" }, "admin-attribute-name": { "additionalProperties": { "type": "string" }, "default": { "de": "Genre", "en": "Genre" }, "description": "属性用のローカライズされたオブジェクト。キーはISO 3166-1で指定されています。", "example": { "de": "Genre", "en": "Genre" }, "type": "object" }, "admin-group-create-request": { "description": "Item group data.", "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "External ID of the item group. Can contain only alphanumeric characters, hyphens, and underscores.", "example": "weapons", "pattern": "^[A-Za-z0-9_\\-]+$", "type": "string" }, "iconUrl": { "$ref": "#/components/schemas/group-image-url" }, "isEnabled": { "allOf": [ { "$ref": "#/components/schemas/group-is-enabled" } ], "default": true }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "allOf": [ { "$ref": "#/components/schemas/group-display-order" } ] } }, "required": [ "external_id", "name" ], "type": "object" }, "admin-group-detail-response-by-item-type": { "allOf": [ { "$ref": "#/components/schemas/admin-group-response-base" }, { "properties": { "is_contains_any_items": { "$ref": "#/components/schemas/group-is-contains-any-items" } }, "type": "object" } ] }, "admin-group-response-base": { "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "External item group ID specified during creation.", "example": "weapons", "type": "string" }, "id": { "description": "Item group ID assigned by Xsolla.", "example": 1, "type": "integer" }, "image_url": { "$ref": "#/components/schemas/group-image-url" }, "is_enabled": { "$ref": "#/components/schemas/group-is-enabled" }, "items_count": { "description": "Total number of items in the group.", "example": 5, "type": "integer" }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "$ref": "#/components/schemas/group-display-order" } }, "required": [ "id", "external_id", "name", "is_enabled" ], "type": "object" }, "admin-group-response-by-item-type": { "allOf": [ { "$ref": "#/components/schemas/admin-group-response-base" }, { "properties": { "is_contains_any_items": { "$ref": "#/components/schemas/group-is-contains-any-items" } }, "type": "object" } ] }, "admin-group-update-request": { "description": "Item group data to update. The `external_id` and `name` fields are required in every request. Other fields are optional — omitted fields will retain their current values.", "properties": { "description": { "$ref": "#/components/schemas/group-description-localization-object" }, "external_id": { "description": "Unique group external ID. Can contain only alphanumeric characters, hyphens, and underscores. Can be used to rename the group's external ID.", "example": "weapons", "pattern": "^[A-Za-z0-9_\\-]+$", "type": "string" }, "iconUrl": { "$ref": "#/components/schemas/group-image-url" }, "isEnabled": { "allOf": [ { "$ref": "#/components/schemas/group-is-enabled" } ] }, "name": { "$ref": "#/components/schemas/group-name-localization-object" }, "order": { "allOf": [ { "$ref": "#/components/schemas/group-display-order" } ] } }, "required": [ "external_id", "name" ], "type": "object" }, "admin-item-limit-response": { "description": "アイテム制限。", "properties": { "per_item": { "description": "グローバルアイテム制限。", "properties": { "available": { "description": "すべてのユーザーが購入できるアイテムの残り数。", "type": "integer" }, "reserved": { "type": "integer" }, "sold": { "type": "integer" }, "total": { "description": "すべてのユーザーが購入できるアイテムの最大数。", "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "別ユーザーのアイテム制限。", "properties": { "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "total": { "description": "1ユーザーあたりのユーザーが購入できるアイテムの最大数。", "type": "integer" } }, "type": [ "object", "null" ] }, "recurrent_schedule": { "$ref": "#/components/schemas/admin_recurrent_schedule_response" } }, "type": [ "object", "null" ] }, "admin-post-put-attribute-item": { "maxItems": 6, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" }, "values": { "description": "
注意。各属性に6つ以上の値を作成することはできません。制限を超えようとすると、エラーが発生します。
", "example": [ { "external_id": "strategy", "value": { "de": "Strategie", "en": "Strategy" } }, { "external_id": "action", "value": { "de": "Aktion", "en": "Action" } } ], "items": { "$ref": "#/components/schemas/attribute-value" }, "type": "array" } }, "required": [ "external_id", "values" ], "type": "object" }, "admin_attribute_response": { "example": { "value": [ { "external_id": "genre", "name": { "de": "Genre", "en": "Genre" } } ] }, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" } }, "type": "object" }, "admin_recurrent_schedule_response": { "description": "制限更新期間。", "properties": { "per_user": { "description": "ユーザー制限更新期間。", "oneOf": [ { "description": "ユーザー制限の日次更新タイプ。", "properties": { "displayable_reset_next_date": { "description": "制限をリセットする日時（ISO 8601）。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "最初の制限更新の日時（ISO 8601）。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "定期更新期間のタイプ。", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "制限が更新された日時（UNIXタイムスタンプ）。", "example": 1677553200, "type": "integer" }, "time": { "description": "希望するタイムゾーンでのリミットの更新時刻（時間単位で四捨五入）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = 毎日", "type": "object" }, { "description": "ユーザー制限の週次更新タイプ。", "properties": { "day_of_week": { "description": "制限が更新される曜日。1は月曜日、7は日曜日です。`weekly`制限更新期間タイプは`null`のみではありません。", "maximum": 7, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "制限をリセットする日時（ISO 8601）。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "最初の制限更新の日時（ISO 8601）。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "定期更新期間のタイプ。", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "制限が更新された日時（UNIXタイムスタンプ）。", "example": 1677553200, "type": "integer" }, "time": { "description": "希望するタイムゾーンでのリミットの更新時刻（時間単位で四捨五入）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = 毎週", "type": "object" }, { "description": "ユーザー制限の月次更新タイプ。", "properties": { "day_of_month": { "description": "制限が更新される月の日。月の残り時間が短いために選択された日がない場合、更新はその月の最終日に行われます。`monthly`制限更新期間タイプは`null`のみではありません。", "maximum": 31, "minimum": 1, "type": [ "integer", "null" ] }, "displayable_reset_next_date": { "description": "制限をリセットする日時（ISO 8601）。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "最初の制限更新の日時（ISO 8601）。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "interval_type": { "description": "定期更新期間のタイプ。", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "制限が更新された日時（UNIXタイムスタンプ）。", "example": 1677553200, "type": "integer" }, "time": { "description": "希望するタイムゾーンでのリミットの更新時刻（時間単位で四捨五入）。", "example": "11:00:00+03:00", "format": "full-time", "type": "string" } }, "title": "interval_type = 毎月", "type": "object" }, { "description": "ユーザー制限のリセットは、指定された時間間隔で実行されます。", "properties": { "displayable_reset_next_date": { "description": "制限をリセットする日時（ISO 8601）。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "displayable_reset_start_date": { "description": "最初の制限更新の日時（ISO 8601）。", "example": "2023-02-28T11:00:00+08:00", "format": "date-time", "type": "string" }, "hours_interval": { "description": "時間単位で指定される、制限が更新されるまでの間隔。

カウントダウンは、date_fromパラメータで指定された、アイテムがストアに初めて表示された時点から開始されます。

例えば、例として、`date_from = \"2025-11-15T18:15:00+05:00\"`かつ`hours_interval = 2`の場合、このアイテムの購入制限は`\"2025-11-15T20:15:00+05:00\"`から開始して2時間ごとに更新されます。", "maximum": 10000, "minimum": 1, "type": "integer" }, "interval_type": { "description": "定期更新期間のタイプ。", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "制限が更新された日時（UNIXタイムスタンプ）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 毎時間", "type": "object" } ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "attribute": { "example": { "external_id": "attribute_external_id", "name": { "de": "Attributname", "en": "Attribute name" }, "values": [ { "external_id": "value_1", "name": { "de": "wert 1", "en": "value 1" } }, { "external_id": "value_2", "name": { "de": "wert 2", "en": "value 2" } } ] }, "properties": { "external_id": { "$ref": "#/components/schemas/admin-attribute-external_id" }, "name": { "$ref": "#/components/schemas/admin-attribute-name" }, "values": { "example": [ { "external_id": "strategy", "value": { "de": "Strategie", "en": "Strategy" } }, { "external_id": "action", "value": { "de": "Aktion", "en": "Action" } } ], "items": { "$ref": "#/components/schemas/attribute-value" }, "type": "array" } }, "required": [ "external_id", "values" ], "type": "object" }, "attribute-value": { "example": { "external_id": "value_external_id", "name": { "de": "Wert 1", "en": "Value 1" } }, "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "$ref": "#/components/schemas/value-name" } }, "required": [ "value", "external_id" ], "type": "object" }, "bundle-item-limit": { "description": "アイテム制限。", "properties": { "per_item": { "$ref": "#/components/schemas/limit_per_item" }, "per_user": { "$ref": "#/components/schemas/limit_per_user" }, "recurrent_schedule": { "$ref": "#/components/schemas/bundle_recurrent_schedule" } }, "type": "object" }, "bundle_recurrent_schedule": { "description": "制限更新期間。", "properties": { "per_user": { "description": "購入制限のリセットは、指定された時間間隔で実行されます。", "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" }, { "$ref": "#/components/schemas/per_user_hourly_bundle" } ] } }, "type": [ "object", "null" ] }, "bundle_type": { "description": "バンドルタイプ。アイテムタイプがバンドルの場合に返されます。", "enum": [ "standard", "virtual_currency_package", "partner_side_content" ], "type": "string" }, "catalog_recurrent_schedule_client_response": { "description": "ユーザーのアイテム制限の定期更新期間。", "oneOf": [ { "description": "ユーザー制限の日次更新タイプ。", "properties": { "interval_type": { "description": "定期更新期間のタイプ。", "enum": [ "daily" ], "type": "string" }, "reset_next_date": { "description": "制限がリセットされた日時（UNIXタイムスタンプ）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 毎日", "type": "object" }, { "description": "ユーザー制限の週次更新タイプ。", "properties": { "interval_type": { "description": "定期更新期間のタイプ。", "enum": [ "weekly" ], "type": "string" }, "reset_next_date": { "description": "制限がリセットされた日時（UNIXタイムスタンプ）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 毎週", "type": "object" }, { "description": "ユーザー制限の月次更新タイプ。", "properties": { "interval_type": { "description": "定期更新期間のタイプ。", "enum": [ "monthly" ], "type": "string" }, "reset_next_date": { "description": "制限がリセットされた日時（UNIXタイムスタンプ）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 毎月", "type": "object" }, { "description": "ユーザー制限のリセットは、指定された時間間隔で実行されます。", "properties": { "interval_type": { "description": "定期更新期間のタイプ。", "enum": [ "hourly" ], "type": "string" }, "reset_next_date": { "description": "制限がリセットされた日時（UNIXタイムスタンプ）。", "example": 1677553200, "type": "integer" } }, "title": "interval_type = 毎時間", "type": "object" } ], "type": [ "object", "null" ] }, "client-item-limit-response": { "description": "アイテム制限。", "properties": { "per_item": { "description": "グローバルアイテム制限。", "properties": { "available": { "description": "すべてのユーザーが購入できるアイテムの残り数。", "type": "integer" }, "total": { "description": "すべてのユーザーが購入できるアイテムの最大数。", "type": "integer" } }, "type": [ "object", "null" ] }, "per_user": { "description": "別ユーザーのアイテム制限。", "properties": { "available": { "description": "現在のユーザーが購入できるアイテムの残り数。", "type": "integer" }, "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "recurrent_schedule": { "$ref": "#/components/schemas/catalog_recurrent_schedule_client_response" }, "total": { "description": "1ユーザーあたりのユーザーが購入できるアイテムの最大数。", "type": "integer" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "client-item-value-point-reward": { "description": "バリューポイントアイテム報酬。", "items": { "properties": { "amount": { "$ref": "#/components/schemas/value-point-amount" }, "image_url": { "$ref": "#/components/schemas/Common_admin-image_url" }, "is_clan": { "$ref": "#/components/schemas/is_clan" }, "item_id": { "$ref": "#/components/schemas/item_id" }, "name": { "$ref": "#/components/schemas/value-point-name" }, "sku": { "$ref": "#/components/schemas/value-point-sku" } }, "type": "object" }, "type": "array" }, "description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "アイテムの説明に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：`en`）または5文字のロケールコード（例：`en-US`）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：`en`と`en-US`）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、[ドキュメント](/ja/doc/shop-builder/references/supported-languages/)で確認できます。", "type": [ "object", "null" ] }, "error-message-extended-validation": { "description": "Validation error details. Contains an array of property-level errors describing which fields failed validation and why.", "items": { "properties": { "message": { "description": "Validation error message for the field.", "example": "The property external_id is required", "type": "string" }, "property": { "description": "Name of the field that failed validation.", "example": "external_id", "type": "string" } }, "type": "object" }, "type": "array" }, "error-response-base": { "properties": { "errorCode": { "description": "エラーコード。", "type": "integer" }, "errorMessage": { "description": "Short error description.", "type": "string" }, "statusCode": { "description": "HTTP response status.", "type": "integer" }, "transactionId": { "description": "Request ID. The ID used to track and associate log entries related to this specific request or operation. This ID can be helpful for troubleshooting, debugging, and auditing purposes.", "type": "string" } }, "type": "object" }, "five-letter-locale": { "description": "5文字のロケールコード。", "properties": { "ar-AE": { "description": "アラビア語", "type": [ "string", "null" ] }, "bg-BG": { "description": "ブルガリア語", "type": [ "string", "null" ] }, "cs-CZ": { "description": "チェコ語", "type": [ "string", "null" ] }, "de-DE": { "description": "ドイツ語", "type": [ "string", "null" ] }, "en-US": { "description": "英語", "type": [ "string", "null" ] }, "es-ES": { "description": "スペイン語（スペイン）", "type": [ "string", "null" ] }, "fr-FR": { "description": "フランス語", "type": [ "string", "null" ] }, "he-IL": { "description": "ヘブライ語", "type": [ "string", "null" ] }, "id-ID": { "description": "インドネシア語", "type": [ "string", "null" ] }, "it-IT": { "description": "イタリア語", "type": [ "string", "null" ] }, "ja-JP": { "description": "日本語", "type": [ "string", "null" ] }, "km-KH": { "description": "クメール語", "type": [ "string", "null" ] }, "ko-KR": { "description": "韓国語", "type": [ "string", "null" ] }, "lo-LA": { "description": "ラオス語", "type": [ "string", "null" ] }, "my-MM": { "description": "ビルマ語", "type": [ "string", "null" ] }, "ne-NP": { "description": "ネパール語", "type": [ "string", "null" ] }, "ph-PH": { "description": "フィリピン語", "type": [ "string", "null" ] }, "pl-PL": { "description": "ポーランド語", "type": [ "string", "null" ] }, "pt-BR": { "description": "ポルトガル語（ブラジル）", "type": [ "string", "null" ] }, "ro-RO": { "description": "ルーマニア語", "type": [ "string", "null" ] }, "ru-RU": { "description": "ロシア語", "type": [ "string", "null" ] }, "th-TH": { "description": "タイ語", "type": [ "string", "null" ] }, "tr-TR": { "description": "トルコ語", "type": [ "string", "null" ] }, "vi-VN": { "description": "ベトナム語", "type": [ "string", "null" ] }, "zh-CN": { "description": "中国語（簡体字）", "type": [ "string", "null" ] }, "zh-TW": { "description": "中国語（繁体字）", "type": [ "string", "null" ] } }, "title": "five-letter", "type": [ "object", "null" ] }, "game_key_recurrent_schedule": { "description": "制限更新期間。", "properties": { "per_user": { "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" } ] } }, "type": [ "object", "null" ] }, "group-description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "Object with localizations for group's description. Accepts value in one of two formats: two-letter lowercase language codes (e.g., `en`) or five-character locale codes (e.g., `en-US`). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., `en` and `en-US`), the last provided value is stored. You can find the full list of supported languages in the [documentation](/ja/doc/shop-builder/references/supported-languages/).", "type": [ "object", "null" ] }, "group-display-order": { "default": 1, "description": "Display order of the item group in the catalog. The higher the value, the lower the group appears in the list. If the values are the same, groups are sorted by creation date, with newer groups displayed higher.", "example": 1, "type": "integer" }, "group-image-url": { "description": "URL of the item group image.", "example": "https://example.com/weapons.png", "type": [ "string", "null" ] }, "group-is-contains-any-items": { "description": "Whether the group contains any items, regardless of the specified `item_type`. A group can have `items_count: 0` for the specified type, while `is_contains_any_items` is `true` if the group contains items of other types.", "example": true, "type": "boolean" }, "group-is-enabled": { "default": true, "description": "Whether the item group is enabled in the catalog.", "example": true, "type": "boolean" }, "group-name-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "Object with localizations for group's name. Accepts value in one of two formats: two-letter lowercase language codes (e.g., `en`) or five-character locale codes (e.g., `en-US`). While both formats are accepted as input, responses return two-letter lowercase language codes. When both options for the same language are provided (e.g., `en` and `en-US`), the last provided value is stored. You can find the full list of supported languages in the [documentation](/ja/doc/shop-builder/references/supported-languages/).", "type": [ "object", "null" ] }, "hours_interval": { "maximum": 10000, "minimum": 1, "type": "integer" }, "interval_type_hourly": { "description": "定期更新期間。", "enum": [ "hourly" ], "type": "string" }, "is_clan": { "description": "バリューポイントがクランリワードチェーンで使用されるかどうか。", "example": true, "type": "boolean" }, "item-custom-attributes": { "description": "アイテムの属性と値を含むJSONオブジェクト。属性により、アイテムを使用するために必要なプレイヤーのレベルなど、より詳細な情報をアイテムに追加することができます。属性はゲームの内部ロジックを豊かにし、専用の「取得」メソッドやウェブフックからアクセスできます。", "format": "json", "maxLength": 500, "type": "object" }, "item-custom-attributes-response": { "description": "アイテムの属性と値を含むJSONオブジェクト。", "format": "json", "type": "object" }, "item-in-group-order-request-item": { "additionalProperties": false, "properties": { "item_id": { "description": "Internal item ID assigned by Xsolla. Use the item ID returned in the [item catalog API call](/ja/api/catalog/common-catalog) responses.", "example": 101, "minimum": 0, "type": "integer" }, "order": { "description": "New display order value.", "example": 1, "minimum": 0, "type": "integer" } }, "required": [ "item_id", "order" ], "type": "object" }, "item-periods": { "description": "アイテム販売期間。", "items": { "properties": { "date_from": { "description": "指定されたアイテムの販売開始日。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": "string" }, "date_until": { "description": "指定されたアイテムが販売できなくなる日付。`null`を指定することもできます。", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "item-periods-response": { "description": "アイテム販売期間。", "items": { "properties": { "date_from": { "description": "指定されたアイテムの販売開始日。", "example": "2020-08-11T10:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] }, "date_until": { "description": "指定されたアイテムが販売できなくなる日付。`null`を指定することもできます。", "example": "2020-08-11T20:00:00+03:00", "format": "date-time", "type": [ "string", "null" ] } }, "type": "object" }, "type": "array" }, "item_id": { "description": "内部の一意のアイテムID。", "example": 1, "type": "integer" }, "items_client_groups_response": { "default": [], "description": "アイテムが所属するグループ。", "example": [ { "external_id": "exclusive", "name": "Exclusive" } ], "items": { "properties": { "external_id": { "description": "このグループの一意の識別子。通常、APIリクエストや外部システムでの参照に使用されます。", "example": "exclusive", "type": "string" }, "item_order_in_group": { "description": "グループ内でのアイテムの位置。表示順を決定するために使用されます。\nこのフィールドは、additional_fields[]クエリパラメータでリクエストされた場合にのみ、応答に含まれます。", "example": 1, "type": "integer" }, "name": { "description": "グループ名。", "example": "Exclusive", "type": "string" } }, "type": "object" }, "type": "array" }, "limit_exceeded_visibility": { "default": "show", "description": "Determines the visibility of the item in the catalog after the purchase limit is reached, until the next limit reset.\n\nApplies to items for which recurring limit resets are configured in the `recurrent_schedule` array.\n\nIf limit resets are not configured, the item doesn't appear in the catalog after the purchase limit is reached,\nregardless of the `limit_exceeded_visibility` value.\n\nPossible values:\n- `show` — The item is returned in catalog retrieval API calls after the purchase limit is reached. In client-side\ncatalog retrieval API calls, once the limit is reached, the item is returned with the `can_be_bought: false` flag. The\nnext reset date is returned in `reset_next_date`.\n- `hide` — The item is not returned in catalog retrieval API calls after the purchase limit is reached, until the\nlimit is reset.", "enum": [ "show", "hide" ], "example": "show", "type": "string" }, "limit_per_item": { "description": "グローバルアイテム制限。", "example": 10, "type": [ "integer", "null" ] }, "limit_per_user": { "anyOf": [ { "description": "お一人様何点でも購入可能です。", "type": "null" }, { "description": "1ユーザーあたりのユーザーが購入できるアイテムの最大数。", "example": 5, "type": "integer" }, { "description": "詳細な購入制限の設定。", "properties": { "limit_exceeded_visibility": { "$ref": "#/components/schemas/limit_exceeded_visibility" }, "total": { "description": "1ユーザーあたりのユーザーが購入できるアイテムの最大数。", "example": 5, "type": "integer" } }, "type": "object" } ], "description": "別ユーザーのアイテム制限。" }, "long-description-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "アイテムの長文説明のローカライズを含むオブジェクト。2文字の小文字の言語コード（例：`en`）または5文字のロケールコード（例：`en-US`）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のバリアント（例：`en`と`en-US`）が提供された場合、最後に提供された値が保存されます。サポートされている言語の完全なリストは、[ドキュメント](/ja/doc/shop-builder/references/supported-languages/)で確認できます。", "type": [ "object", "null" ] }, "name-localization-object": { "anyOf": [ { "$ref": "#/components/schemas/two-letter-locale" }, { "$ref": "#/components/schemas/five-letter-locale" } ], "description": "アイテム名に関するローカライズ用オブジェクト。2文字の小文字の言語コード（例：`en`）または5文字の言語コード（例：`en-US`）のいずれかの形式で値を受け入れます。どちらの形式も入力として受け入れられますが、応答は2文字の小文字の言語コードを返します。同じ言語に対して両方のオプションが提供された場合（例：`en`と`en-US`）、最後に提供された値が保存されます。サポートされている言語の完全なリストは、[ドキュメント](/ja/doc/shop-builder/references/supported-languages/)で確認できます。", "type": [ "object", "null" ] }, "per_user_daily": { "description": "ユーザー制限の日次更新タイプ。", "properties": { "interval_type": { "description": "定期更新期間。", "enum": [ "daily" ], "type": "string" }, "time": { "description": "希望するタイムゾーンでのリミットの更新時刻（時間単位で四捨五入）。", "example": "02:00:00+03:00", "pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])", "type": "string" } }, "required": [ "interval_type", "time" ], "title": "interval_type = 毎日", "type": "object" }, "per_user_hourly_bundle": { "properties": { "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "制限がリセットされるまでの時間間隔。

カウントダウンはdate_fromパラメータから開始されます。

例えば、 `date_start = \"2025-11-15T18:15:00+05:00\"`かつ`hours_interval = 2`の場合、アイテムの購入制限は`\"2025-11-15T20:15:00+05:00\"`から開始して2時間ごとにリセットされます。" } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = 毎時間", "type": "object" }, "per_user_hourly_vc": { "properties": { "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "制限がリセットされるまでの時間間隔。

カウントダウンはdate_fromパラメータから開始されます。

例えば、 `date_start = \"2025-11-15T18:15:00+05:00\"`かつ`hours_interval = 2`の場合、アイテムの購入制限は`\"2025-11-15T20:15:00+05:00\"`から開始して2時間ごとにリセットされます。" } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = 毎時間", "type": "object" }, "per_user_hourly_vcp": { "properties": { "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "制限がリセットされるまでの時間間隔。

カウントダウンはdate_fromパラメータから開始されます。

例えば、 `date_start = \"2025-11-15T18:15:00+05:00\"`かつ`hours_interval = 2`の場合、アイテムの購入制限は`\"2025-11-15T20:15:00+05:00\"`から開始して2時間ごとにリセットされます。" } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = 毎時間", "type": "object" }, "per_user_hourly_vi": { "properties": { "hours_interval": { "allOf": [ { "$ref": "#/components/schemas/hours_interval" }, { "description": "制限がリセットされるまでの時間間隔。

カウントダウンはdate_fromパラメータから開始されます。

例えば、 `date_start = \"2025-11-15T18:15:00+05:00\"`かつ`hours_interval = 2`の場合、アイテムの購入制限は`\"2025-11-15T20:15:00+05:00\"`から開始して2時間ごとにリセットされます。" } ] }, "interval_type": { "$ref": "#/components/schemas/interval_type_hourly" } }, "required": [ "interval_type", "hours_interval" ], "title": "interval_type = 毎時間", "type": "object" }, "per_user_monthly": { "description": "ユーザー制限の月次更新タイプ。", "properties": { "day_of_month": { "description": "制限が更新される月の日。月の残り時間が短いために選択された日がない場合、更新はその月の最終日に行われます。", "maximum": 31, "minimum": 1, "type": "integer" }, "interval_type": { "description": "定期更新期間。", "enum": [ "monthly" ], "type": "string" }, "time": { "description": "希望するタイムゾーンでのリミットの更新時刻（時間単位で四捨五入）。", "example": "23:00:00+03:00", "pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])", "type": "string" } }, "required": [ "interval_type", "time", "day_of_month" ], "title": "interval_type = 毎月", "type": "object" }, "per_user_weekly": { "description": "ユーザー制限の週次更新タイプ。", "properties": { "day_of_week": { "description": "制限が更新される曜日。1は月曜日、7は日曜日です。", "maximum": 7, "minimum": 1, "type": "integer" }, "interval_type": { "description": "定期更新期間。", "enum": [ "weekly" ], "type": "string" }, "time": { "description": "希望するタイムゾーンでのリミットの更新時刻（時間単位で四捨五入）。", "example": "11:00:00+03:00", "pattern": "((0[0-9]|1[0-9]|2[0-3]):00:00)(\\+|-)(0[0-9]|1[0-9]|2[0-3]):([0-5][0-9])", "type": "string" } }, "title": "interval_type = 毎週", "type": "object" }, "request-attribute-value": { "example": { "external_id": "value_id", "value": { "de": "Wert", "en": "Value" } }, "properties": { "external_id": { "$ref": "#/components/schemas/value-external_id" }, "value": { "$ref": "#/components/schemas/value-name" } }, "required": [ "external_id", "value" ], "type": "object" }, "schemas-422-invalid-request": { "properties": { "errorCode": { "example": 1102, "type": "integer" }, "errorMessage": { "example": "[0401-1102]: Unprocessable Entity. The property `property_name` is required", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" }, "two-letter-locale": { "description": "2文字の小文字の言語コード。", "properties": { "ar": { "description": "アラビア語", "type": [ "string", "null" ] }, "bg": { "description": "ブルガリア語", "type": [ "string", "null" ] }, "cn": { "description": "中国語（簡体字）", "type": [ "string", "null" ] }, "cs": { "description": "チェコ語", "type": [ "string", "null" ] }, "de": { "description": "ドイツ語", "type": [ "string", "null" ] }, "en": { "description": "英語", "type": [ "string", "null" ] }, "es": { "description": "スペイン語（スペイン）", "type": [ "string", "null" ] }, "fr": { "description": "フランス語", "type": [ "string", "null" ] }, "he": { "description": "ヘブライ語", "type": [ "string", "null" ] }, "id": { "description": "インドネシア語", "type": [ "string", "null" ] }, "it": { "description": "イタリア語", "type": [ "string", "null" ] }, "ja": { "description": "日本語", "type": [ "string", "null" ] }, "km": { "description": "クメール語", "type": [ "string", "null" ] }, "ko": { "description": "韓国語", "type": [ "string", "null" ] }, "lo": { "description": "ラオス語", "type": [ "string", "null" ] }, "my": { "description": "ビルマ語", "type": [ "string", "null" ] }, "ne": { "description": "ネパール語", "type": [ "string", "null" ] }, "ph": { "description": "フィリピン語", "type": [ "string", "null" ] }, "pl": { "description": "ポーランド語", "type": [ "string", "null" ] }, "pt": { "description": "ポルトガル語", "type": [ "string", "null" ] }, "ro": { "description": "ルーマニア語", "type": [ "string", "null" ] }, "ru": { "description": "ロシア語", "type": [ "string", "null" ] }, "th": { "description": "タイ語", "type": [ "string", "null" ] }, "tr": { "description": "トルコ語", "type": [ "string", "null" ] }, "tw": { "description": "中国語（繁体字）", "type": [ "string", "null" ] }, "vi": { "description": "ベトナム語", "type": [ "string", "null" ] } }, "title": "two-letter", "type": [ "object", "null" ] }, "value-cart_is_free": { "default": false, "description": "`true`の場合で、カートは無料です。", "example": false, "type": "boolean" }, "value-external_id": { "description": "属性の一意の値ID。`external_id`には、英小文字、ダッシュ、およびアンダースコアのみが含まれます。", "example": "attribute_value", "maxLength": 255, "minLength": 1, "pattern": "^[-_.\\d\\w]+$", "type": "string" }, "value-is_free": { "default": false, "description": "アイテムが無料かどうか。", "example": false, "type": "boolean" }, "value-is_paid_randomized_reward": { "default": false, "description": "アイテムが、ルートボックスなどのランダムな有料報酬であるかどうか。", "example": false, "type": "boolean" }, "value-name": { "additionalProperties": { "type": "string" }, "default": { "de": "Strategie", "en": "Strategy" }, "description": "値名がローカライズされたオブジェクト。キーはISO 3166-1で指定されています。", "example": { "de": "Strategie", "en": "Strategy" }, "type": "object" }, "value-point-amount": { "description": "バリューポイントの量。", "type": "integer" }, "value-point-name": { "description": "バリューポイント名。", "type": "string" }, "value-point-sku": { "description": "一意のバリューポイントID。", "type": "string" }, "virtual_currency_package_recurrent_schedule": { "description": "制限更新期間。", "properties": { "per_user": { "description": "購入制限のリセットは、指定された時間間隔で実行されます。", "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" }, { "$ref": "#/components/schemas/per_user_hourly_vcp" } ] } }, "type": [ "object", "null" ] }, "virtual_currency_recurrent_schedule": { "description": "制限更新期間。", "properties": { "per_user": { "description": "購入制限のリセットは、指定された時間間隔で実行されます。", "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" }, { "$ref": "#/components/schemas/per_user_hourly_vc" } ] } }, "type": [ "object", "null" ] }, "virtual_item_recurrent_schedule": { "description": "制限更新期間。", "properties": { "per_user": { "description": "購入制限のリセットは、指定された時間間隔で実行されます。", "oneOf": [ { "$ref": "#/components/schemas/per_user_daily" }, { "$ref": "#/components/schemas/per_user_weekly" }, { "$ref": "#/components/schemas/per_user_monthly" }, { "$ref": "#/components/schemas/per_user_hourly_vi" } ] } }, "type": [ "object", "null" ] } }, "securitySchemes": { "AuthForCart": { "description": "`AuthForCart`認証スキームはカートでの購入用であり、以下の2つのモードに対応しています：\n\nユーザーのJWTによる認証。トークンは、以下の形式で認証ヘッダーに渡されます：`Authorization: Bearer `。「」はユーザー用トークンです。このトークンによってユーザーが識別され、パーソナライズされたデータへのアクセスが可能になります。以下のテスト用トークンを使用して、このAPIコールを試すことができます：`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。\n\n別の方法として、[決済UIを開くためのトークン](/ja/api/pay-station/token/create-token)を使用できます。\n\n`Authorization`ヘッダーなしの簡易モード。これは未認証ユーザー専用のモードであり、[ゲームキー販売(/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users)のケースにのみ利用できます。トークンの代わりに、リクエストには以下のヘッダーを含める必要があります：\n* リクエストIDを指定した`x-unauthorized-id`\n* Base64でエンコードされたユーザーのメールアドレスを指定した`x-user`", "scheme": "bearer", "type": "http" }, "XsollaLoginUserJWT": { "bearerFormat": "JWT", "description": "クライアント側からのAPIコールには、`XsollaLoginUserJWT`認証スキームを使用します。リクエストの`Authorization`ヘッダーには、「Bearer ``」という形式でユーザーのJWTを含める必要があります。このトークンによってユーザーが識別され、パーソナライズされたデータへのアクセスが可能になります。トークンの作成方法の詳細については、[エクソーラログインAPI](/ja/api/login/authentication-schemes#getting-user-token)に関するドキュメントをご参照ください。\n\n以下のテスト用トークンを使用して、このAPIコールを試すことができます：`Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI`。\n\n別の方法として、[決済UIを開くためのトークン](/ja/api/pay-station/token/create-token)を使用することも可能です。", "scheme": "bearer", "type": "http" }, "basicAuth": { "description": "サーバー側からのAPIコールには、`basicAuth`認証スキームを使用します。すべてのAPIリクエストには\n`Authorization: Basic `\nヘッダーを含める必要があります。ここで、`your_authorization_basic_key`は`project_id:api_key`\nのペアをBase64標準に従ってエンコードしたものです。\n\n必要に応じて、`project_id`の代わりに`merchant_id`を使用することができます。機能には影響しません。\n\n[パブリッシャーアカウント](https://publisher.xsolla.com/)に移動して、パラメータの値を確認します：\n\n* `merchant_id`が表示されます：\n * **会社設定 > 会社**セクションで\n * 任意のパブリッシャーアカウントページのブラウザアドレスバーにあるURL。URLは以下の形式です：`https://publisher.xsolla.com/`。\n* `api_key`は、作成時に一度だけパブリッシャーアカウントに表示され、お客様側で保存する必要があります。新しいキーは、次のセクションで作成することができます：\n * [会社設定 > APIキー](https://publisher.xsolla.com/0/settings/api_key)\n * [プロジェクト設定 > APIキー](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n{% html name=\"div\" attrs={\"class\": \"notice\"} %}\n**注意**\n\n必須のAPIコールに`project_id`パスパラメータが含まれていない場合は、会社全般のプロジェクトで有効なAPIキーを認証に使用してください。\n{% /html %}\n\n* `project_id`が以下の場所で表示されます：\n * パブリッシャーアカウント内のプロジェクト名の横。\n * パブリッシャーアカウントでプロジェクトを操作している際、ブラウザのアドレスバーに表示されるURLの中。URLの形式は以下の通りです：`https://publisher.xsolla.com//projects/`。\n\nAPIキーの操作に関する詳細は、[APIリファレンス](https://developers.xsolla.com/ja/api/getting-started/#api_keys_overview)を参照してください。", "scheme": "basic", "type": "http" }, "basicMerchantAuth": { "description": "サーバー側からのAPIコールには、`basicMerchantAuth`認証スキームを使用します。APIへのすべてのリクエストは\n`Authorization: Basic `\nヘッダーを含む必要があり、`your_authorization_basic_key`\nはBase64標準に従ってエンコードされた`merchant_id:api_key`ペアです。\n\n[パブリッシャーアカウント](https://publisher.xsolla.com/)に移動して、パラメータの値を確認します：\n\n* `merchant_id`が表示されます：\n * **会社設定 > 会社**セクションで\n * 任意のパブリッシャーアカウントページのブラウザアドレスバーにあるURL。URLは以下の形式です：`https://publisher.xsolla.com/`\n* `api_key`は、作成時に一度だけパブリッシャーアカウントに表示され、お客様側で保存する必要があります。[会社設定 > APIキー](https://publisher.xsolla.com/0/settings/api_key)セクションで、新しいキーを作成できます。\n\nAPIキーの操作に関する詳細は、[APIリファレンス](https://developers.xsolla.com/ja/api/getting-started/#api_keys_overview)を参照してください。", "scheme": "basic", "type": "http" } } }, "info": { "description": "# Overview\n\n- **Version:** 2.0.0\n- **Servers:** `https://store.xsolla.com/api`\n- [Contact Us by Email](mailto:integration@xsolla.com)\n- **Contact URL:** https://xsolla.com/\n- **Required TLS version:** 1.2\n\nThe Catalog API allows you to configure a catalog of in-game items on the Xsolla side and display the catalog to users in your store.\n\nThe API allows you to manage the following catalog entities:\n\n* **Virtual items** — in-game items such as weapons, skins, boosters.\n* **Virtual currency** — virtual money used to purchase virtual goods.\n* **Virtual currency packages** — predefined bundles of virtual currency.\n* **Bundles** — combined packages of virtual items, currency, or game keys sold as a single SKU.\n* **Game keys** — keys for games and DLCs distributed via platforms like Steam or other DRM providers.\n* **Groups** — logical groupings for organizing and sorting items within the catalog.\n\n## API calls\n\nThe API is divided into the following groups:\n\n* **Admin** — calls for creating, updating, deleting, and configuring catalog items and groups. Authenticated via [basic access authentication](https://developers.xsolla.com/ja/payment-ui-and-flow/payment-ui/how-to-get-payment-token/#payments_solution_get_user_auth_token_basic_auth) with your merchant or project credentials. Not intended for storefront use.\n* **Catalog** — calls for retrieving items and building custom storefronts for end users. Designed to handle high-load scenarios. Support optional user JWT authorization to return personalized data such as user-specific limits and active promotions.\n\n# Authentication\n\nAPI calls require authentication either on behalf of a user or on behalf of a project. The authentication scheme used is specified in the **Security** section in the description of each call.\n\n## Authentication using user's JWT\n\nUser's JWT authentication is used when a request is sent from a browser, mobile application, or game. By default, the `XsollaLoginUserJWT` scheme is applied. For details on how to create a token, see the [Xsolla Login API documentation](/ja/api/login/authentication-schemes#getting-user-token).\n\nThe token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/ja/api/pay-station/token/create-token).\n\n## Basic HTTP authentication\n\nBasic HTTP authentication is used for server-to-server interactions, when an API call is sent directly from your server rather than from a user's browser or mobile application. HTTP Basic authentication with an [API key](/ja/api/getting-started/#api_keys_overview) is typically used.\n\n
Note

The API key is confidential and must not be stored or used in client applications.
\n\nWith basic server-side authentication, all API requests must include the following header:\n\n- for `basicAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `project_id:api_key` pair encoded in Base64\n- for `basicMerchantAuth` — `Authorization: Basic `, where `your_authorization_basic_key` is the `merchant_id:api_key` pair encoded in Base64\n\nYou can find the parameter values in [Publisher Account](https://publisher.xsolla.com/):\n\n- `merchant_id` is displayed:\n - In **Company settings > Company**.\n - In the URL in the browser address bar on any Publisher Account page. The URL has the following format: `https://publisher.xsolla.com/`.\n- `project_id` is displayed:\n - Next to the project name in Publisher Account.\n - In the URL in the browser address bar when working on a project in Publisher Account. The URL has the following format: `https://publisher.xsolla.com//projects/`.\n- `api_key` is shown in Publisher Account only at the time of creation and must be stored securely on your side. You can create an API key in the following sections:\n - [Company settings > API keys](https://publisher.xsolla.com/0/settings/api_key)\n - [Project settings > API key](https://publisher.xsolla.com/0/projects/0/edit/api_key)\n\n
Notice

If a required API call doesn't include the project_id path parameter, use an API key that is valid across all company projects for authorization.
\n\nFor more information about working with API keys, see the [API references](/ja/api/getting-started/#api_keys_overview).\n\n## Authentication with guest access support\n\nThe `AuthForCart` authentication scheme is used for cart purchases and supports two modes:\n\n1. **Authentication with a user's JWT.** The token is passed in the `Authorization` header in the following format: `Authorization: Bearer `, where `` is the user token. The token identifies the user and provides access to personalized data. You can try this call using the following test token:\n```\neyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE5NjIyMzQwNDgsImlzcyI6Imh0dHBzOi8vbG9naW4ueHNvbGxhLmNvbSIsImlhdCI6MTU2MjE0NzY0OCwidXNlcm5hbWUiOiJ4c29sbGEiLCJ4c29sbGFfbG9naW5fYWNjZXNzX2tleSI6IjA2SWF2ZHpDeEVHbm5aMTlpLUc5TmMxVWFfTWFZOXhTR3ZEVEY4OFE3RnMiLCJzdWIiOiJkMzQyZGFkMi05ZDU5LTExZTktYTM4NC00MjAxMGFhODAwM2YiLCJlbWFpbCI6InN1cHBvcnRAeHNvbGxhLmNvbSIsInR5cGUiOiJ4c29sbGFfbG9naW4iLCJ4c29sbGFfbG9naW5fcHJvamVjdF9pZCI6ImU2ZGZhYWM2LTc4YTgtMTFlOS05MjQ0LTQyMDEwYWE4MDAwNCIsInB1Ymxpc2hlcl9pZCI6MTU5MjR9.GCrW42OguZbLZTaoixCZgAeNLGH2xCeJHxl8u8Xn2aI\n```\nAlternatively, you can use a [token for opening the payment UI](/ja/api/pay-station/token/create-token).\n\n2. **Simplified mode without Authorization header.** This mode is used only for unauthorized users and can be applied only for [game key sales](/ja/doc/buy-button/how-to/set-up-authentication/#guides_buy_button_selling_items_not_authenticated_users). Instead of a token, the request must include the following headers:\n - `x-unauthorized-id` with a request ID\n - `x-user` with the user's email address encoded in Base64\n\n## Useful links\n\n- [API calls by interaction model](https://developers.xsolla.com/ja/api/catalog/)\n- [Endpoint types](https://developers.xsolla.com/ja/api/catalog/)\n- [Errors handling](https://developers.xsolla.com/ja/api/catalog/)\n- [API keys](https://developers.xsolla.com/ja/api/catalog/)\n\n# Core entity structure\n\nItems of all types (virtual items, bundles, virtual currency, and keys) use a similar data structure. Understanding the basic structure simplifies working with the API and helps you navigate the documentation more easily.\n\n
Note

Some calls may include additional fields but they don't change the basic structure.
\n\n**Identification**\n\n- `merchant_id` — company ID in [Publisher Account](https://publisher.xsolla.com/)\n- `project_id` — project ID in Publisher Account\n- `sku` — item SKU, unique within the project\n\n**Store display**\n\n- `name` — item name\n- `description` — item description\n- `image_url` — image URL\n- `is_enabled` — item availability\n- `is_show_in_store` — whether the item is displayed in the catalog\n\nFor more information about managing item availability in the catalog, see the [documentation](/ja/items-catalog/catalog-features/items-availability/).\n\n**Organization**\n\n- `type` — item type, for example, a virtual item (`virtual_item`) or bundle (`bundle`)\n- `groups` — groups the item belongs to\n- `order` — display order in the catalog\n\n**Sale conditions**\n\n- `prices` — prices in real or virtual currency\n- `limits` — purchase limits\n- `periods` — availability periods\n- `regions` — regional restrictions\n\n**Example of core entity structure:**\n\n```json\n{\n \"attributes\": [],\n \"bundle_type\": \"virtual_currency_package\",\n \"content\": [\n {\n \"description\": {\n \"en\": \"Main in-game currency\"\n },\n \"image_url\": \"https://.../image.png\",\n \"name\": {\n \"en\": \"Crystals\",\n \"de\": \"Kristalle\"\n },\n \"quantity\": 500,\n \"sku\": \"com.xsolla.crystal_2\",\n \"type\": \"virtual_currency\"\n }\n ],\n \"description\": {\n \"en\": \"Crystals x500\"\n },\n \"groups\": [],\n \"image_url\": \"https://.../image.png\",\n \"is_enabled\": true,\n \"is_free\": false,\n \"is_show_in_store\": true,\n \"limits\": {\n \"per_item\": null,\n \"per_user\": null,\n \"recurrent_schedule\": null\n },\n \"long_description\": null,\n \"media_list\": [],\n \"name\": {\n \"en\": \"Medium crystal pack\"\n },\n \"order\": 1,\n \"periods\": [\n {\n \"date_from\": null,\n \"date_until\": \"2020-08-11T20:00:00+03:00\"\n }\n ],\n \"prices\": [\n {\n \"amount\": 20,\n \"country_iso\": \"US\",\n \"currency\": \"USD\",\n \"is_default\": true,\n \"is_enabled\": true\n }\n ],\n \"regions\": [],\n \"sku\": \"com.xsolla.crystal_pack_2\",\n \"type\": \"bundle\",\n \"vc_prices\": []\n}\n```\n# Basic purchase flow\n\nThe Xsolla API allows you to implement in-game store logic, including retrieving the item catalog, managing the cart, creating orders, and tracking their status. Depending on the integration scenario, API calls are divided into **Admin** and **Catalog** subsections, which use different [authentication schemes](/ja/api/catalog/section/authentication).\n\nThe following example shows a basic flow for setting up and operating a store, from item creation to purchase.\n\n## Create items and groups (Admin)\n\nCreate an item catalog for your store, such as virtual items, bundles, or virtual currency.\n\nExample API calls:\n- [Create virtual item](/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-item)\n- [Create bundle](/ja/api/catalog/bundles-admin/admin-create-bundle)\n- [Create virtual currency](/ja/api/catalog/virtual-items-currency-admin/admin-create-virtual-currency)\n\n## Set up promotions, chains, and limits (Admin)\n\nConfigure user acquisition and monetization tools, such as discounts, bonuses, daily rewards, or offer chains.\n\nExample API calls:\n- [Create bonus promotion](/ja/api/liveops/promotions-bonuses/create-bonus-promotion)\n- [Create daily reward](/ja/api/liveops/daily-chain-admin/admin-create-daily-chain)\n- [Create unique catalog offer promotion](/ja/api/liveops/promotions-unique-catalog-offers/admin-create-unique-catalog-offer)\n\n## Get item information (Client)\n\nConfigure item display in your application.\n\n
\n Notice

\n Do not use API calls from the Admin subsection to build a user catalog. These API calls have rate limits and aren't intended for user traffic.\n
\n
\n\nExample API calls:\n- [Get virtual items list](/ja/api/catalog/virtual-items-currency-catalog/get-virtual-items)\n- [Get item group list](/ja/api/catalog/virtual-items-currency-catalog/get-item-groups)\n- [Get list of bundles](/ja/api/catalog/bundles-catalog/get-bundle-list)\n- [Get sellable items list](/ja/api/catalog/common-catalog/get-sellable-items)\n\n
\n Note

\n By default, catalog API calls return items that are currently available in the store at the time of the request. To retrieve items that are not yet available or are no longer available, include the parameter \"show_inactive_time_limited_items\": 1 in the catalog request.\n
\n\n## Sell items\n\nYou can sell items using the following methods:\n- Fast purchase — sell one SKU multiple times.\n- Cart purchase — the user adds items to the cart, removes items, and updates quantities within a single order.\n\nIf an item is purchased using virtual currency instead of real money, use the [Create order with specified item purchased by virtual currency](/ja/api/catalog/virtual-payment/create-order-with-item-for-virtual-currency) API call. The payment UI is not required, as the charge is processed when the API call is executed.\n\nFor free item purchase, use the [Create order with specified free item](/ja/api/catalog/free-item/create-free-order-with-item) API call or the [Create order with free cart](/ja/api/catalog/free-item/create-free-order) API call. The payment UI is not required — the order is immediately set to the done status.\n\n### Fast purchase\n\nUse the client-side API call to [create an order with a specified item](/ja/api/catalog/payment-client-side/create-order-with-item). The call returns a token used to open the payment UI.\n\n
\n Note

\n Discount information is available to the user only in the payment UI. Promo codes are not supported.\n
\n\n### Cart purchase\n\nCart setup and purchase can be performed on the client or on the server side.\n\n**Set up and purchase a cart on the client**\n\nImplement the logic of adding and removing items by yourself. Before calling the API for setting up a cart, you will not have information about which promotions will be applied to the purchase. This means that the total cost and details of the added bonus items will not be known.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/ja/api/shop-builder/operation/cart-fill/) API call. The call returns the current information about the selected items (prices before and after discounts, bonus items).\n2. Update the cart contents based on user actions:\n - To add an item or change item quantity, use the [Update cart item by cart ID](/ja/api/shop-builder/operation/put-item-by-cart-id/) API call.\n - To remove an item, use the [Delete cart item by cart ID](/ja/api/shop-builder/operation/delete-item-by-cart-id/) API call.\n\n
\n Note

\n To get the current status of the cart, use the Get current user's cart API call.\n
\n\n3. Use the [Create order with all items from current cart](/ja/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n**Set up and purchase a cart on the server**\n\nThis setup option may take longer for setting the cart up, since each change to the cart must be accompanied by API calls.\n\nImplement the following cart logic:\n1. After the player has filled a cart, use the [Fill cart with items](/ja/api/catalog/cart-server-side) API call. The call returns current information about the selected items (prices before and after discounts, bonus items).\n2. Use the [Create order with all items from current cart](/ja/api/shop-builder/operation/create-order/) API call. The call returns the order ID and payment token. The newly created order is set to new status by default.\n\n## Open payment UI\n\nUse the returned token to open the payment UI in a new window. Other ways to open the payment UI are described in the [documentation](/ja/payment-ui-and-flow/payment-ui/how-to-open-payment-ui/#open_payment_ui).\n\n| Action | Endpoint |\n|:--------------------------------|:--------------------------------------------------------------------------|\n| Open in production environment. | https://secure.xsolla.com/paystation4/?token={token} |\n| Open in sandbox mode. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |\n\n
\n Note

\n Use sandbox mode during development and testing. Test purchases don't charge real accounts. You can use test bank cards.\n\n After the first real payment is made, a strict sandbox payment policy takes effect. A payment in sandbox mode is available only to users specified in [Publisher Account > Company settings > Users](https://publisher.xsolla.com/0/settings/users).\n\n Buying virtual currency and items for real currency is possible only after signing a license agreement with Xsolla. To do this, in [Publisher Account](https://publisher.xsolla.com/), go to **Agreements & Taxes > Agreements**, complete the agreement form, and wait for confirmation. It may take up to 3 business days to review the agreement.\n
\n\nTo enable or disable sandbox mode, change the value of the `sandbox` parameter in the request for fast purchase and cart purchase. Sandbox mode is off by default.\n\nPossible order statuses:\n- `new` — order created\n- `paid` — payment received\n- `done` — item delivered\n- `canceled` — order canceled\n- `expired` — payment expired\n\nTrack order status using one of the following methods:\n- [webhooks configured on your server](/ja/virtual-goods/own-ui/server-side-token-generation/set-up-order-tracking/#payments_integration_order_tracking)\n- [short-polling](/ja/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_short_polling)\n- [WebSocket API](/ja/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/#guides_shop_builder_integrate_store_get_order_status_via_websocket_api)\n\n## Useful links\n\n- Authentication\n- [API calls by interaction model](/ja/api/catalog/section/authentication)\n- [Payment testing](/ja/dev-resources/testing/general-info/#general_overview)\n- [Set up order status tracking](/ja/virtual-goods/own-ui/client-side-token-generation/set-up-order-tracking/?link=200-api#payments_integration_order_tracking)\n- [Webhooks](/ja/webhooks/overview)\n- [Rate limits](/ja/api/login/rate-limits)\n- [Errors handling](/ja/api/getting-started/#api_errors_handling)\n- [API keys](/ja/api/getting-started/#api_keys_overview)\n\n# Pagination\n\nAPI calls that return large sets of records (for example, when building a catalog) return data in pages. Pagination is a mechanism that limits the number of items returned in a single API response and allows you to retrieve subsequent pages sequentially.\n\nUse the following parameters to control the number of returned items:\n\n- `limit` — number of items per page\n- `offset` — index of the first item on the page (numbering starts from 0)\n- `has_more` — indicates whether another page is available\n- `total_items_count` — total number of items\n\nExample request:\n\n```\nGET /items?limit=20&offset=40\n```\n\nResponse example:\n\n```json\n{\n \"items\": [...],\n \"has_more\": true,\n \"total_items_count\": 135\n}\n```\n\nIt is recommended to send subsequent requests until the response returns `has_more = false`.\n\n# Date and time format\n\nDates and time values are passed in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.\n\nThe following are supported:\n\n- UTC offset\n- `null` value when there is no time restriction for displaying an item\n- [Unix timestamp](https://www.unixtimestamp.com/) (in seconds) used in some fields\n\nFormat: `YYYY-MM-DDTHH:MM:SS±HH:MM`\n\nExample: `2026-03-16T10:00:00+03:00`\n\n# Localization\n\nXsolla supports localization of user-facing fields such as item name and description. Localized values are passed as an object where the language code is used as the key. The full list of supported languages is available in the [documentation](/ja/doc/shop-builder/references/supported-languages/).\n\n**Supported fields**\n\nLocalization can be specified for the following parameters:\n\n- `name`\n- `description`\n- `long_description`\n\n**Locale format**\n\nThe locale key can be specified in one of the following formats:\n\n- Two-letter language code: `en`, `ru`\n- Five-letter language code: `en-US`, `ru-RU`, `de-DE`\n\n**Examples**\n\nExample with a two-letter language code:\n\n```json\n{\n \"name\": {\n \"en\": \"Starter Pack\",\n \"ru\": \"Стартовый набор\"\n }\n}\n```\n\nExample with a five-letter language code:\n\n```json\n{\n \"description\": {\n \"en-US\": \"Premium bundle\",\n \"de-DE\": \"Premium-Paket\"\n }\n}\n```\n\n# Error response format\n\nIf an error occurs, the API returns an HTTP status and a JSON response body. The full list of store-related errors is available in the [documentation](/ja/dev-resources/references/errors/store-errors/).\n\n**Response example:**\n\n```json\n{\n \"errorCode\": 1102,\n \"errorMessage\": \"Validation error\",\n \"statusCode\": 422,\n \"transactionId\": \"c9e1a...\"\n}\n```\n\n- `errorCode` — error code.\n- `errorMessage` — short error description.\n- `statusCode` — HTTP response status.\n- `transactionId` — request ID. Returned only in some cases.\n- `errorMessageExtended` — additional error details, such as request parameters. Returned only in some cases.\n\n**Extended response example:**\n\n```json\n{\n \"errorCode\": 7001,\n \"errorMessage\": \"Chain not found\",\n \"errorMessageExtended\": {\n \"chain_id\": \"test_chain_id\",\n \"project_id\": \"test_project_id\",\n \"step_number\": 2\n },\n \"statusCode\": 404\n}\n```\n\n**Common HTTP status codes**\n\n- `400` — invalid request\n- `401` — authentication error\n- `403` — insufficient permissions\n- `404` — resource not found\n- `422` — validation error\n- `429` — rate limit exceeded\n\n**Recommendations**\n\n- Handle the HTTP status and the response body together.\n- Use `errorCode` to process errors related to application logic.\n- Use `transactionId` to identify requests more quickly when analyzing errors.", "title": "Catalog API", "version": "2.0.0" }, "openapi": "3.1.0", "paths": { "/v1/admin/projects/{project_id}/connectors/import_items/import/status": { "get": { "description": "プロジェクトへのアイテムのインポートの進行状況に関する情報を取得します。このAPIコールでは、APIまたはPublisher Account APIを通じて最後に実行されたインポートに関するデータを取得します。", "operationId": "get-items-import-status", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-items-import-status-model" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "servers": [ { "url": "https://connector.xsolla.com" } ], "summary": "アイテムのインポート状況を取得する", "tags": [ "connector-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v1/projects/{project_id}/import/from_external_file": { "post": { "description": "指定したURLを介してJSONファイルからストアにアイテムをインポートします。JSONファイルからのインポートの詳細については、[ドキュメント](https://developers.xsolla.com/ja/doc/shop-builder/how-to/json-import/)を参照してください。", "operationId": "import-items-from-external-file", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/connector-import-items-body" }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "import_id": { "description": "操作IDをインポートします。JSONファイルのインポートに問題が発生した場合は、このIDをカスタマーサクセスマネージャーに報告するか、csm@xsolla.comまでメールを送信してください。", "example": "af9f3638a16e11ef880da2cd677d2d24", "type": "string" } }, "type": "object" } } }, "description": "ファイルは正常にインポートされ、現在処理中です。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/connector-422-validation-failed" } }, "security": [ { "basicAuth": [] } ], "servers": [ { "url": "https://connector.xsolla.com" } ], "summary": "JSONファイル経由でアイテムをインポートする", "tags": [ "connector-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/admin/project/{project_id}/cart/fill": { "put": { "description": "現在のカートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。", "operationId": "admin-cart-fill", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/x-user-for-header" }, { "$ref": "#/components/parameters/x-user-id-header" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model" }, "401": { "$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-user" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } }, "security": [ { "basicAuth": [] } ], "summary": "カートにアイテムを入れる", "tags": [ "cart-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } }, "/v2/admin/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "カートIDによるカートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。", "operationId": "admin-fill-cart-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/x-user-for-header" }, { "$ref": "#/components/parameters/x-user-id-header" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_admin-fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-admin-fill-cart-json-model" }, "401": { "$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-user" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } }, "security": [ { "basicAuth": [] } ], "summary": "カートIDでカートにアイテムを入れる", "tags": [ "cart-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } }, "/v2/merchant/{merchant_id}/projects": { "get": { "description": "マーチャントのプロジェクトのリストを取得します。\n\n
\n

注意

このAPIコールには、project_idパスパラメータが含まれていないため、会社の全プロジェクトで有効なAPIキーを使用して認可を設定する必要があります。

\n
", "operationId": "get-projects", "parameters": [ { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/merchant_id-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "has_more": false, "items": [ { "project_id": 17558 }, { "project_id": 17559 } ], "total_items_count": 2 } } }, "schema": { "properties": { "has_more": { "example": true, "type": "boolean" }, "items": { "properties": { "project_id": { "example": 17558, "type": "integer" } }, "type": "array" }, "total_items_count": { "example": 3, "type": "integer" } }, "type": "object" } } }, "description": "プロジェクトに関する情報は正常に受信されました。" }, "401": { "description": "基本認証が不合格または不正です。基本認証または正しい認証情報を使用したことを確認してください。" }, "422": { "description": "`limit`または `offset`クエリパラメータが無効です。" } }, "security": [ { "basicMerchantAuth": [] } ], "summary": "プロジェクトを取得", "tags": [ "common-merchant" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute": { "get": { "description": "管理用プロジェクトから属性のリストを取得します。", "operationId": "admin-get-attribute-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-attribute-list-response" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "属性リストを取得する（管理者）", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "属性を作成します。", "operationId": "admin-create-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-validation-failed" } }, "security": [ { "basicAuth": [] } ], "summary": "属性を作成", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}": { "delete": { "description": "属性を削除します。\n
注意

アイテム属性を削除すると、そのすべてのデータおよびアイテムとの関連付けが失われます。
", "operationId": "delete-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "responses": { "204": { "description": "属性が正常に削除されました。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "属性を削除", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "指定された属性を取得します。", "operationId": "admin-get-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-attribute-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "指定された属性を取得", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "属性を更新します。", "operationId": "admin-update-attribute", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute" }, "responses": { "204": { "$ref": "#/components/responses/204-admin-update-attribute" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/422-validation-failed" } }, "security": [ { "basicAuth": [] } ], "summary": "属性を更新", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}/value": { "delete": { "description": "属性のすべての値を削除します。\n
注意

属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。
", "operationId": "admin-delete-all-attribute-value", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "responses": { "204": { "description": "属性値が正常に削除されました。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" } }, "security": [ { "basicAuth": [] } ], "summary": "属性値をすべて削除", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "属性値を作成します。\n\n
注意

すべてのプロジェクトには、応答で得られる属性値に制限があります。初期値および最大値は、1属性あたり20個の値。
", "operationId": "admin-create-attribute-value", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute-value" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-attribute-value" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" }, "404": { "$ref": "#/components/responses/404-attribute-not-found" }, "422": { "$ref": "#/components/responses/422-create-update-attribute-value" } }, "security": [ { "basicAuth": [] } ], "summary": "属性値を作成", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/attribute/{external_id}/value/{value_external_id}": { "delete": { "description": "一つの属性値を削除します。\n
注意

属性の値を削除すると、その属性とアイテム間のすべての関連付けが失われます。アイテムの属性値を変更するには、値を削除して新しい値を作成するのではなく、属性値を更新するAPIコールを使用してください。
", "operationId": "admin-delete-attribute-value", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_external_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "responses": { "204": { "description": "属性値が正常に削除されました。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" } }, "security": [ { "basicAuth": [] } ], "summary": "属性値を削除", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "属性値を更新します。", "operationId": "admin-update-attribute-value", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/value_external_id-path-param" }, { "$ref": "#/components/parameters/external_id-attr-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-attribute-value" }, "responses": { "204": { "description": "属性値が正常に更新されました。" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "403": { "$ref": "#/components/responses/403-auth-header-not-sent" }, "404": { "$ref": "#/components/responses/404-attribute-value-not-found" }, "422": { "$ref": "#/components/responses/422-create-update-attribute-value" } }, "security": [ { "basicAuth": [] } ], "summary": "属性値を更新", "tags": [ "attribute-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/entitlement/grant": { "post": { "description": "ユーザーに権利を付与します。\n\n
注意

ゲームコードやDRM-freeプラットフォームのゲームのみ付与可能です。
", "operationId": "grant-entitlement-admin", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "code": "AAAA-BBBB-CCCC-DDDD", "drm": { "sku": "com.xsolla.key_1" }, "game": { "sku": "com.xsolla.game_1" }, "mode": "default", "user_country": "US", "user_external_id": "user-external-id" }, "properties": { "code": { "description": "ゲームのゲームコード。", "example": "AAAA-BBBB-CCCC-DDDD", "type": [ "string", "null" ] }, "drm": { "description": "DRMプロパティを持つオブジェクト。", "example": { "drm": { "sku": "com.xsolla.key_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "required": [ "sku" ], "type": "object" }, "game": { "description": "ゲームプロパティを持つオブジェクト。", "example": { "game": { "sku": "com.xsolla.game_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "required": [ "sku" ], "type": "object" }, "mode": { "description": "どのような種類の資格を付与するかを指定します。このパラメータが`sandbox`に設定されている場合、サンドボックスモードのユーザーにエンタイトルメントが付与されます。パラメータに`default`が設定されている場合、エンタイトルメントはライブモードでユーザーに付与されます。", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "user_country": { "description": "ユーザーの国。", "example": "US", "type": [ "string", "null" ] }, "user_external_id": { "description": "一意のユーザー識別子。", "example": "user-external-id", "type": "string" } }, "required": [ "user_external_id", "game", "drm", "mode" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "資格が付与されました。" }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "404": { "content": { "application/json": { "examples": { "Game code not found": { "$ref": "#/components/examples/404-game-code-not-found" }, "Game not found": { "value": { "errorCode": 4604, "errorMessage": "[0401-4604]: Game not found.", "statusCode": 404, "transactionId": "transaction id" } } }, "schema": { "properties": { "errorCode": { "example": 4603, "type": "integer" }, "errorMessage": { "example": "[0401-4603]: Game code not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "ゲームコードが見つかりません。`code`と `project_id` が正しいことを確認してください。" }, "422": { "content": { "application/json": { "examples": { "DRM is not DRM free": { "$ref": "#/components/examples/422-drm-is-not-drm-free" }, "User already has entitlement": { "$ref": "#/components/examples/422-user-already-has-entitlement" } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "basicAuth": [] } ], "summary": "資格付与（管理者）", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/entitlement/revoke": { "post": { "description": "ユーザーの権利を取り消します。\n\n
注意

ゲームコードやDRMフリープラットフォームのゲームのみ取り消すことができます。
", "operationId": "revoke-entitlement-admin", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "example": { "drm": { "sku": "com.xsolla.key_1" }, "game": { "sku": "com.xsolla.game_1" }, "mode": "default", "user_external_id": "user-external-id" }, "properties": { "drm": { "description": "DRMプロパティを持つオブジェクト。", "example": { "drm": { "sku": "com.xsolla.key_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_drm_sku" } }, "required": [ "sku" ], "type": "object" }, "game": { "description": "ゲームプロパティを持つオブジェクト。", "example": { "game": { "sku": "com.xsolla.game_1" } }, "properties": { "sku": { "$ref": "#/components/schemas/Game-Keys_game_sku" } }, "required": [ "sku" ], "type": "object" }, "mode": { "description": "どのような種類の資格を取り消すかを指定します。このパラメータが`sandbox`に設定されている場合、サンドボックスモードのユーザーにエンタイトルメントが取り消されます。パラメータに`default`が設定されている場合、エンタイトルメントはライブモードでユーザーに取り消されます。", "enum": [ "default", "sandbox" ], "example": "default", "type": "string" }, "user_external_id": { "description": "一意のユーザー識別子。", "example": "user-external-id", "type": "string" } }, "required": [ "user_external_id", "game", "drm", "mode" ], "type": "object" } } }, "required": true }, "responses": { "204": { "description": "取り消しが成功しました。" }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "422": { "content": { "application/json": { "examples": { "DRM is not DRM free": { "value": { "errorCode": 5103, "errorMessage": "[0401-5103]: Selected drm is not drmfree.", "statusCode": 422, "transactionId": "transaction id" } } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "basicAuth": [] } ], "summary": "資格の取り消し（管理者）", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/id/{id}/order/item": { "put": { "description": "Sets the display order of items within a group identified by its internal numeric ID. Pass an array of items with their new order values.", "operationId": "admin-reorder-items-in-group-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/id-group-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_item_order" }, "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-reorder-items" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-reorder-items-by-id-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-ordering" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder items within a group (by ID)", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/order": { "put": { "description": "Sets the display order for item groups within a project. Pass an array of groups with their new order values.", "operationId": "admin-reorder-item-groups", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_order" }, "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-reorder-groups" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-reorder-groups-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-ordering" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder item groups", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/group/{external_id}/order/item": { "put": { "description": "Sets the display order of items within a group identified by its external ID. Pass an array of items with their new order values.", "operationId": "admin-reorder-items-in-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_item_order" }, "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-reorder-items" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-reorder-items-by-external-id-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-ordering" } }, "security": [ { "basicAuth": [] } ], "summary": "Reorder items within a group (by external ID)", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle": { "get": { "description": "管理用のプロジェクト内のバンドルリストを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-bundle-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "バンドルのリストを取得", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "バンドルを作成します。", "operationId": "admin-create-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Bundles_bundle" }, "responses": { "201": { "$ref": "#/components/responses/Bundles_201-admin-create-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Bundles_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "バンドルを作成", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/group/external_id/{external_id}": { "get": { "description": "管理用のグループ内のバンドルリストを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-bundle-list-in-group-by-external-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "指定されたグループexternal IDのバンドルリストを取得する", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}": { "get": { "description": "管理用のグループ内のバンドルリストを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-bundle-list-in-group-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/group_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle-list-in-group" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "指定されたグループIDのバンドルリストを取得する", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}": { "delete": { "description": "バンドルを削除します。", "operationId": "admin-delete-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-delete-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "バンドルを削除", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "管理用プロジェクト内のバンドルを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-admin-get-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "バンドルを取得", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "バンドルを更新します。", "operationId": "admin-update-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Bundles_bundle" }, "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-update-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Bundles_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "バンドルを更新", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}/hide": { "put": { "description": "カタログにバンドルを非表示します。", "operationId": "admin-hide-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-hide-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "カタログにバンドルを非表示", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/bundle/sku/{sku}/show": { "put": { "description": "カタログにバンドルを表示します。", "operationId": "admin-show-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/Bundles_204-admin-show-bundle" }, "401": { "$ref": "#/components/responses/Bundles_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "カタログにバンドルを表示", "tags": [ "bundles-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game": { "get": { "description": "管理用プロジェクト内のゲームのリストを取得します。\nゲームは、ユーザーが購入可能なゲームキーで構成されています。\n\n
注意

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-game-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-games-list" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "ゲームリストを取得する（管理者）", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "プロジェクト内のゲームを作成します。", "operationId": "admin-create-game", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Game-Keys_create-update-game-model" }, "responses": { "201": { "content": { "application/json": { "examples": { "response": { "value": { "item_id": 101, "sku": "com.xsolla.game_1" } } }, "schema": { "properties": { "item_id": { "example": 101, "type": "integer" }, "sku": { "example": "com.xsolla.game_1", "type": "string" } }, "type": "object" } } }, "description": "ゲームが正常に作成されました。" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "ゲームを作成", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/id/{item_id}": { "delete": { "description": "IDによるプロジェクト内のゲームを削除します。", "operationId": "admin-delete-game-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "responses": { "204": { "description": "ゲームは正常に削除されました。" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "IDによるゲームを削除", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "管理用ゲームを取得します。\nゲームは、ユーザーが購入可能なゲームキーで構成されています。\n\n
注意

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-game-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with id = 1 not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 1 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "IDでゲームを取得する（管理者）", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "IDによるプロジェクト内のゲームを更新します。", "operationId": "admin-update-game-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Game-Keys_create-update-game-model" }, "responses": { "201": { "description": "ゲームは正常に更新されました。" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with id = 1 not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with id = 1 not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームが見つかりません。" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "IDによるゲームを更新", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/delete/id/{item_id}": { "delete": { "description": "ゲームキーIDによりすべてのコードを削除します。", "operationId": "admin-delete-codes-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" }, { "$ref": "#/components/parameters/user_email-query-param" }, { "$ref": "#/components/parameters/reason-query-param" }, { "$ref": "#/components/parameters/region_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-codes" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームキーまたはリージョンが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "IDによるコードを削除", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/delete/sku/{item_sku}": { "delete": { "description": "ゲームキーSKUによる全コードを削除します。", "operationId": "admin-delete-codes-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/user_email-query-param" }, { "$ref": "#/components/parameters/reason-query-param" }, { "$ref": "#/components/parameters/region_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-codes" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームキーまたはリージョンが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "コードを削除", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/request/id/{item_id}": { "get": { "description": "ゲームキーIDによる一定数のコードを取得します。", "operationId": "admin-get-codes-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" }, { "$ref": "#/components/parameters/user_email-query-param" }, { "$ref": "#/components/parameters/quantity-query-param" }, { "$ref": "#/components/parameters/reason-query-param" }, { "$ref": "#/components/parameters/region_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-codes" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームキーまたはリージョンが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "IDによるコードを取得", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/request/sku/{item_sku}": { "get": { "description": "ゲームキーSKUによる一定数のコードを取得します。", "operationId": "admin-get-codes-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/user_email-query-param" }, { "$ref": "#/components/parameters/quantity-query-param" }, { "$ref": "#/components/parameters/reason-query-param" }, { "$ref": "#/components/parameters/region_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-codes" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームキーまたはリージョンが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "コードを取得", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/id/{item_id}": { "post": { "description": "ゲームキーIDによるコードをアップロードします。", "operationId": "admin-upload-codes-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_id-path-param" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "example": { "file": "keys.txt", "region_id": 1 }, "properties": { "file": { "description": "コードを含むファイル。", "format": "binary", "type": "string" }, "region_id": { "description": "リージョンID。", "type": "integer" } }, "required": [ "file" ], "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームキーまたはリージョンが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "IDによるコードをアップロード", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/session/{session_id}": { "get": { "description": "コード読み込みセッションに関する情報を取得します。", "operationId": "admin-get-codes-session", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "セッションID。", "in": "path", "name": "session_id", "required": true, "schema": { "default": "fc7105b6e8ee01339582970b37697242", "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "description": "コード読み込みセッションが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "コード読み込みセッションに関する情報を取得", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/key/upload/sku/{item_sku}": { "post": { "description": "ゲームキーSKUによるコードをアップロードします。", "operationId": "admin-upload-codes-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "example": { "file": "keys.txt", "region_id": 1 }, "properties": { "file": { "description": "コードを含むファイル。", "format": "binary", "type": "string" }, "region_id": { "description": "リージョンID。", "type": "integer" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-session-information" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームキーまたはリージョンが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "コードをアップロード", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/game/sku/{item_sku}": { "delete": { "description": "SKUによるプロジェクト内のゲームを削除します。", "operationId": "admin-delete-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "ゲームは正常に削除されました。" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "ゲームをSKUで削除", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "管理用ゲームを取得します。\nゲームは、ユーザーが購入可能なゲームキーで構成されています。\n\n
注意

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-admin-get-game-by-sku" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "ゲームを取得する（管理者）", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "SKUによるプロジェクト内のゲームを更新します。", "operationId": "admin-update-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Game-Keys_create-update-game-model" }, "responses": { "201": { "description": "ゲームは正常に更新されました。" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームが見つかりません。" }, "422": { "$ref": "#/components/responses/Game-Keys_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "SKUによるゲームを更新", "tags": [ "game-keys-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/groups": { "get": { "description": "Retrieves the full list of item groups within a project without pagination. For administrative purposes.\n
Note

Do not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead.
", "operationId": "admin-get-item-group-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-list" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "アイテムグループリストを取得する", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "Creates an item group within a project.\nTo retrieve item groups for building a catalog, use the Get item group list client-side endpoint.", "operationId": "admin-create-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_create" }, "responses": { "201": { "$ref": "#/components/responses/ItemGroup_201-admin-create-group" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/ItemGroup_422-create-update" } }, "security": [ { "basicAuth": [] } ], "summary": "Create item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/groups/{external_id}": { "delete": { "description": "Deletes an item group by its external ID.", "operationId": "admin-delete-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-delete-group" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-group-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-delete" } }, "security": [ { "basicAuth": [] } ], "summary": "Delete item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "Retrieves an item group by its external ID for administrative purposes.\n
Note

Do not use this endpoint for building a store catalog. Use the Get item group list client-side endpoint instead.
", "operationId": "admin-get-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-group-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group by external ID", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "Updates an item group by its external ID.", "operationId": "admin-update-item-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/ItemGroup_update" }, "responses": { "204": { "$ref": "#/components/responses/ItemGroup_204-admin-update-group" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-group-not-found" }, "422": { "$ref": "#/components/responses/ItemGroup_422-create-update" } }, "security": [ { "basicAuth": [] } ], "summary": "Update item group", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}": { "delete": { "description": "アイテムの先行予約制限の数量を削除します。\n\nPre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 仮想通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)\n\nこのエンドポイントの別名：\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "operationId": "remove-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "削除する数量。", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "204": { "description": "制限する数量が正常に削除されました。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "アイテムが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "アイテムの先行予約制限の数量を削除", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "アイテムの先行予約制限の取得を設定します。\n\nPre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 仮想通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)\n\nこのエンドポイントの別名：\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "operationId": "get-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "available": 431, "is_pre_order_limit_enabled": true, "item_id": 1, "reserved": 13, "sku": "com.xsolla.item_1", "sold": 556 } } }, "schema": { "properties": { "available": { "example": 431, "type": "integer" }, "is_pre_order_limit_enabled": { "example": true, "type": "boolean" }, "item_id": { "example": 1, "type": "integer" }, "reserved": { "example": 13, "type": "integer" }, "sku": { "example": "com.xsolla.item_1", "type": "string" }, "sold": { "example": 556, "type": "integer" } }, "type": "object" } } }, "description": "アイテム先行予約制限に関する情報が正常に受信されました。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "アイテムが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "アイテム先行予約制限に関する情報を取得", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "アイテムの先行予約数に数量を追加します。\n\nPre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 仮想通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)\n\nこのエンドポイントの別名：\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "operationId": "add-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "追加する数量。", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "201": { "description": "制限する数量が正常に追加されました。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "アイテムが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "アイテム先行予約制限に数量を追加", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "アイテムの先行予約制限の数量を設定します。\n\nPre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 仮想通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)\n\nこのエンドポイントの別名：\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}", "operationId": "set-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "quantity": 100000 }, "schema": { "properties": { "quantity": { "description": "設定する数量。", "type": "integer" } }, "required": [ "quantity" ], "type": "object" } } } }, "responses": { "204": { "description": "制限する数量が正常に設定されました。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "アイテムが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "アイテムの先行予約制限の数量を設定", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/all": { "delete": { "description": "アイテムの先行予約制限のすべての数量を削除します。\n\nPre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 仮想通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)\n\nこのエンドポイントの別名：\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all", "operationId": "remove-all-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "制限の削除に成功しました。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "アイテムが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "アイテムの先行予約制限の数量をすべて削除", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/pre_order/limit/item/sku/{item_sku}/toggle": { "put": { "description": "アイテムの先行予約制限を有効/無効にします。\n\nPre-Order limit APIは、アイテムを数量限定で販売するためのAPIです。先行予約の設定は、該当するアイテムモジュールの管理セクションから行います：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)\n\nこのエンドポイントの別名：\n* /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle", "operationId": "toggle-pre-order-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "content": { "application/json": { "example": { "is_pre_order_limit_enabled": true }, "schema": { "properties": { "is_pre_order_limit_enabled": { "type": "boolean" } }, "required": [ "is_pre_order_limit_enabled" ], "type": "object" } } } }, "responses": { "204": { "description": "制限が無効/有効になりました。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "description": "アイテムが見つかりません。" } }, "security": [ { "basicAuth": [] } ], "summary": "アイテムの先行予約制限をトグル", "tags": [ "common-pre-orders" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency": { "get": { "description": "管理用のプロジェクト内の仮想通貨リストを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-virtual-currencies-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currencies" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨のリストを取得する", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "仮想通貨を作成します。", "operationId": "admin-create-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency" }, "responses": { "201": { "$ref": "#/components/responses/Virtual-Items-Currency_201-created" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨を作成", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/package": { "get": { "description": "管理用のプロジェクト内の仮想通貨パッケージリストを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-virtual-currency-packages-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-packages" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨パッケージリストを取得する（管理者）", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "仮想通貨パッケージを作成します。", "operationId": "admin-create-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package" }, "responses": { "201": { "$ref": "#/components/responses/Virtual-Items-Currency_201-created" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨パッケージを作成", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/package/sku/{item_sku}": { "delete": { "description": "仮想通貨パッケージを削除します。", "operationId": "admin-delete-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "仮想通貨パッケージが正常に更新されました。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨パッケージを削除", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "管理用のプロジェクト内の仮想通貨パッケージを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency-package" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨パッケージを取得", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "仮想通貨パッケージを更新します。", "operationId": "admin-update-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency-package" }, "responses": { "204": { "description": "仮想アイテムは正常に更新されました。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨パッケージを更新", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_currency/sku/{virtual_currency_sku}": { "delete": { "description": "仮想通貨を削除します。", "operationId": "admin-delete-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "仮想通貨は正常に削除されました。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨を削除する", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "管理用のプロジェクト内の仮想通貨を取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-currency" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨を取得する", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "仮想通貨を更新します。", "operationId": "admin-update-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-currency" }, "responses": { "204": { "content": {}, "description": "仮想通貨は正常に更新されました。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想通貨を更新する", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items": { "get": { "description": "管理用のプロジェクト内の仮想アイテムリストを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-virtual-items-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想アイテムのリストを取得する", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "仮想アイテムを作成します。", "operationId": "admin-create-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item" }, "responses": { "201": { "$ref": "#/components/responses/Virtual-Items-Currency_201-created" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想アイテムを作成", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/group/external_id/{external_id}": { "get": { "description": "管理用のグループ内の仮想アイテムリストを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-virtual-items-list-by-group-external-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "指定されたグループ外部IDによる仮想アイテムのリストを取得します。", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/group/id/{group_id}": { "get": { "description": "管理用のグループ内の仮想アイテムリストを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-virtual-items-list-by-group-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/group_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-virtual-items-by-group" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "指定されたグループIDによる仮想アイテムのリストを取得します。", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/virtual_items/sku/{item_sku}": { "delete": { "description": "仮想アイテムを削除します。", "operationId": "admin-delete-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "content": {}, "description": "仮想アイテムは正常に削除されました。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想アイテムを削除", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "管理用のプロジェクト内の仮想アイテムを取得します。\n\n
注

このエンドポイントは、ストアカタログの構築に使用しないでください。
", "operationId": "admin-get-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-admin-get-item" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想アイテムを取得", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "仮想アイテムを更新します。", "operationId": "admin-update-virtual-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Virtual-Items-Currency_admin-create-virtual-item" }, "responses": { "204": { "content": {}, "description": "仮想アイテムは正常に更新されました。" }, "401": { "$ref": "#/components/responses/Virtual-Items-Currency_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-invalid-request" } }, "security": [ { "basicAuth": [] } ], "summary": "仮想アイテムを更新", "tags": [ "virtual-items-currency-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/{item_type}/groups": { "get": { "description": "Retrieves item group list with filtering by item type. Only items of the specified type are counted for the group. This is similar to the [Get item group list](/ja/api/catalog/item-groups-admin/admin-get-item-group-list) endpoint, with additional filtering of items by type when counting them.", "operationId": "admin-get-item-group-list-by-item-type", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_type-group-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-list-by-item-type" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group list filtered by item type", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/items/{item_type}/groups/{external_id}": { "get": { "description": "Retrieves an item group by external ID. Only items of the specified type are counted for the group. This is similar to the [Get item group by external ID](/ja/api/catalog/item-groups-admin/admin-get-item-group) endpoint, with additional filtering of items by type when counting them.", "operationId": "admin-get-item-group-by-item-type", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_type-group-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/ItemGroup_200-admin-get-group-by-item-type" }, "401": { "$ref": "#/components/responses/ItemGroup_401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/ItemGroup_404-group-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "Get item group by external ID filtered by item type", "tags": [ "item-groups-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/region": { "get": { "description": "地域を取得します。\n\n地域制限を管理するためにリージョンを使用することができます。", "operationId": "admin-get-regions", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-regions-list" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "地域リストを取得する", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "地域を作成します。\n\n地域制限を管理するためにリージョンを使用することができます。", "operationId": "admin-create-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-region" }, "responses": { "201": { "$ref": "#/components/responses/201-admin-create-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "地域を作成する", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/region/{region_id}": { "delete": { "description": "特定の地域を削除します。", "operationId": "admin-delete-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "responses": { "204": { "$ref": "#/components/responses/204-admin-delete-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "地域を削除する", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "特定地域を取得します。\n\n地域制限を管理するために地域を使用することができます。", "operationId": "admin-get-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "地域を取得する", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "特定地域を更新します。\n\n地域制限を管理するために地域を使用することができます。", "operationId": "admin-update-region", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/region_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/create-update-region" }, "responses": { "204": { "$ref": "#/components/responses/204-admin-update-region" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" }, "404": { "$ref": "#/components/responses/404-region-not-found" } }, "security": [ { "basicAuth": [] } ], "summary": "地域を更新する", "tags": [ "common-regions" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/all": { "delete": { "description": "ユーザーが再度購入できるように、アイテムの購入制限を更新します。\n\nUser limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)", "operationId": "reset-all-user-items-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits" }, "responses": { "200": { "description": "制限は正常に更新されました。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "User not found": { "value": { "errorCode": 5008, "errorMessage": "[0401-5008]: Could not find User", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "アイテムが見つかりません。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "value": { "errorCode": 1102, "errorMessage": "[0401-1102]: Unprocessable Entity", "errorMessageExtended": [ { "message": "Must be at least 1 characters long", "property": "user_external_id" }, { "message": "Does not match the regex pattern ^\\S+$", "property": "user_external_id" } ], "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "items": { "properties": { "message": { "type": "string" }, "property": { "type": "string" } }, "type": "object" }, "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "basicAuth": [] } ], "summary": "指定したユーザーのすべての購入制限を更新する", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}": { "delete": { "description": "適用される制限内で、指定されたユーザーが使用できるアイテムの残りの数を減らします。\n\nUser limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)", "operationId": "remove-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "アイテムが見つかりません。" }, "422": { "content": { "application/json": { "examples": { "Available item limit is out of range": { "$ref": "#/components/examples/422-item-out-of-range-available-user-limit" }, "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "basicAuth": [] } ], "summary": "指定したユーザーが利用できるアイテムの数を減らす", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "get": { "description": "適用される制限内で、指定されたユーザーが使用できるアイテムの残りの数を取得します。\n\nUser limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテムタイプモジュールの 管理セクションに移動します：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)", "operationId": "get-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/user_external_id-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "アイテムが見つかりません。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "basicAuth": [] } ], "summary": "指定されたユーザが利用できるアイテムの数を取得する", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "post": { "description": "適用される制限内で、指定されたユーザーが使用できるアイテムの残りの数を増やします。\n\nUser limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します：\n* [ゲームキー](https://developers.Xsolla.com/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 仮想通貨](https://developers.Xsolla.com/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.Xsolla.com/api/shop-builder/operation/admin-get-bundle-list/)", "operationId": "add-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-strict" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "アイテムが見つかりません。" }, "422": { "content": { "application/json": { "examples": { "Available item limit is out of range": { "$ref": "#/components/examples/422-item-out-of-range-available-user-limit" }, "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "basicAuth": [] } ], "summary": "指定したユーザーが使用できるアイテムの数を増やす", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] }, "put": { "description": "指定されたユーザーが、増減後に適用された制限の範囲内で購入できる数量を設定します。\n\nUser limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテムタイプモジュールの 管理セクションに移動します：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 仮想通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)", "operationId": "set-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/update-user-limits-flexible" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-get-user-item-limits" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "アイテムが見つかりません。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "basicAuth": [] } ], "summary": "指定されたユーザーが利用できるアイテムの数を設定する", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/admin/user/limit/item/sku/{item_sku}/all": { "delete": { "description": "ユーザーが再び購入できるように、アイテムの購入制限を更新します。*user*パラメータが`null`である場合、このコールはすべてのユーザーに対してこの制限を更新します。\n\nUser limit APIを使用すると、アイテムを数量限定で販売できます。購入制限を構成するには、目的のアイテム タイプ モジュールの 管理セクションに移動します：\n* [ゲームキー](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-create-game/)\n* [仮想アイテム & 仮想通貨](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-virtual-items-list/)\n* [バンドル](https://developers.xsolla.com/ja/api/shop-builder/operation/admin-get-bundle-list/)", "operationId": "reset-user-item-limit", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/reset-user-limits-flexible" }, "responses": { "200": { "description": "制限は正常に更新されました。" }, "401": { "$ref": "#/components/responses/Common_401-invalid-basic-auth" }, "404": { "content": { "application/json": { "examples": { "Item not found": { "$ref": "#/components/examples/404-item-by-sku-not-found" }, "User not found": { "$ref": "#/components/examples/404-user-not-found" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "アイテムが見つかりません。" }, "422": { "content": { "application/json": { "examples": { "Invalid user_external_id": { "$ref": "#/components/examples/422-user_external_id_invalid" }, "Item does not have configured user limits": { "$ref": "#/components/examples/422-item-without-user-limit" } }, "schema": { "properties": { "errorCode": { "type": "integer" }, "errorMessage": { "type": "string" }, "errorMessageExtended": { "type": "array" }, "statusCode": { "type": "integer" }, "transactionId": { "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "basicAuth": [] } ], "summary": "購入制限を更新する", "tags": [ "user-limits-admin" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v2/project/{project_id}/cart": { "get": { "description": "現在のユーザーのカートを返します。", "operationId": "get-user-cart", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "現在のユーザーのカートを取得", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/clear": { "put": { "description": "カートのアイテムをすべて削除します。", "operationId": "cart-clear", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "204": { "description": "カートは正常にクリアされました。" } }, "security": [ { "AuthForCart": [] } ], "summary": "現在のカートからすべてのカートアイテムを削除", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/fill": { "put": { "description": "カートにアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテムは渡された値で置き換えられます。", "operationId": "cart-fill", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-fill-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "カートにアイテムを入れる", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/item/{item_sku}": { "delete": { "description": "カートからアイテムを削除します。", "operationId": "delete-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "カートのアイテムは正常に削除されました。" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } }, "security": [ { "AuthForCart": [] } ], "summary": "現在のカートからアイテムを削除", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] }, "put": { "description": "既存のカートアイテムを更新するか、カート内のアイテムを作成します。", "operationId": "put-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_put-item-by-cart-idJsonModel" }, "responses": { "204": { "description": "カートは正常に更新されました。" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-can-put-only-virtual-good-to-cart" } }, "security": [ { "AuthForCart": [] } ], "summary": "現在のカートからカートのアイテムを更新", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}": { "get": { "description": "カートIDによりユーザーのカートを返します。", "operationId": "get-cart-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/currency-query-param" }, { "$ref": "#/components/parameters/locale-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "カートIDによりカートを取得", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/clear": { "put": { "description": "カートのアイテムをすべて削除します。", "operationId": "cart-clear-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "responses": { "204": { "description": "カートは正常にクリアされました。" } }, "security": [ { "AuthForCart": [] } ], "summary": "カートIDによるすべてカートアイテムを削除", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/fill": { "put": { "description": "カートに特定のアイテムを入れます。カートにすでに同じSKUのアイテムがある場合、既存のアイテム位置が渡された値で置き換えられます。", "operationId": "cart-fill-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_fill-cart-json-model" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-fill-cart-json-model" } }, "security": [ { "AuthForCart": [] } ], "summary": "カートに特定のアイテムを入れる", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/cart/{cart_id}/item/{item_sku}": { "delete": { "description": "カートからアイテムを削除します。", "operationId": "delete-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "responses": { "204": { "description": "カートのアイテムは正常に削除されました。" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" } }, "security": [ { "AuthForCart": [] } ], "summary": "カートIDによるカートアイテムを削除", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] }, "put": { "description": "既存のカートアイテムを更新するか、カート内のアイテムを作成します。", "operationId": "put-item-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_put-item-by-cart-idJsonModel" }, "responses": { "204": { "description": "カートは正常に更新されました。" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-item" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-non-negative-quantity" } }, "security": [ { "AuthForCart": [] } ], "summary": "カートIDによるカートアイテムを更新", "tags": [ "cart-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/entitlement": { "get": { "description": "Get the list of games owned by the user. The response will contain an array of games owned by a particular user.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-user-games", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/sandbox-query-param" }, { "$ref": "#/components/parameters/additional_fields-entitlement-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-user-entitlement-list" }, "401": { "$ref": "#/components/responses/Game-Keys_401-invalid-basic-auth" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "ユーザーが所有しているゲームソフトのリストを取得", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/entitlement/redeem": { "post": { "description": "Grants entitlement by a provided game code.\n
\n Notice

\n You can redeem codes only for the DRM-free platform.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "redeem-game-pin-code", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "code": { "description": "ゲームコード。", "example": "AAAA-BBBB-CCCC-DDDD", "type": "string" }, "sandbox": { "default": false, "description": "サンドボックスモードでゲームコードを引き換えます。このオプションは、企業ユーザーのリストに指定されているユーザーに対して有効です。", "example": false, "type": "boolean" } }, "required": [ "code" ], "type": "object" } } }, "required": true }, "responses": { "201": { "description": "引き換えに成功しました。" }, "403": { "$ref": "#/components/responses/Game-Keys_403-auth-header-not-sent" }, "404": { "content": { "application/json": { "examples": { "Game code not found": { "$ref": "#/components/examples/404-game-code-not-found" } }, "schema": { "properties": { "errorCode": { "example": 4603, "type": "integer" }, "errorMessage": { "example": "[0401-4603]: Game code not found.", "type": "string" }, "statusCode": { "example": 404, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "ゲームコードが見つかりません。`code`と `project_id` が正しいことを確認してください。" }, "422": { "content": { "application/json": { "examples": { "DRM is not DRM free": { "$ref": "#/components/examples/422-drm-is-not-drm-free" }, "Game code is already activated": { "value": { "errorCode": 5107, "errorMessage": "[0401-5107]: Game code has been already activated", "statusCode": 422, "transactionId": "transaction id" } }, "Game is in pre-order state": { "value": { "errorCode": 5106, "errorMessage": "[0401-5106]: Item: game_sku is in pre-order state and can not be redeemed", "statusCode": 422, "transactionId": "transaction id" } }, "User already has entitlement": { "$ref": "#/components/examples/422-user-already-has-entitlement" } }, "schema": { "properties": { "errorCode": { "example": 5103, "type": "integer" }, "errorMessage": { "example": "[0401-5103]: Selected drm is not drmfree.", "type": "string" }, "statusCode": { "example": 422, "type": "integer" }, "transactionId": { "example": "x-x-x-x-transactionId-mock-x-x-x", "type": "string" } }, "type": "object" } } }, "description": "無効なリクエストです。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "クライアントによるゲームコードを引き換える", "tags": [ "game-keys-entitlement" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/cart": { "post": { "description": "無料カートのすべてのアイテムを含む注文を作成します。作成された注文は`done`という注文状況を取得します。", "operationId": "create-free-order", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Free_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } }, "security": [ { "AuthForCart": [] } ], "summary": "無料カートで注文を作成する", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/cart/{cart_id}": { "post": { "description": "特定の無料カートのすべてのアイテムを含む注文を作成します。作成された注文は`done`という注文状況を取得します。", "operationId": "create-free-order-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Free_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } }, "security": [ { "AuthForCart": [] } ], "summary": "特定の無料カートで注文を作成する", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/free/item/{item_sku}": { "post": { "description": "Creates an order with a specified free item. The created order will get a `done` order status.
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "create-free-order-with-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Free_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-item" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "指定された無料アイテムで注文を作成する", "tags": [ "free-item" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items": { "get": { "description": "Gets a sellable items list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-items", "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "販売可能なアイテムのリストを取得", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle": { "get": { "description": "Gets a list of bundles for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-get-bundle-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "バンドルのリストを取得", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle/group/{external_id}": { "get": { "description": "Gets a list of bundles within a group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle-list-in-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Bundles_200-get-bundle-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "指定されたグループのバンドルリストを取得する", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/bundle/sku/{sku}": { "get": { "description": "Gets a specified bundle.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-bundle", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/sku-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "$ref": "#/components/examples/Bundles_200-get-bundle" } }, "schema": { "$ref": "#/components/schemas/Bundles_client_bundle" } } }, "description": "指定されたバンドルは正常に受信されました。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "指定されたバンドルを取得する", "tags": [ "bundles-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game": { "get": { "description": "Gets a games list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-games-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-games-catalog" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "ゲームリストを取得", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/drm": { "get": { "description": "利用可能なDRMのリストを取得します。", "operationId": "get-drm-list", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-drm-list" } }, "security": [], "summary": "DRMリストを取得", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/group/{external_id}": { "get": { "description": "Gets a games list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-games-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-games-catalog" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "指定されたグループによるゲームリストを取得", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/key/group/{external_id}": { "get": { "description": "Gets a game key list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-keys-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Game-Keys_200-get-game-keys-by-group-catalog" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "指定されたグループのゲームキーリストを取得", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/key/sku/{item_sku}": { "get": { "description": "Gets a game key for the catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-key-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "アイテムSKU。", "in": "path", "name": "item_sku", "required": true, "schema": { "default": "xsollus_basic_edition_steam", "type": "string" } }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "can_be_bought": true, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "name": "All games" }, { "external_id": "Xsolla", "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "limits": null, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] } } }, "schema": { "description": "ゲームキー情報を持つオブジェクト。", "example": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "23fda05111c125608af8f1fa0e99db45a10ea1cc", "value": "Horror" } ] } ], "can_be_bought": true, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "limits": null, "name": "Game name", "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }, "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "description": { "description": "アイテムの説明。", "example": "Game description", "type": "string" }, "drm_name": { "description": "DRM名。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "一意のDRM ID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "steam_key_1", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "has_keys": { "description": "`true`の場合、ゲームキーに販売用のキーがあります。", "example": false, "type": "boolean" }, "image_url": { "description": "画像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "`true`の場合、ゲームキーは先行予約で、まだ発売されていません。", "example": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "name": { "description": "アイテム名。", "example": "Game name", "type": "string" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "ISO 8601形式でのゲームキーのリリース日。", "example": "2020-08-11T10:00:00+03:00", "type": "string" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "com.xsolla.game_01", "type": "string" }, "type": { "description": "アイテムタイプ：`game_key`。", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "com.xsolla.vc_1", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "ゲームキーは正常に受信されました。" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_key_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_key_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームキーが見つかりません。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "カタログ用のゲームキーを取得する", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/game/sku/{item_sku}": { "get": { "description": "Gets a game for the catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-game-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "description": "アイテムSKU。", "in": "path", "name": "item_sku", "required": true, "schema": { "default": "full_game_1", "type": "string" } }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "attributes": [ { "external_id": "OS", "name": "OS", "values": [ { "external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723", "value": "Windows" } ] }, { "external_id": "genre", "name": "Genre", "values": [ { "external_id": "9c5774997fc072b973bd5c231075c13841413f62", "value": "Casual, Logic" } ] } ], "description": "Game description", "groups": [ { "external_id": "all", "item_order_in_group": 2, "name": "All games" }, { "external_id": "Xsolla", "item_order_in_group": 1, "name": "Xsolla games" } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { "can_be_bought": true, "drm_name": "Steam", "drm_sku": "steam_key_1", "has_keys": true, "is_free": false, "is_pre_order": true, "limits": null, "periods": [ { "date_from": "2020-08-11T10:00:00+03:00", "date_until": "2020-08-11T20:00:00+03:00" } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_key_01", "type": "game_key", "virtual_prices": [], "vp_rewards": [ { "amount": 130, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "item_id": 175232, "name": "Value point", "sku": "com.xsolla.value_point_1" }, { "amount": 50, "image_url": "https://cdn3.xsolla.com/img/misc/images/54c0cf9d345817cdacfdde198db178e0.jpg", "is_clan": true, "item_id": 186321, "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" } ] }, { "can_be_bought": true, "drm_name": "Origin", "drm_sku": "origin_key_1", "has_keys": false, "is_free": false, "is_pre_order": false, "limits": null, "periods": [], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": null, "sku": "com.xsolla.game_key_02", "type": "game_key", "virtual_prices": [], "vp_rewards": [] } ], "unit_type": "game" } } }, "schema": { "description": "ゲーム情報を持つオブジェクト。", "properties": { "attributes": { "$ref": "#/components/schemas/Game-Keys_schemas-client-attributes" }, "description": { "description": "アイテムの説明。", "example": "Game description", "type": "string" }, "groups": { "$ref": "#/components/schemas/items_client_groups_response" }, "image_url": { "description": "画像URL。", "example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "type": "string" }, "name": { "description": "アイテム名。", "example": "Game name", "type": "string" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_01", "type": "string" }, "type": { "description": "アイテムタイプ：`virtual_good`/`virtual_currency`/`bundle`/`physical_good`/`unit`。", "example": "unit", "type": "string" }, "unit_items": { "items": { "properties": { "can_be_bought": { "$ref": "#/components/schemas/Can_be_bought" }, "drm_name": { "description": "DRM名。", "example": "Steam", "type": "string" }, "drm_sku": { "description": "一意のDRM ID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "steam", "type": "string" }, "has_keys": { "description": "`true`の場合、ゲームキーに販売用のキーがあります。", "example": false, "type": "boolean" }, "is_free": { "$ref": "#/components/schemas/value-is_free" }, "is_pre_order": { "description": "`true`の場合、ゲームキーは先行予約で、まだ発売されていません。", "example": true, "type": "boolean" }, "limits": { "$ref": "#/components/schemas/Catalog_item_limits" }, "periods": { "$ref": "#/components/schemas/item-periods" }, "price": { "description": "アイテム価格。", "properties": { "amount": { "description": "割引後のアイテム価格。", "example": "2.9900", "type": "string" }, "amount_without_discount": { "description": "アイテム価格。", "example": "2.9900", "type": "string" }, "currency": { "description": "商品価格通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) による3文字コード。", "example": "USD", "type": "string" } }, "type": "object" }, "promotions": { "$ref": "#/components/schemas/Catalog_item_promotions" }, "release_date": { "description": "ISO 8601形式でのゲームキーのリリース日。", "example": "2020-08-11T10:00:00+03:00", "type": [ "string", "null" ] }, "sku": { "description": "一意のアイテムID。SKUには、小文字と大文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。", "example": "game_01", "type": "string" }, "type": { "description": "アイテムタイプ：`game_key`。", "example": "game_key", "type": "string" }, "virtual_prices": { "description": "仮想価格。", "items": { "description": "仮想価格。", "properties": { "amount": { "description": "仮想通貨での割引アイテム価格。", "example": 100, "type": "integer" }, "amount_without_discount": { "description": "アイテム価格。", "example": 200, "type": "integer" }, "description": { "description": "仮想通貨の説明。", "example": "Big Rocket - description", "type": "string" }, "image_url": { "description": "仮想通貨のイメージ。", "example": "http://image.png", "type": "string" }, "is_default": { "description": "アイテムの価格をデフォルトにするかどうか。", "example": true, "type": "boolean" }, "name": { "description": "仮想通貨名。", "example": "SHOTGUN FOR TRUE RAIDERS", "type": "string" }, "sku": { "description": "仮想通貨アイテムSKU。", "example": "vc_test", "type": "string" }, "type": { "description": "仮想通貨のタイプ。", "example": "virtual_currency", "type": "string" } }, "type": "object" }, "type": "array" }, "vp_rewards": { "$ref": "#/components/schemas/client-item-value-point-reward" } }, "type": "object" }, "type": "array" }, "unit_type": { "description": "ユニットタイプ：`game`。", "example": "game", "type": "string" } }, "type": "object" } } }, "description": "ゲームは正常に受信されました。" }, "404": { "content": { "application/json": { "examples": { "response": { "value": { "errorCode": 4001, "errorMessage": "[0401-4001]: Item with sku = 'game_1' not found", "statusCode": 404 } } }, "schema": { "properties": { "errorCode": { "example": 4001, "type": "integer" }, "errorMessage": { "example": "[0401-4001]: Item with sku = 'game_1' not found", "type": "string" }, "statusCode": { "example": 404, "type": "integer" } }, "type": "object" } } }, "description": "ゲームが見つかりません。" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "カタログ用ゲームを取得する", "tags": [ "game-keys-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/group/{external_id}": { "get": { "description": "Gets a sellable items list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-items-group", "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/external_id_59080-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-items-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "指定されたグループの販売可能なアイテムリストを取得", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/groups": { "get": { "description": "Retrieves an item group list for building a catalog without pagination.\n
Note

The use of the item catalog API calls is available without authorization, but to get a personalized catalog, you must pass the user JWT in the Authorization header.
", "operationId": "get-item-groups", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/with_geo-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-groups" } }, "security": [], "summary": "アイテムグループリストを取得する", "tags": [ "item-groups-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/id/{item_id}": { "get": { "description": "Gets a sellable item by its ID.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-item-by-id", "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/item_id_59080-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-item-by-id" }, "404": { "$ref": "#/components/responses/sellable-item-by-id_404" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "IDによる販売可能なアイテムを取得する", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/sku/{sku}": { "get": { "description": "Gets a sellable item by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-sellable-item-by-sku", "parameters": [ { "$ref": "#/components/parameters/project_id_59080-path-param" }, { "$ref": "#/components/parameters/item_sku_59080-path-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/sellable_items_200-get-item-by-id" }, "404": { "$ref": "#/components/responses/sellable-item-by-sku_404" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "SKUによる販売可能なアイテムを取得する", "tags": [ "common-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency": { "get": { "description": "Gets a virtual currency list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "仮想通貨リストを取得する", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/package": { "get": { "description": "Gets a virtual currency packages list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-package", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-packages-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "仮想通貨パッケージリストを取得", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/package/sku/{virtual_currency_package_sku}": { "get": { "description": "Gets a virtual currency packages by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-package-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_package_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency-package" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "SKUによる販売可能なアイテムを取得する", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_currency/sku/{virtual_currency_sku}": { "get": { "description": "Gets a virtual currency by SKU for building a catalog.\n
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-currency-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-virtual-currency" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "SKUによる仮想通貨を取得する", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items": { "get": { "description": "Gets a virtual items list for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-items", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "仮想アイテムリストを取得", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/all": { "get": { "description": "Gets a list of all virtual items for searching on client-side.\n
\n Notice

\n Returns only item SKU, name, groups and description.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-all-virtual-items", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-all-items-list" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "すべての仮想アイテムリストを取得する", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/group/{external_id}": { "get": { "description": "Gets an items list from the specified group for building a catalog.\n
\n Attention

\n All projects have the limitation to the number of items that you can\n get in the response. The default and maximum value is 50 items\n per response. To get more data page by page, use limit\n and offset fields.\n

\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-items-group", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/external_id-group-path-param" }, { "$ref": "#/components/parameters/limit-query-param" }, { "$ref": "#/components/parameters/offset-query-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/promo_code-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-items-by-group-id" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item-group" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "指定されたグループによるアイテムリストを取得する", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/items/virtual_items/sku/{item_sku}": { "get": { "description": "Gets a virtual item by SKU for building a catalog.\n
\n Notice

\n This API call returns generic item\n catalog data when used without authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "get-virtual-items-sku", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/locale-query-param" }, { "$ref": "#/components/parameters/country-query-param" }, { "$ref": "#/components/parameters/show_inactive_time_limited_items-query-param" }, { "$ref": "#/components/parameters/additional_fields-query-param" } ], "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-get-item-by-sku" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "SKUによる仮想アイテムを取得する", "tags": [ "virtual-items-currency-catalog" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/order/{order_id}": { "get": { "description": "指定された注文を取得します。", "operationId": "get-order", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/order_id-path-param" } ], "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-get-order" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-get-order" } }, "security": [ { "AuthForCart": [] } ], "summary": "注文する", "tags": [ "order" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/cart": { "post": { "description": "クライアントサーバーへの統合に使用されます。カートからのすべてのアイテムを含む注文を作成し、そのための決済トークンを生成します。作成された注文は`new`注文ステータスを取得します。\n\nクライアントIPは、ユーザーの国を決定するために使用され、注文に対応する通貨と利用可能な決済方法を適用するために使用されます。\n\n決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください：`https://secure.xsolla.com/paystation4/?token={token}`で`{token}`受信したトークン。\n\nテスト目的には、以下のリンクを使用してください：`https://sandbox-secure.xsolla.com/paystation4/?token={token}`。\n\n
注意

このメソッドはIPを使用してユーザーの国を決定し、注文の通貨を選択するため、このメソッドはクライアント側からのみ使用し、サーバー側からは使用しないことが重要です。サーバー側からこの方法を使用すると、通貨が正しく判定されず、ペイステーションの決済方法に影響を与える可能性があります。
", "operationId": "create-order", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } }, "security": [ { "AuthForCart": [] } ], "summary": "現在のカートの全アイテムを対象とした注文を作成する", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/cart/{cart_id}": { "post": { "description": "クライアントサーバーへの統合に使用されます。特定のカートからのすべてのアイテムを含む注文を作成し、そのための決済トークンを生成します。作成された注文は`new`注文ステータスを取得します。\n\nクライアントIPは、ユーザーの国を決定するために使用され、注文に対応する通貨と利用可能な決済方法を適用するために使用されます。\n\n決済UIを新しいウィンドウで開くには、以下のリンクをご利用ください：`https://secure.xsolla.com/paystation4/?token={token}`で`{token}`受信したトークン。\n\nテスト目的には、以下のリンクを使用してください：`https://sandbox-secure.xsolla.com/paystation4/?token={token}`。\n\n
注意

このメソッドはIPを使用してユーザーの国を決定し、注文の通貨を選択するため、このメソッドはクライアント側からのみ使用し、サーバー側からは使用しないことが重要です。サーバー側からこの方法を使用すると、通貨が正しく判定されず、ペイステーションの決済方法に影響を与える可能性があります。
", "operationId": "create-order-by-cart-id", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/cart_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-by-cart-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-order-created" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-invalid-cart" } }, "security": [ { "AuthForCart": [] } ], "summary": "特定のカートの全アイテムを対象とした注文を作成する", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/item/{item_sku}": { "post": { "description": "Used for client-to-server integration. Creates an order with a specified item and generates a payment token for it. The created order gets the `new` order status.\n\nThe client IP is used to determine the user’s country, which is then used to apply the corresponding currency and available payment methods for the order.\n\nTo open the payment UI in a new window, use the following link: `https://secure.xsolla.com/paystation4/?token={token}`, where `{token}` is the received token.\n\nFor testing purposes, use this URL: `https://sandbox-secure.xsolla.com/paystation4/?token={token}`.\n\n
Notice

As this method uses the IP to determine the user’s country and select a currency for the order, it is important to only use this method from the client side and not from the server side. Using this method from the server side may cause incorrect currency determination and affect payment methods in Pay Station.

\n Notice

\n This API call uses a user JWT for authorization.

\n Include the token in the Authorization header in the following format: Bearer <user_JWT>. For more information about user JWT, see the Security block for this call.\n
", "operationId": "create-order-with-item", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_create-order-with-specified-item-idJsonModel" }, "responses": { "200": { "$ref": "#/components/responses/Cart-Payment_200-order-created" }, "404": { "$ref": "#/components/responses/Cart-Payment_404-create-order-with-item-not-found-errors" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-create-order-with-item-invalid" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "指定したアイテムで注文を作成する", "tags": [ "payment-client-side" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v2/project/{project_id}/payment/item/{item_sku}/virtual/{virtual_currency_sku}": { "post": { "description": "Creates item purchase using virtual currency.
\n Note

\n This API call returns generic item catalog data when used without\n authorization. Use authorization to retrieve\n personalized\n user data, such as limits and promotions associated with the item.\n To do this, pass the user JWT in the Authorization header.\n For more information about user JWT, see the Security block\n for this call.\n
", "operationId": "create-order-with-item-for-virtual-currency", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" }, { "$ref": "#/components/parameters/item_sku-path-param" }, { "$ref": "#/components/parameters/virtual_currency_sku-path-param" }, { "$ref": "#/components/parameters/platform-query-param" } ], "requestBody": { "content": { "application/json": { "example": { "custom_parameters": { "array_param": [ { "object1": { "param": "https://xsolla.com" }, "property": { "int_property": 112, "string_property": "xsolla" } }, { "object2": { "param": "https://developers.xsolla.com/ja" }, "property": { "int_property": 112, "string_property": "email@example.com" } } ], "bool_param": true, "int_param": 100, "null_param": null, "object_param": { "key": "value" } } }, "schema": { "properties": { "custom_parameters": { "$ref": "#/components/schemas/Cart-Payment_custom_parameters" } }, "type": "object" } } } }, "responses": { "200": { "$ref": "#/components/responses/Virtual-Items-Currency_200-quick-purchase" }, "404": { "$ref": "#/components/responses/Virtual-Items-Currency_404-item" }, "422": { "$ref": "#/components/responses/Virtual-Items-Currency_422-not-enough-virtual-currency" } }, "security": [ { "XsollaLoginUserJWT": [] } ], "summary": "仮想通貨で購入した指定商品で注文を作成する", "tags": [ "virtual-payment" ], "x-badges": [ { "color": "#80eaff", "name": "Client-side" } ] } }, "/v3/project/{project_id}/admin/order/search": { "post": { "description": "作成日の古いものから新しいものへと並べられた注文リストを取得します。", "operationId": "admin-order-search", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/admin-order-search" }, "responses": { "200": { "$ref": "#/components/responses/200-admin-order-search" }, "401": { "$ref": "#/components/responses/401-invalid-basic-auth" } }, "security": [ { "basicAuth": [] } ], "summary": "指定期間の注文リストを取得する", "tags": [ "order" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" }, { "color": "#d7dee0", "name": "Admin" } ] } }, "/v3/project/{project_id}/admin/payment/token": { "post": { "description": "注文とその支払いトークンを生成します。注文はリクエストボディに渡されたアイテムに基づいて生成されます。\n\n決済UIを新しいウィンドウで開くには、次のリンクを使用します：`https://secure.xsolla.com/paystation4/?token={token}`。そこで、`{token}`は受信したトークンです。\n\nテスト目的では、次のURLを使用します：`https://sandbox-secure.xsolla.com/paystation4/?token={token}`。\n\n
通知\n

\n user.country.valueパラメータは、注文の通貨を選択するために使用されます。ユーザーの国が不明な場合は、\nX-User-IpヘッダーにユーザーのIPを指定することもできます。
この方法の正しい動作には、これら2つのオプションのいずれかが必要です。
選択した通貨は、ペイステーションでの決済方法に使用されます。\n
", "operationId": "admin-create-payment-token", "parameters": [ { "$ref": "#/components/parameters/project_id-path-param" } ], "requestBody": { "$ref": "#/components/requestBodies/Cart-Payment_admin-create-payment-token" }, "responses": { "201": { "$ref": "#/components/responses/Cart-Payment_201-admin-create-payment-token" }, "401": { "$ref": "#/components/responses/Cart-Payment_401-invalid-basic-auth" }, "422": { "$ref": "#/components/responses/Cart-Payment_422-admin-create-payment-token" } }, "security": [ { "basicAuth": [] } ], "summary": "購入用の決済トークンを作成する", "tags": [ "payment-server-side" ], "x-badges": [ { "color": "#95ff80", "name": "Server-side" } ] } } }, "servers": [ { "url": "https://store.xsolla.com/api" } ], "tags": [ { "name": "virtual-items-currency-admin", "x-displayName": "管理者" }, { "name": "virtual-items-currency-catalog", "x-displayName": "カタログ" }, { "name": "virtual-payment", "x-displayName": "仮想決済" }, { "name": "game-keys-catalog", "x-displayName": "カタログ" }, { "name": "game-keys-entitlement", "x-displayName": "資格" }, { "name": "game-keys-admin", "x-displayName": "管理者" }, { "name": "bundles-admin", "x-displayName": "管理者" }, { "name": "bundles-catalog", "x-displayName": "カタログ" }, { "name": "cart-client-side", "x-displayName": "カート（クライアント側）" }, { "name": "cart-server-side", "x-displayName": "カート（サーバー側）" }, { "name": "payment-client-side", "x-displayName": "決済（クライアント側）" }, { "name": "payment-server-side", "x-displayName": "決済（サーバー側）" }, { "name": "order", "x-displayName": "注文" }, { "name": "free-item", "x-displayName": "無料アイテム" }, { "name": "user-limits-admin", "x-displayName": "管理" }, { "name": "connector-admin", "x-displayName": "管理者" }, { "name": "common-pre-orders", "x-displayName": "先行予約" }, { "name": "common-merchant", "x-displayName": "マーチャント" }, { "description": "このAPIは販売可能なアイテムや特定のアイテムを取得することができます。", "name": "common-catalog", "x-displayName": "カタログ" }, { "name": "common-regions", "x-displayName": "共通地域" }, { "name": "attribute-admin", "x-displayName": "管理者" }, { "name": "item-groups-admin", "x-displayName": "管理者" }, { "name": "item-groups-catalog", "x-displayName": "カタログ" } ], "x-tagGroups": [ { "name": "仮想アイテム & 仮想通貨", "tags": [ "virtual-items-currency-admin", "virtual-items-currency-catalog", "virtual-payment" ] }, { "name": "ゲームキー", "tags": [ "game-keys-catalog", "game-keys-entitlement", "game-keys-admin" ] }, { "name": "バンドル", "tags": [ "bundles-admin", "bundles-catalog" ] }, { "name": "カート＆決済", "tags": [ "cart-client-side", "cart-server-side", "payment-client-side", "payment-server-side", "order", "free-item" ] }, { "name": "制限", "tags": [ "user-limits-admin" ] }, { "name": "アイテムインポート", "tags": [ "connector-admin" ] }, { "name": "通常", "tags": [ "common-pre-orders", "common-merchant", "common-catalog", "common-regions" ] }, { "name": "アイテム属性", "tags": [ "attribute-admin" ] }, { "name": "ITEM GROUPS", "tags": [ "item-groups-admin", "item-groups-catalog" ] } ] }