{
"openapi": "3.0.0",
"info": {
"description": "# 概要\n\nDigital Distribution Hubは、プッシュペイメント技術やEコマースを介して、デジタルとキャッシュベースの決済を結びつけることを目的とした、エクソラの新しいソリューションです。\n\nこの参照は、以下の2つエクソラ製品のAPIエンドポイントを組み合わせたものです：[ゲーム内ストア](https://developers.xsolla.com\\/ja/doc/in-game-store/)と[決済ステーション](https://developers.xsolla.com\\/ja/doc/pay-station/)。2つのベースURLがあります：\n\n* **一般**、**カタログ**、**カート**、及び**注文**グループの場合は `https://store.xsolla.com/api`。\n* **通知**グループの場合は、`https://ps.xsolla.com`。\n\n**カタログ**グループのAPIエンドポイントは認証を必要としません。\n\n**カート**と**注文**グループの操作を行うには、[ユーザートークンを作成する](https://developers.xsolla.com\\/ja/digital-distribution-hub/common/user-token/create-user-token)を介してトークンを生成する必要があります。\n\n注意この参照は、将来のAPIのデザインを示すものであり、完全に機能するインターフェースではありません。現在は、
カタログおよび
通知グループのエンドポイントのみを試すことができます。ご意見をお聞かせいただける場合は、
techdoc@xsolla.comまでご連絡ください。
",
"title": "Digital Distribution Hub",
"version": "1.0.0"
},
"servers": [
{
"url": "https://store.xsolla.com/api"
}
],
"tags": [
{
"name": "cart",
"x-displayName": "カート"
},
{
"name": "game keys",
"x-displayName": "ゲームキー"
},
{
"name": "virtual items & currency",
"x-displayName": "仮想アイテム & 通貨"
},
{
"name": "bundles",
"x-displayName": "バンドル"
},
{
"name": "user token",
"x-displayName": "ユーザートークン"
},
{
"name": "notifications",
"x-displayName": "通知"
},
{
"name": "order",
"x-displayName": "注文"
}
],
"paths": {
"/push-payments/cancel": {
"post": {
"description": "次の場合、支払いのキャンセルに関する通知を送信します：\n - 支払いが完了しなかった場合\n - 支払いが払い戻された場合",
"operationId": "cancel-notification",
"requestBody": {
"content": {
"application/json": {
"example": {
"payment_id": 784998479
},
"schema": {
"properties": {
"payment_id": {
"type": "integer"
}
},
"required": [
"payment_id"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "OK。"
},
"400": {
"description": "要求の形式が正しくありません。"
},
"403": {
"description": "アクセスは拒否されました。"
},
"404": {
"description": "支払いが見つかりません。"
},
"409": {
"description": "決済はすでにキャンセルされています。"
},
"422": {
"description": "決済をキャンセルする際にエラーが発生しました。"
},
"500": {
"description": "内部サーバーエラー。"
}
},
"servers": [
{
"url": "https://ps.xsolla.com"
}
],
"summary": "通知をキャンセルする",
"tags": [
"notifications"
]
}
},
"/push-payments/pay": {
"post": {
"description": "ユーザーへの請求が成功した後に、この通知を送信します。",
"operationId": "pay-notification",
"requestBody": {
"content": {
"application/json": {
"example": {
"payment": {
"amount": 10,
"currency": "USD",
"geotype_id": 13038,
"ps_transaction_id": "ps_transaction_id"
},
"project_id": 18404,
"purchase": {
"order_id": 1334430
},
"user": {
"id": "s.ivanov"
}
},
"schema": {
"properties": {
"payment": {
"properties": {
"amount": {
"description": "決済金額。",
"type": "number"
},
"currency": {
"description": "注文の通貨。仮想通貨はSKU、現実の通貨は3文字の [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)コードを使用します。",
"type": "string"
},
"geotype_id": {
"description": "エクソラ側の配信者パートナーID。",
"type": "integer"
},
"project_transaction_id": {
"description": "ゲーム開発者側のトランザクションID。",
"type": "string"
},
"ps_transaction_id": {
"description": "配信パートナー側のトランザクションID。",
"type": "string"
}
},
"required": [
"geotype_id",
"amount"
],
"type": "object"
},
"project_id": {
"description": "プロジェクトID。",
"type": "integer"
},
"purchase": {
"properties": {
"order_id": {
"description": "注文ID。",
"type": "integer"
}
},
"required": [
"order_id"
],
"type": "object"
},
"user": {
"properties": {
"email": {
"description": "ユーザーのメールアドレス。",
"type": "string"
},
"id": {
"description": "ゲーム内の一意ユーザー識別子。",
"type": "string"
},
"phone": {
"description": "ユーザーの電話番号。",
"type": "string"
},
"ps_account_id": {
"description": "配信パートナー側のユーザーの決済アカウントID。",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
}
},
"required": [
"project_id",
"payment",
"purchase",
"user"
],
"type": "object"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"payment_id": 784998484
},
"schema": {
"properties": {
"payment_id": {
"type": "integer"
}
},
"type": "object"
}
}
},
"description": "OK。"
},
"400": {
"description": "要求の形式が正しくありません。"
},
"403": {
"description": "アクセスは拒否されました。"
},
"404": {
"description": "注文が見つかりません。"
},
"409": {
"description": "注文はすでに支払い済みです。"
},
"422": {
"description": "決済を行う際にエラーが発生しました。"
},
"500": {
"description": "内部サーバーエラー。"
}
},
"servers": [
{
"url": "https://ps.xsolla.com"
}
],
"summary": "支払い通知",
"tags": [
"notifications"
]
}
},
"/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": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_200"
}
}
},
"description": "アイテムの入ったカートは正常に返却されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "現在のユーザーのカートを取得する",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/clear": {
"put": {
"description": "すべてのカートアイテムを削除します。",
"operationId": "cart-clear",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"responses": {
"204": {
"description": "カートは正常にクリアされました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "現在のカートからすべてのカートアイテムを削除する",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/cart/fill": {
"put": {
"description": "カートにアイテムを入れます。カートに同じSKUのアイテムがすでにある場合、既存のアイテムは渡された値で置き換えられます。",
"operationId": "cart-fill",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/fill-cart-json-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"warnings": [
{
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found",
"quantity": 1,
"sku": "booster_mega_21"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_200_1"
}
}
},
"description": "アイテムの入ったカートは正常に返却されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "カートにアイテムを入れる",
"tags": [
"cart"
]
}
},
"/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": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_404"
}
}
},
"description": "アイテムが見つかりません。`project_id`と`item_sku`が正しいことを確認してください。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "現在のカートからカートアイテムを削除する",
"tags": [
"cart"
]
},
"put": {
"description": "既存のカートアイテムを更新するか、カート内にアイテムを作成します。",
"operationId": "put-item",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/put-item-by-cart-id-json-model"
},
"responses": {
"204": {
"description": "カートは正常に更新されました。"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_404"
}
}
},
"description": "アイテムが見つかりません。`project_id`と`item_sku`が正しいことを確認してください。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1421,
"errorMessage": "Only Virtual Good Supported",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_422_1"
}
}
},
"description": "このタイプのアイテムはカートに入れることができません。別の種類のアイテムを選択します。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "現在のカートからカートアイテムを更新します",
"tags": [
"cart"
]
}
},
"/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": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_200"
}
}
},
"description": "アイテムの入ったカートは正常に返却されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "カートIDでカートを取得する",
"tags": [
"cart"
]
}
},
"/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": [
{
"AuthForClient": []
}
],
"summary": "カートIDですべてのカートアイテムを削除する",
"tags": [
"cart"
]
}
},
"/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/fill-cart-json-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"cart_id": "cart_id",
"is_free": false,
"items": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"price": {
"amount": "6150.0000000000000000",
"amount_without_discount": "6150.0000000000000000",
"currency": "USD"
},
"warnings": [
{
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with Project Id = 44056 and Sku = booster_mega_2 not found",
"quantity": 1,
"sku": "booster_mega_21"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_200_1"
}
}
},
"description": "アイテムの入ったカートは正常に返却されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "特定のカートにアイテムを入れる",
"tags": [
"cart"
]
}
},
"/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": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_404"
}
}
},
"description": "アイテムが見つかりません。`project_id`と`item_sku`が正しいことを確認してください。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "カートIDでカートアイテムを削除する",
"tags": [
"cart"
]
},
"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/put-item-by-cart-id-json-model"
},
"responses": {
"204": {
"description": "カートは正常に更新されました。"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_404"
}
}
},
"description": "アイテムが見つかりません。`project_id`と`item_sku`が正しいことを確認してください。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1102,
"errorMessage": "[0401-1102]: Item quantity must be non-negative integer",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Cart_inline_response_422"
}
}
},
"description": "アイテムの数量は非負の整数でなければなりません。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "カートIDでカートアイテムを更新する",
"tags": [
"cart"
]
}
},
"/v2/project/{project_id}/distribution_hub/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": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"content": {
"is_free": "false",
"items": [
{
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"quantity": 1,
"sku": "some_sku"
}
],
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
}
},
"order_id": 1,
"status": "paid"
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_200_1"
}
}
},
"description": "注文リクエストが成功しました。"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 9001,
"errorMessage": "[0401-9001]: Order not found",
"statusCode": 404
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_404"
}
}
},
"description": "注文が見つかりません。`project_id`と`order_id`が正しいことを確認してください。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "注文を受ける",
"tags": [
"order"
]
}
},
"/v2/project/{project_id}/distribution_hub/payment/cart": {
"post": {
"description": "カートからすべてのアイテムを含む注文を作成します。作成された注文は、`new`の注文ステータスになります。",
"operationId": "create-order",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-order-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"billing_info": {
"direct_taxes": [
{
"amount": 150,
"name": "TAX",
"rate": 10
}
],
"indirect_taxes": [
{
"amount": 246.75,
"name": "VAT",
"rate": 20
}
],
"price": {
"amount": 1480.45,
"currency": "USD"
}
},
"order_id": 641
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_200"
}
}
},
"description": "注文が正常に作成されました。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1401,
"errorMessage": "[0401-1401]: Invalid cart",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_422"
}
}
},
"description": "カートが無効です。カートが存在し、空ではなく、カート内のすべての商品が無料ではないことを確認してください。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "現在のカートからすべてのアイテムを注文する",
"tags": [
"order"
]
}
},
"/v2/project/{project_id}/distribution_hub/payment/cart/{cart_id}": {
"post": {
"description": "特定のカートからすべてのアイテムを含む注文を作成します。作成された注文は、`new`注文ステータスを取得します。",
"operationId": "create-order-by-cart-id",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/cart-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-order-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"billing_info": {
"direct_taxes": [
{
"amount": 150,
"name": "TAX",
"rate": 10
}
],
"indirect_taxes": [
{
"amount": 246.75,
"name": "VAT",
"rate": 20
}
],
"price": {
"amount": 1480.45,
"currency": "USD"
}
},
"order_id": 641
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_200"
}
}
},
"description": "注文が正常に作成されました。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1401,
"errorMessage": "[0401-1401]: Invalid cart",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_422"
}
}
},
"description": "カートが無効です。カートが存在し、空ではなく、カート内のすべての商品が無料ではないことを確認してください。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "特定のカートからすべてのアイテムを注文する",
"tags": [
"order"
]
}
},
"/v2/project/{project_id}/distribution_hub/payment/item/{item_sku}": {
"post": {
"description": "指定されたアイテムで注文を作成します。作成された注文は`new`注文ステータスになります。",
"operationId": "create-order-with-item",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/create-order-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"billing_info": {
"direct_taxes": [
{
"amount": 150,
"name": "TAX",
"rate": 10
}
],
"indirect_taxes": [
{
"amount": 246.75,
"name": "VAT",
"rate": 20
}
],
"price": {
"amount": 1480.45,
"currency": "USD"
}
},
"order_id": 641
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_200"
}
}
},
"description": "注文が正常に作成されました。"
},
"422": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 1411,
"errorMessage": "[0401-1411]: Invalid item",
"statusCode": 422
}
}
},
"schema": {
"$ref": "#/components/schemas/Order_inline_response_422_1"
}
}
},
"description": "アイテムが無効です。アイテムが存在しているか、オフになっていないか、削除されていないか、無料ではないことを確認してください。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "指定したアイテムで注文を作成する",
"tags": [
"order"
]
}
},
"/v2/project/{project_id}/distribution_hub/user/auth": {
"post": {
"description": "ユーザーがゲームに存在することを確認し、ユーザートークンを作成します。",
"operationId": "create-user-token",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"requestBody": {
"$ref": "#/components/requestBodies/post-user-token-json-model"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
}
},
"schema": {
"$ref": "#/components/schemas/Common_inline_response_200_1"
}
}
},
"description": "ユーザートークンが正常に受信されました。"
}
},
"security": [
{
"basicAuth": []
}
],
"summary": "ユーザートークンを作成する",
"tags": [
"user token"
]
}
},
"/v2/project/{project_id}/items/bundle": {
"get": {
"description": "カタログを作成するためのバンドルリストを取得します。\n\n注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は、1応答あたり50アイテムです。
",
"operationId": "get-bundle-list",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-get-bundle-list"
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_10"
}
}
},
"description": "バンドルリストが正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "バンドルのリストを取得する",
"tags": [
"bundles"
]
}
},
"/v2/project/{project_id}/items/bundle/sku/{sku}": {
"get": {
"description": "指定されたバンドルを取得します。",
"operationId": "get-bundle",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/sku-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"$ref": "#/components/examples/200-get-bundle"
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_client_bundle"
}
}
},
"description": "指定されたバンドルは正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "指定されたバンドルを取得する",
"tags": [
"bundles"
]
}
},
"/v2/project/{project_id}/items/game": {
"get": {
"description": "カタログを作成するためのゲームリストを取得します。\n\n注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限とオフセットフィールドを使用します。
",
"operationId": "get-games-list",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
},
{
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_2",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200"
}
}
},
"description": "ゲームリストは正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "ゲームリストを取得する",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/drm": {
"get": {
"description": "使用可能なDRMのリストを取得します。",
"operationId": "get-drm-list",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"drm": [
{
"drm_id": 1,
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"link": "https://support.steampowered.com",
"name": "Steam",
"redeem_instruction_link": "https://support.steampowered.com",
"sku": "steam"
},
{
"drm_id": 2,
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Playstation",
"redeem_instruction_link": "https://support.us.playstation.com",
"sku": "playstation"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_4"
}
}
},
"description": "DRMリストが正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "DRMリストを取得する",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/group/{external_id}": {
"get": {
"description": "カタログを作成するために、指定されたグループからゲームリストを取得します。\n\n注意すべてのプロジェクトには、取得できるアイテムの数に制限があります。応答。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限とオフセットフィールドを使用します。
",
"operationId": "get-games-group",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/external-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
},
{
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_2",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200"
}
}
},
"description": "ゲームリストは正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "指定されたグループごとにゲームリストを取得する",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/key/group/{external_id}": {
"get": {
"description": "カタログを作成するために、指定されたグループからゲームキーリストを取得します。\n\n注意すべてのプロジェクトには、取得できるアイテムの数に制限があります。応答。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限とオフセットフィールドを使用します。
",
"operationId": "get-game-keys-group",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/external-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": true,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_1",
"type": "game_key",
"virtual_prices": []
},
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": false,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_2",
"type": "game_key",
"virtual_prices": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_3"
}
}
},
"description": "ゲームキーリストが正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "指定されたグループごとにゲームキーリストを取得する",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/key/sku/{item_sku}": {
"get": {
"description": "カタログのゲームキーを取得します。",
"operationId": "get-game-key-by-sku",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": true,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_1",
"type": "game_key",
"virtual_prices": []
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_2"
}
}
},
"description": "ゲームキーが正常に受信されました。"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_key_1' not found",
"statusCode": 404
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_404_1"
}
}
},
"description": "ゲームキーが見つかりません。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "カタログ用のゲームキーを取得する",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/game/sku/{item_sku}": {
"get": {
"description": "カタログのゲームを取得します。",
"operationId": "get-game-by-sku",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/item-sku-path-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_1"
}
}
},
"description": "ゲームは正常に受信されました。"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 4001,
"errorMessage": "[0401-4001]: Item with sku = 'game_1' not found",
"statusCode": 404
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_404"
}
}
},
"description": "ゲームが見つかりません。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "カタログ用のゲームを取得する",
"tags": [
"game keys"
]
}
},
"/v2/project/{project_id}/items/groups": {
"get": {
"description": "カタログを作成するためのアイテムグループリストを取得します。",
"operationId": "get-item-groups",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"groups": [
{
"children": [],
"description": "Accessory",
"external_id": "accessory",
"level": 0,
"name": "Accessory",
"order": 1
},
{
"children": [],
"description": "Background",
"external_id": "background",
"level": 0,
"name": "Background",
"order": 1
},
{
"children": [],
"description": "Hair",
"external_id": "hair",
"level": 0,
"name": "Hair",
"order": 1
},
{
"children": [],
"description": "Outfit",
"external_id": "outfit",
"level": 0,
"name": "Outfit",
"order": 1
},
{
"children": [],
"description": "Body",
"external_id": "body",
"level": 0,
"name": "Body",
"order": 1
},
{
"children": [],
"description": "Body",
"external_id": "delete_group",
"level": 0,
"name": "Body",
"order": 1
},
{
"children": [
{
"children": [],
"description": "Group description",
"external_id": "test_group_secure",
"image_url": "http://static.xsolla.com/img/xsolla-logo2.png",
"level": 1,
"name": "Test group secure",
"order": 5,
"parent_external_id": "very_cool_group"
}
],
"description": "Very cool group",
"external_id": "very_cool_group",
"level": 0,
"name": "Very cool group",
"order": 1
},
{
"children": [
{
"children": [],
"description": "Group description",
"external_id": "test_group_split",
"image_url": "http://static.xsolla.com/img/xsolla-logo2.png",
"level": 1,
"name": "Test group secure",
"order": 1,
"parent_external_id": "test_group_secure"
}
],
"description": "Group description",
"external_id": "test_group_secure",
"image_url": "http://static.xsolla.com/img/xsolla-logo2.png",
"level": 0,
"name": "Test group secure",
"order": 1
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_9"
}
}
},
"description": "グループリストが正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "アイテムグループリストを取得する",
"tags": [
"virtual items & currency"
]
}
},
"/v2/project/{project_id}/items/virtual_currency": {
"get": {
"description": "カタログを作成するための仮想通貨リストを取得します。\n\n注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限フィールドとオフセットフィールドを使用します。
",
"operationId": "get-virtual-currency",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"description": "Big Rocket - short description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_currency",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"description": "description",
"groups": [
{
"external_id": "hair",
"name": "Hair"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_currency",
"virtual_prices": []
},
{
"attributes": [],
"description": "description",
"groups": [],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider_2",
"type": "virtual_currency",
"virtual_prices": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_6"
}
}
},
"description": "仮想通貨のリストが正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "仮想通貨リストを取得する",
"tags": [
"virtual items & currency"
]
}
},
"/v2/project/{project_id}/items/virtual_currency/package": {
"get": {
"description": "カタログを作成するための仮想通貨パッケージリストを取得します。\n\n注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限フィールドとオフセットフィールドを使用します。
",
"operationId": "get-virtual-currency-package",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Big Rocket - short description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "Big Rocket",
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency"
}
],
"description": "VC Short Package Description",
"groups": [],
"image_url": "http://vc_package_image.png",
"is_free": false,
"name": "VC Name first package",
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"sku": "vc_package_1",
"type": "bundle",
"virtual_prices": []
},
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "SHOTGUN FOR TRUE RAIDERS",
"quantity": 200,
"sku": "shotgun_raider",
"type": "virtual_currency"
}
],
"description": "VC Short Package Description",
"groups": [],
"image_url": "http://vc_package_image.png",
"is_free": false,
"name": "VC Name third package",
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"sku": "vc_package_3",
"type": "bundle",
"virtual_prices": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7"
}
}
},
"description": "仮想通貨パッケージのリストが正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "仮想通貨パッケージリストを取得する",
"tags": [
"virtual items & currency"
]
}
},
"/v2/project/{project_id}/items/virtual_items": {
"get": {
"description": "カタログを作成するための仮想アイテムリストを取得します。\n\n注意すべてのプロジェクトには、応答で取得できるアイテムの数に制限があります。デフォルトおよび最大値は応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限とオフセットフィールドを使用します。
",
"operationId": "get-virtual-items",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"description": "description",
"groups": [
{
"external_id": "hair",
"name": "Hair"
}
],
"image_url": "http://image.png",
"inventory_options": [
{
"consumable": [
{
"usages_count": 1
}
]
},
{
"expiration_period": [
{
"type": "day"
},
{
"value": 1
}
]
}
],
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
},
{
"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test_2",
"type": "virtual_currency"
}
]
},
{
"attributes": [],
"description": "description",
"groups": [],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider_2",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": []
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5"
}
}
},
"description": "仮想アイテムのリストが正常に受信されました。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "仮想アイテムリストを取得する",
"tags": [
"virtual items & currency"
]
}
},
"/v2/project/{project_id}/items/virtual_items/group/{external_id}": {
"get": {
"description": "カタログを作成するために、指定されたグループからアイテムリストを取得します。\n\n注意すべてのプロジェクトには、取得できるアイテムの数に制限があります。応答。デフォルトおよび最大値は1応答あたり50アイテムです。ページごとにより多くのデータを取得するには、制限とオフセットフィールドを使用します。
",
"operationId": "get-virtual-items-group",
"parameters": [
{
"$ref": "#/components/parameters/project-id-path-param"
},
{
"$ref": "#/components/parameters/external-id-path-param"
},
{
"$ref": "#/components/parameters/limit-query-param"
},
{
"$ref": "#/components/parameters/offset-query-param"
},
{
"$ref": "#/components/parameters/locale-query-param"
},
{
"$ref": "#/components/parameters/additional-fields-query-param"
},
{
"$ref": "#/components/parameters/country-query-param"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"items": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"description": "description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
},
{
"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test_2",
"type": "virtual_currency"
}
]
}
]
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_200_8"
}
}
},
"description": "指定されたグループからのアイテムリストが正常に受信されました。"
},
"404": {
"content": {
"application/json": {
"examples": {
"response": {
"value": {
"errorCode": 4403,
"errorMessage": "[0401-4403]: Item group not found",
"statusCode": 404
}
}
},
"schema": {
"$ref": "#/components/schemas/Catalog_inline_response_404_2"
}
}
},
"description": "グループが見つかりませんでした。`external_id`が正しいか、グループがオフになっていないか、削除されていないかを確認してください。"
}
},
"security": [
{
"AuthForClient": []
}
],
"summary": "指定されたグループごとにアイテムリストを取得する",
"tags": [
"virtual items & currency"
]
}
}
},
"components": {
"securitySchemes": {
"AuthForClient": {
"description": "[ユーザートークンを作成す](https://developers.xsolla.com\\/ja/api/digital-distribution-hub/operation/create-user-token)エンドポイントを使用してトークンを生成します。",
"scheme": "bearer",
"type": "http"
},
"basicAuth": {
"description": "Xsolla APIは、基本アクセス認証を使用します。APIへのすべてのリクエストには、`Authorization: Basic `ヘッダーが含まれている必要があります。ここで、`your_authorization_basic_key`は、Base64標準に従ってエンコードされた`distribution_hub_id:api_key`ペアです。\n\nアカウントマネージャーに連絡して、`distribution_hub_id`と`api_key`を取得してください。",
"scheme": "basic",
"type": "http"
}
},
"parameters": {
"project-id-path-param": {
"description": "プロジェクトID。",
"explode": false,
"in": "path",
"name": "project_id",
"required": true,
"schema": {
"example": 44056,
"type": "integer"
},
"style": "simple"
},
"currency-query-param": {
"description": "価格が表示される通貨（デフォルトではUSD）。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)に準拠した3文字の通貨コード。",
"explode": true,
"in": "query",
"name": "currency",
"required": false,
"schema": {
"default": "USD",
"type": "string"
},
"style": "form"
},
"locale-query-param": {
"description": "応答言語。ISO639-1に準拠した2文字の小文字の言語コード。",
"explode": true,
"in": "query",
"name": "locale",
"required": false,
"schema": {
"default": "en",
"type": "string"
},
"style": "form"
},
"item-sku-path-param": {
"description": "アイテムSKU。",
"explode": false,
"in": "path",
"name": "item_sku",
"required": true,
"schema": {
"example": "booster_mega_1",
"type": "string"
},
"style": "simple"
},
"cart-id-path-param": {
"description": "カートID。",
"explode": false,
"in": "path",
"name": "cart_id",
"required": true,
"schema": {
"example": "custom_id",
"type": "string"
},
"style": "simple"
},
"order-id-path-param": {
"description": "注文ID。",
"explode": false,
"in": "path",
"name": "order_id",
"required": true,
"schema": {
"example": "656",
"type": "string"
},
"style": "simple"
},
"limit-query-param": {
"description": "ページにある要素数の制限。",
"example": 50,
"explode": true,
"in": "query",
"name": "limit",
"required": false,
"schema": {
"example": 50,
"type": "integer"
},
"style": "form"
},
"offset-query-param": {
"description": "リストが生成される要素の番号（0からカウントされる）。",
"example": 0,
"explode": true,
"in": "query",
"name": "offset",
"required": false,
"schema": {
"example": 0,
"type": "integer"
},
"style": "form"
},
"additional-fields-query-param": {
"description": "追加フィールドのリスト。これらのフィールドは、リクエストで送信した場合、応答に含まれます。利用可能なフィールド`media_list`、`order`、`long_description`です。",
"explode": true,
"in": "query",
"name": "additional_fields[]",
"required": false,
"schema": {
"items": {
"type": "string"
},
"type": "array"
},
"style": "form"
},
"country-query-param": {
"description": "カタログの地域別価格と制限を計算するための国。[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)に準拠した2文字の大文字の国コードです。国を明示的に指定しない場合は、ユーザーのIPアドレスに基づいて計算されます。",
"explode": true,
"in": "query",
"name": "country",
"required": false,
"schema": {
"default": "US",
"type": "string"
},
"style": "form"
},
"sku-path-param": {
"description": "バンドルSKU。",
"explode": false,
"in": "path",
"name": "sku",
"required": true,
"schema": {
"example": "kg_1",
"type": "string"
},
"style": "simple"
},
"external-id-path-param": {
"description": "グループ外部ID。",
"explode": false,
"in": "path",
"name": "external_id",
"required": true,
"schema": {
"default": "all",
"type": "string"
},
"style": "simple"
}
},
"schemas": {
"Cart_admin-attribute-external_id": {
"description": "一意の属性ID。`external_id`には、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "attribute_1",
"maxLength": 255,
"minLength": 1,
"pattern": "^[a-zA-Z0-9-_]+$",
"type": "string"
},
"Cart_value-external_id": {
"description": "属性の一意の値ID。`external_id`には、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "attribute_value",
"maxLength": 255,
"minLength": 1,
"pattern": "^[-_.\\d\\w]+$",
"type": "string"
},
"Cart_clientattributes_inner": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Cart_admin-attribute-external_id"
},
"name": {
"description": "属性の名前。",
"example": "Genre",
"type": "string"
},
"values": {
"items": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Cart_value-external_id"
},
"value": {
"description": "属性の値。",
"example": "Strategy",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"Cart_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": {
"$ref": "#/components/schemas/Cart_clientattributes_inner"
},
"type": "array"
},
"Cart_inline_response_200_groups": {
"properties": {
"external_id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"type": "object"
},
"Cart_inline_response_200_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Cart_client-attributes"
},
"description": {
"type": "string"
},
"groups": {
"items": {
"$ref": "#/components/schemas/Cart_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"type": "string"
},
"is_free": {
"type": "boolean"
},
"name": {
"nullable": true,
"type": "string"
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"Cart_inline_response_200_price": {
"description": "カートの価格。",
"example": "{\"amount\":\"6150.0000000000000000\",\"amount_without_discount\":\"6150.0000000000000000\",\"currency\":\"USD\"}",
"nullable": true,
"properties": {
"amount": {
"default": "50.0000000000000000",
"type": "string"
},
"amount_without_discount": {
"default": "100.0000000000000000",
"type": "string"
},
"currency": {
"default": "USD",
"type": "string"
}
},
"type": "object"
},
"Cart_inline_response_200": {
"properties": {
"cart_id": {
"description": "カートID。",
"example": "cart_id",
"type": "string"
},
"is_free": {
"description": "`true`の場合、カートは無料です。",
"type": "boolean"
},
"items": {
"example": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Cart_inline_response_200_items"
},
"type": "array"
},
"price": {
"$ref": "#/components/schemas/Cart_inline_response_200_price"
}
},
"type": "object"
},
"Cart-Payment_settings_currency": {
"description": "標準の決済通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)3文字通貨コード。",
"type": "string"
},
"Cart_inline_response_200_1_warnings": {
"properties": {
"errorCode": {
"type": "integer"
},
"errorMessage": {
"type": "string"
},
"quantity": {
"type": "integer"
},
"sku": {
"type": "string"
}
},
"type": "object"
},
"Cart_inline_response_200_1": {
"properties": {
"cart_id": {
"description": "カートID。",
"example": "cart_id",
"type": "string"
},
"is_free": {
"description": "`true`の場合、カートは無料です。",
"type": "boolean"
},
"items": {
"items": {
"$ref": "#/components/schemas/Cart_inline_response_200_items"
},
"type": "array"
},
"price": {
"$ref": "#/components/schemas/Cart_inline_response_200_price"
},
"warnings": {
"example": [
{
"attributes": [],
"description": "Take it, take it all! All of Xsollas riches in one Mega Booster.",
"groups": [
{
"external_id": "powerups",
"name": "Power Ups"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Xsolla Booster Mega",
"price": {
"amount": "50.0000000000000000",
"amount_without_discount": "100.0000000000000000",
"currency": "USD"
},
"quantity": 123,
"sku": "booster_mega_1",
"type": "virtual_good",
"virtual_item_type": "consumable",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Cart_inline_response_200_1_warnings"
},
"type": "array"
}
},
"type": "object"
},
"Cart_inline_response_404": {
"properties": {
"errorCode": {
"example": 4001,
"type": "integer"
},
"errorMessage": {
"example": "[0401-4001]: Item with Project ID = 44056 and SKU = booster_mega_12222 not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
},
"Cart_inline_response_422_1": {
"properties": {
"errorCode": {
"example": 1421,
"type": "integer"
},
"errorMessage": {
"example": "This type of item cannot be put to the cart. Select another type of item.",
"type": "string"
},
"statusCode": {
"example": 422,
"type": "integer"
}
},
"type": "object"
},
"Cart_inline_response_422": {
"properties": {
"errorCode": {
"example": 1102,
"type": "integer"
},
"errorMessage": {
"example": "Item quantity must be non-negative integer.",
"type": "string"
},
"statusCode": {
"example": 422,
"type": "integer"
}
},
"type": "object"
},
"Order_inline_response_200_1_content_price_1": {
"description": "アイテム価格。",
"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"
},
"Order_inline_response_200_1_content_items": {
"properties": {
"is_free": {
"description": "`true`の場合、アイテムは無料です。",
"example": "false",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content_price_1"
},
"quantity": {
"description": "アイテム数量。",
"example": 1,
"type": "integer"
},
"sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "some_sku",
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_200_1_content_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"
},
"Order_inline_response_200_1_content_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"
},
"Order_inline_response_200_1_content": {
"description": "注文内容。",
"properties": {
"is_free": {
"description": "`true`の場合、注文は無料です。",
"example": "false",
"type": "string"
},
"items": {
"description": "アイテムリスト。",
"example": [
{
"is_free": false,
"price": {
"amount": "30",
"amount_without_discount": "30",
"currency": "USD"
},
"quantity": 1,
"sku": "some_sku"
}
],
"items": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content_items"
},
"type": "array"
},
"price": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content_price"
},
"virtual_price": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content_virtual_price"
}
},
"type": "object"
},
"Order_inline_response_200_1": {
"properties": {
"content": {
"$ref": "#/components/schemas/Order_inline_response_200_1_content"
},
"order_id": {
"description": "注文ID。",
"example": 1,
"type": "integer"
},
"status": {
"description": "注文状況：`new`/`paid`/`done`/`canceled`。",
"example": "paid",
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_404": {
"properties": {
"errorCode": {
"example": 9001,
"type": "integer"
},
"errorMessage": {
"example": "[0401-9001]: Order not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
},
"Order_inline_response_200_billing_info_direct_tax": {
"properties": {
"amount": {
"example": 150,
"type": "number"
},
"name": {
"example": "TAX",
"type": "string"
},
"rate": {
"example": 10,
"type": "number"
}
},
"type": "object"
},
"Order_inline_response_200_billing_info_indirect_tax": {
"properties": {
"amount": {
"example": 246.75,
"type": "number"
},
"name": {
"example": "VAT",
"type": "string"
},
"rate": {
"example": 20,
"type": "number"
}
},
"type": "object"
},
"Order_inline_response_200_billing_info_price": {
"properties": {
"amount": {
"example": 1480.45,
"type": "number"
},
"currency": {
"description": "購入通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)ごとの3文字のコード。",
"example": "USD",
"maxLength": 3,
"minLength": 3,
"type": "string"
}
},
"type": "object"
},
"Order_inline_response_200_billing_info": {
"description": "課金情報。",
"properties": {
"direct_tax": {
"items": {
"$ref": "#/components/schemas/Order_inline_response_200_billing_info_direct_tax"
},
"type": "array"
},
"indirect_tax": {
"items": {
"$ref": "#/components/schemas/Order_inline_response_200_billing_info_indirect_tax"
},
"type": "array"
},
"price": {
"$ref": "#/components/schemas/Order_inline_response_200_billing_info_price"
}
},
"type": "object"
},
"Order_inline_response_200": {
"properties": {
"billing_info": {
"$ref": "#/components/schemas/Order_inline_response_200_billing_info"
},
"order_id": {
"description": "注文ID。",
"type": "integer"
}
},
"type": "object"
},
"Order_inline_response_422": {
"properties": {
"errorCode": {
"example": 1401,
"type": "integer"
},
"errorMessage": {
"example": "[0401-1401]: Invalid cart",
"type": "string"
},
"statusCode": {
"example": 422,
"type": "integer"
}
},
"type": "object"
},
"Order_inline_response_422_1": {
"properties": {
"errorCode": {
"example": 1411,
"type": "integer"
},
"errorMessage": {
"example": "[0401-1411]: Invalid item",
"type": "string"
},
"statusCode": {
"example": 422,
"type": "integer"
}
},
"type": "object"
},
"email-required": {
"properties": {
"country": {
"description": "[ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)につき2文字の大文字の国コード。",
"example": "US",
"nullable": true,
"type": "string"
},
"email": {
"description": "購入したゲームキーを受け取ることができるユーザーの電子メールアドレス。",
"example": "public_email@test.com",
"type": "string"
},
"id": {
"description": "ゲーム内の一意ユーザー識別子。",
"example": "public_id",
"nullable": true,
"type": "string"
},
"ip": {
"description": "ユーザーのIPアドレス。",
"example": "127.0.0.1",
"nullable": true,
"type": "string"
},
"name": {
"description": "ユーザーの公称。",
"example": "Public name",
"nullable": true,
"type": "string"
},
"phone": {
"description": "ユーザーの電話番号。",
"example": "+66-000-000-00-00",
"nullable": true,
"type": "string"
}
},
"required": [
"email"
]
},
"Common_inline_response_200_1": {
"properties": {
"token": {
"description": "ユーザートークン。",
"type": "string"
}
},
"type": "object"
},
"Catalog_admin-attribute-external_id": {
"description": "一意の属性ID。`external_id`には、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "attribute_1",
"maxLength": 255,
"minLength": 1,
"pattern": "^[a-zA-Z0-9-_]+$",
"type": "string"
},
"Catalog_value-external_id": {
"description": "属性の一意の値ID。`external_id`には、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "attribute_value",
"maxLength": 255,
"minLength": 1,
"pattern": "^[-_.\\d\\w]+$",
"type": "string"
},
"Catalog_clientattributes_inner": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Catalog_admin-attribute-external_id"
},
"name": {
"description": "属性の名前。",
"example": "Genre",
"type": "string"
},
"values": {
"items": {
"properties": {
"external_id": {
"$ref": "#/components/schemas/Catalog_value-external_id"
},
"value": {
"description": "属性の値。",
"example": "Strategy",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_client-attributes-common": {
"default": [],
"description": "アイテムに対応する属性とその値のリスト。カタログのフィルタリングに使用できます。",
"items": {
"$ref": "#/components/schemas/Catalog_clientattributes_inner"
},
"type": "array"
},
"Catalog_bundle_type": {
"description": "バンドルタイプ。この場合、それは常に`standart`です。",
"example": "standart",
"type": "string"
},
"Catalog_client_content_inner": {
"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"
},
"name": {
"description": "アイテム名。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"description": "アイテム価格。",
"nullable": true,
"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"
},
"quantity": {
"description": "パッケージ内のアイテムの数量。",
"example": 250,
"type": "integer"
},
"sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "アイテムのタイプ：`virtual_good`/`virtual_currency`/`bundle`。",
"example": "virtual_currency",
"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"
},
"Catalog_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": "big_rocket",
"type": "virtual_currency"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_client_content_inner"
},
"type": "array"
},
"Catalog_client_description": {
"description": "アイテム説明。",
"example": "Big Rocket - description.",
"nullable": true,
"type": "string"
},
"Catalog_groups_response_inner": {
"properties": {
"external_id": {
"example": "horror",
"type": "string"
},
"name": {
"example": {
"en": "Horror"
},
"type": "object"
}
},
"type": "object"
},
"Catalog_groups_response": {
"default": [],
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "horror",
"name": {
"en": "Horror"
}
}
],
"items": {
"$ref": "#/components/schemas/Catalog_groups_response_inner"
},
"type": "array"
},
"Catalog_image_url": {
"description": "画像のURL。",
"example": "https://image.example.com",
"nullable": true,
"type": "string"
},
"Catalog_is_free": {
"default": "false",
"description": "常には`false`です。",
"example": "false",
"type": "string"
},
"Catalog_client_name": {
"description": "アイテム名。",
"example": "Big Rocket",
"type": "string"
},
"Catalog_amount": {
"description": "割引アイテム価格。",
"example": "100.99",
"pattern": "^\\d*\\.?\\d*$",
"type": "string"
},
"Catalog_amount_without_discount": {
"description": "アイテム価格。",
"example": "100.99",
"pattern": "^\\d*\\.?\\d*$",
"type": "string"
},
"Catalog_currency": {
"description": "購入通貨。[ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)ごとの3文字のコード。",
"example": "USD",
"type": "string"
},
"Catalog_price": {
"description": "アイテム価格。",
"nullable": true,
"properties": {
"amount": {
"$ref": "#/components/schemas/Catalog_amount"
},
"amount_without_discount": {
"$ref": "#/components/schemas/Catalog_amount_without_discount"
},
"currency": {
"$ref": "#/components/schemas/Catalog_currency"
}
},
"required": [
"amount",
"amount_without_discount",
"currency"
],
"type": "object"
},
"Catalog_sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "bundle_1",
"type": "string"
},
"Catalog_total_content_price": {
"description": "バンドルコンテンツの価格の合計。",
"nullable": true,
"properties": {
"amount": {
"description": "バンドルコンテンツの割引価格の合計。",
"example": "100.99",
"type": "string"
},
"amount_without_discount": {
"description": "バンドルコンテンツの価格の合計。",
"example": "100.99",
"type": "string"
},
"currency": {
"$ref": "#/components/schemas/Catalog_currency"
}
},
"type": "object"
},
"Catalog_type": {
"description": "アイテムタイプ。",
"example": "bundle",
"type": "string"
},
"Catalog_virtual_prices_inner": {
"description": "仮想価格。",
"properties": {
"amount": {
"description": "仮想通貨での割引アイテム価格。",
"example": 100,
"type": "integer"
},
"amount_without_discount": {
"description": "仮想通貨でのアイテム価格。",
"example": 200,
"type": "integer"
},
"description": {
"description": "仮想通貨の説明。",
"example": "Most popular gold",
"nullable": true,
"type": "string"
},
"image_url": {
"description": "仮想通貨の画像。",
"example": "http://image.png",
"nullable": true,
"type": "string"
},
"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"
},
"Catalog_virtual_prices": {
"description": "仮想価格。",
"items": {
"$ref": "#/components/schemas/Catalog_virtual_prices_inner"
},
"type": "array"
},
"Catalog_client_bundle": {
"description": "指定されたバンドル。",
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes-common"
},
"bundle_type": {
"$ref": "#/components/schemas/Catalog_bundle_type"
},
"content": {
"$ref": "#/components/schemas/Catalog_client_content"
},
"description": {
"$ref": "#/components/schemas/Catalog_client_description"
},
"groups": {
"$ref": "#/components/schemas/Catalog_groups_response"
},
"image_url": {
"$ref": "#/components/schemas/Catalog_image_url"
},
"is_free": {
"$ref": "#/components/schemas/Catalog_is_free"
},
"name": {
"$ref": "#/components/schemas/Catalog_client_name"
},
"price": {
"$ref": "#/components/schemas/Catalog_price"
},
"sku": {
"$ref": "#/components/schemas/Catalog_sku"
},
"total_content_price": {
"$ref": "#/components/schemas/Catalog_total_content_price"
},
"type": {
"$ref": "#/components/schemas/Catalog_type"
},
"virtual_prices": {
"$ref": "#/components/schemas/Catalog_virtual_prices"
}
},
"type": "object"
},
"Catalog_inline_response_200_10": {
"description": "アイテムを持つオブジェクト。",
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Catalog_client_bundle"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_groups": {
"properties": {
"external_id": {
"example": "accessory",
"type": "string"
},
"name": {
"example": "Accessory",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_price": {
"description": "アイテム価格。",
"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"
},
"Catalog_inline_response_200_virtual_prices": {
"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"
},
"Catalog_inline_response_200_unit_items": {
"properties": {
"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": {
"description": "`true`の場合、アイテムは無料です。",
"example": false,
"type": "boolean"
},
"is_pre_order": {
"description": "`true`の場合、ゲームキーは先行予約済みで、リリース日は過ぎていません。",
"example": true,
"type": "boolean"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_price"
},
"release_date": {
"description": "ISO8601形式のゲームキーのリリース日。",
"example": "2020-08-11T10:00:00+03:00",
"type": "string"
},
"sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "game_01",
"type": "string"
},
"type": {
"description": "アイテムのタイプ：`game_key`。",
"example": "game_key",
"type": "string"
},
"virtual_prices": {
"description": "仮想価格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes-common"
},
"description": {
"description": "アイテム説明。",
"example": "Game description",
"type": "string"
},
"groups": {
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "画像のURL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"name": {
"description": "アイテム名。",
"example": "Game name",
"type": "string"
},
"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": {
"$ref": "#/components/schemas/Catalog_inline_response_200_unit_items"
},
"type": "array"
},
"unit_type": {
"description": "ユニットのタイプ：`game`。",
"example": "game",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200": {
"description": "ゲームを持つオブジェクト。",
"properties": {
"items": {
"example": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
},
{
"attributes": [
{
"external_id": "OS",
"name": "OS",
"values": [
{
"external_id": "9d5c5efb7c0f00a00fe4e3583f1215b0050bc723",
"value": "Windows"
}
]
}
],
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_2",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_4_drm": {
"properties": {
"drm_id": {
"description": "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"
},
"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"
},
"Catalog_inline_response_200_4": {
"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"
},
{
"drm_id": 2,
"image": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Playstation",
"redeem_instruction_link": "https://support.us.playstation.com",
"sku": "playstation"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_4_drm"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_client-attributes": {
"default": [],
"description": "ゲームに対応する属性とその値のリスト。\n\n注意。応答のこの部分は、`additional_fields[] = attributes`クエリパラメータを送信した場合にのみ使用できます。
",
"items": {
"$ref": "#/components/schemas/Catalog_clientattributes_inner"
},
"type": "array"
},
"Catalog_inline_response_200_3_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "アイテム説明。",
"example": "Game description",
"type": "string"
},
"drm_name": {
"description": "DRM名。",
"example": "Steam",
"type": "string"
},
"drm_sku": {
"description": "一意のDRM ID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "steam",
"type": "string"
},
"groups": {
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"has_keys": {
"description": "`true`の場合、ゲームキーには販売用のキーがあります。",
"example": false,
"type": "boolean"
},
"image_url": {
"description": "画像のURL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"is_free": {
"description": "`true`の場合、アイテムは無料です。",
"example": false,
"type": "boolean"
},
"is_pre_order": {
"description": "`true`の場合、ゲームキーは先行予約済みで、リリース日は過ぎていません。",
"example": true,
"type": "boolean"
},
"name": {
"description": "アイテム名。",
"example": "Game name",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_price"
},
"release_date": {
"description": "ISO8601形式のゲームキーのリリース日。",
"example": "2020-08-11T10:00:00+03:00",
"type": "string"
},
"sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "game_01",
"type": "string"
},
"type": {
"description": "アイテムのタイプ：`game_key`。",
"example": "game_key",
"type": "string"
},
"virtual_prices": {
"description": "仮想価格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_3": {
"description": "ゲームを持つオブジェクト。",
"properties": {
"items": {
"example": [
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": true,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_1",
"type": "game_key",
"virtual_prices": []
},
{
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": false,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_2",
"type": "game_key",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_3_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_2": {
"description": "ゲームキー情報を持つオブジェクト。",
"example": {
"attributes": {
"$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
},
"description": "Game description",
"drm_name": "Steam",
"drm_sku": "steam",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"has_keys": true,
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"is_free": false,
"is_pre_order": true,
"name": "Game name",
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_1",
"type": "game_key",
"virtual_prices": []
},
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes-common"
},
"description": {
"description": "アイテム説明。",
"example": "Game description",
"type": "string"
},
"drm_name": {
"description": "DRM名。",
"example": "Steam",
"type": "string"
},
"drm_sku": {
"description": "一意のDRM ID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "steam",
"type": "string"
},
"groups": {
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"has_keys": {
"description": "`true`の場合、ゲームキーには販売用のキーがあります。",
"example": false,
"type": "boolean"
},
"image_url": {
"description": "画像のURL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"is_free": {
"description": "`true`の場合、アイテムは無料です。",
"example": false,
"type": "boolean"
},
"is_pre_order": {
"description": "`true`の場合、ゲームキーは先行予約済みで、リリース日は過ぎていません。",
"example": true,
"type": "boolean"
},
"name": {
"description": "アイテム名。",
"example": "Game name",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_price"
},
"release_date": {
"description": "ISO8601形式のゲームキーのリリース日。",
"example": "2020-08-11T10:00:00+03:00",
"type": "string"
},
"sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "game_01",
"type": "string"
},
"type": {
"description": "アイテムのタイプ：`game_key`。",
"example": "game_key",
"type": "string"
},
"virtual_prices": {
"description": "仮想価格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_404_1": {
"properties": {
"errorCode": {
"example": 4001,
"type": "integer"
},
"errorMessage": {
"example": "[0401-4001]: Item with sku = 'game_key_1' not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_1": {
"description": "ゲーム情報を持つオブジェクト。",
"example": {
"attributes": {
"$ref": "#/components/examples/client-attribute-game/Catalog_value"
},
"description": "Game description",
"groups": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla games"
}
],
"image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"name": "Game name",
"sku": "game_1",
"type": "unit",
"unit_items": [
{
"drm_name": "Steam",
"drm_sku": "steam",
"has_keys": true,
"is_free": false,
"is_pre_order": true,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"release_date": "2020-08-11T10:00:00+03:00",
"sku": "game_key_01",
"type": "game_key",
"virtual_prices": []
},
{
"drm_name": "Origin",
"drm_sku": "origin",
"has_keys": false,
"is_free": false,
"is_pre_order": false,
"price": {
"amount": "30.5",
"amount_without_discount": "30.5",
"currency": "USD"
},
"sku": "game_key_02",
"type": "game_key",
"virtual_prices": []
}
],
"unit_type": "game"
},
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "アイテム説明。",
"example": "Game description",
"type": "string"
},
"groups": {
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "all",
"name": "All games"
},
{
"external_id": "Xsolla",
"name": "Xsolla game"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "画像のURL。",
"example": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
"type": "string"
},
"name": {
"description": "アイテム名。",
"example": "Game name",
"type": "string"
},
"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": {
"$ref": "#/components/schemas/Catalog_inline_response_200_unit_items"
},
"type": "array"
},
"unit_type": {
"description": "ユニットのタイプ：`game`。",
"example": "game",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_404": {
"properties": {
"errorCode": {
"example": 4001,
"type": "integer"
},
"errorMessage": {
"example": "[0401-4001]: Item with sku = 'game_1' not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_9_children": {
"properties": {
"children": {
"description": "子グループ。",
"example": [],
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "グループの説明。",
"example": "Accessory",
"type": "string"
},
"external_id": {
"description": "外部グループID。",
"example": "accessory",
"type": "string"
},
"image_url": {
"description": "画像のURL。",
"type": "string"
},
"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"
}
},
"type": "object"
},
"Catalog_inline_response_200_9_children_1": {
"properties": {
"children": {
"description": "子グループ。",
"example": [
{
"children": [],
"description": "Accessory",
"external_id": "accessory",
"level": 2,
"name": "Accessory",
"order": 1,
"parent_external_id": "background"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_9_children"
},
"type": "array"
},
"description": {
"description": "グループの説明。",
"example": "Background description",
"type": "string"
},
"external_id": {
"description": "外部グループID。",
"example": "background",
"type": "string"
},
"image_url": {
"description": "グループ画像のURL。",
"type": "string"
},
"level": {
"description": "グループのネスティングレベル。",
"example": 1,
"type": "integer"
},
"name": {
"description": "グループ名。",
"example": "Background",
"type": "string"
},
"order": {
"description": "配置順序を定義します。",
"example": 1,
"type": "integer"
},
"parent_external_id": {
"description": "親外部グループID",
"example": "hair",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_9_groups": {
"properties": {
"children": {
"description": "子グループ。",
"example": [
{
"children": [
{
"children": [],
"description": "Accessory",
"external_id": "accessory",
"level": 2,
"name": "Accessory",
"order": 1,
"parent_external_id": "background"
}
],
"description": "Background description",
"external_id": "background",
"level": 1,
"name": "Background",
"order": 1,
"parent_external_id": "hair"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_9_children_1"
},
"type": "array"
},
"description": {
"description": "グループの説明。",
"example": "Hair description",
"type": "string"
},
"external_id": {
"description": "外部グループID。",
"example": "hair",
"type": "string"
},
"image_url": {
"description": "画像のURL。",
"type": "string"
},
"level": {
"description": "グループのネスティングレベル。",
"example": 0,
"type": "integer"
},
"name": {
"description": "グループ名。",
"example": "Hair",
"type": "string"
},
"order": {
"description": "配置順序を定義します。",
"example": 1,
"type": "integer"
},
"parent_external_id": {
"description": "親外部グループID",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_9": {
"properties": {
"groups": {
"example": [
{
"children": [
{
"children": [
{
"children": [],
"description": "Accessory",
"external_id": "accessory",
"level": 2,
"name": "Accessory",
"order": 1,
"parent_external_id": "background"
}
],
"description": "Background description",
"external_id": "background",
"level": 1,
"name": "Background",
"order": 1,
"parent_external_id": "hair"
}
],
"description": "Hair description",
"external_id": "hair",
"level": 0,
"name": "Hair",
"order": 1
},
{
"children": [],
"description": "Super description",
"external_id": "group_external_id",
"level": 0,
"name": "Super",
"order": 1
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_9_groups"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_inventory_options_consumable": {
"description": "消耗品の場合は消耗品のプロパティを、非消耗品の場合は`null`を定義します。",
"nullable": true,
"properties": {
"usages_count": {
"description": "消耗品の場合は残りの総使用回数、非消耗品の場合は`null`となります。",
"example": 1,
"nullable": true,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_inventory_options_expiration_period": {
"description": "期限付きアイテムの場合は有効期限のプロパティを定義し、期限のないアイテムの場合は`null`を定義します。",
"nullable": true,
"properties": {
"type": {
"description": "アイテムの有効期限のタイプを定義します。",
"enum": [
"minute",
"hour",
"day",
"week",
"month",
"year"
],
"example": "day",
"type": "string"
},
"value": {
"description": "有効期限の値を定義します。",
"example": 1,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_inventory_options": {
"description": "インベントリアイテムオプションを定義します。",
"properties": {
"consumable": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_consumable"
},
"expiration_period": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_expiration_period"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_price": {
"description": "アイテム価格。",
"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"
},
"Catalog_inline_response_200_6_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "アイテム説明。",
"example": "Big Rocket - description",
"type": "string"
},
"groups": {
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "画像のURL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"inventory_options": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options"
},
"is_free": {
"description": "`true`の場合、アイテムは無料です。",
"example": "false",
"type": "string"
},
"name": {
"description": "アイテム名。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_price"
},
"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": "shotgun_raider"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_6": {
"properties": {
"items": {
"example": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
}
],
"description": "Big Rocket - short description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_currency",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "1"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"description": "description",
"groups": [
{
"external_id": "hair",
"name": "Hair"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_currency",
"virtual_prices": []
},
{
"attributes": [],
"description": "description",
"groups": [],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"is_free": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider_2",
"type": "virtual_currency",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_6_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_7_inventory_options_expiration_period": {
"description": "期限付きアイテムの場合は有効期限のプロパティを定義し、期限のないアイテムの場合は`null`を定義します。",
"nullable": true,
"properties": {
"type": {
"description": "アイテムの有効期限のタイプを定義します。",
"enum": [
"minute",
"hour",
"day",
"week",
"month",
"year"
],
"example": "day",
"type": "string"
},
"value": {
"description": "有効期限の値を定義します。",
"example": 1,
"type": "integer"
}
},
"type": "object"
},
"Catalog_inline_response_200_7_inventory_options": {
"description": "インベントリアイテムオプションを定義します。",
"properties": {
"consumable": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options_consumable"
},
"expiration_period": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options_expiration_period"
}
},
"type": "object"
},
"Catalog_inline_response_200_7_content": {
"description": "パッケージ内の仮想通貨。",
"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"
},
"inventory_options": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options"
},
"name": {
"description": "アイテム名。",
"example": "Big Rocket",
"type": "string"
},
"quantity": {
"description": "パッケージ内の仮想通貨の数量。",
"example": 250,
"type": "integer"
},
"sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "アイテムのタイプ：`virtual_good`/`virtual_currency`/`bundle`。",
"example": "virtual_currency",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_7_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"bundle_type": {
"description": "バンドルのタイプ：`standard`/`virtual_currency_package`。",
"example": "virtual_currency_package",
"type": "string"
},
"content": {
"description": "仮想通貨パッケージのコンテンツ。",
"example": [
{
"description": "Big Rocket - short description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "Big Rocket",
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_content"
},
"type": "array"
},
"description": {
"description": "アイテム説明。",
"example": "Big Rocket - description",
"type": "string"
},
"groups": {
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "画像のURL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"is_free": {
"description": "`true`の場合、アイテムは無料です。",
"example": "false",
"type": "string"
},
"name": {
"description": "アイテム名。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_price"
},
"sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "アイテムのタイプ：`virtual_good`/`virtual_currency`/`bundle`。",
"example": "bundle",
"type": "string"
},
"virtual_prices": {
"description": "仮想価格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_7": {
"description": "アイテムを持つオブジェクト。",
"properties": {
"items": {
"example": [
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "Big Rocket - short description",
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "Big Rocket",
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency"
}
],
"description": "VC Short Package Description",
"groups": [],
"image_url": "http://vc_package_image.png",
"is_free": false,
"name": "VC Name first package",
"price": {
"amount": "2.0000",
"amount_without_discount": "2.0000",
"currency": "USD"
},
"sku": "vc_package_1",
"type": "bundle",
"virtual_prices": []
},
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": "description",
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
}
},
"name": "SHOTGUN FOR TRUE RAIDERS",
"quantity": 200,
"sku": "shotgun_raider",
"type": "virtual_currency"
}
],
"description": "VC Short Package Description",
"groups": [],
"image_url": "http://vc_package_image.png",
"is_free": false,
"name": "VC Name third package",
"price": {
"amount": "4.0000",
"amount_without_discount": "4.0000",
"currency": "USD"
},
"sku": "vc_package_3",
"type": "bundle",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_5_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "アイテム説明。",
"example": "Big Rocket - description",
"type": "string"
},
"groups": {
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "画像のURL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"inventory_options": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_inventory_options"
},
"is_free": {
"description": "`true`の場合、アイテムは無料です。",
"example": false,
"type": "boolean"
},
"name": {
"description": "アイテム名。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_price"
},
"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": "仮想アイテムのタイプ。",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
],
"example": "non-consumable",
"type": "string"
},
"virtual_prices": {
"description": "仮想価格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_5": {
"description": "仮想アイテムを持つオブジェクト。",
"properties": {
"items": {
"example": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
}
],
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"external_id": "rating_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "3.9"
}
]
}
],
"description": "description",
"groups": [
{
"external_id": "hair",
"name": "Hair"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
},
{
"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test_2",
"type": "virtual_currency"
}
]
},
{
"attributes": [],
"description": "description",
"groups": [],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "shotgun_raider_2",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": []
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_8_virtual_prices": {
"description": "仮想価格。",
"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": "vc_test",
"type": "string"
},
"type": {
"description": "仮想通貨タイプ。",
"example": "virtual_currency",
"type": "string"
}
},
"type": "object"
},
"Catalog_inline_response_200_8_items": {
"properties": {
"attributes": {
"$ref": "#/components/schemas/Catalog_client-attributes"
},
"description": {
"description": "アイテム説明。",
"example": "Big Rocket - description",
"type": "string"
},
"groups": {
"description": "アイテムが属するグループ。",
"example": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_groups"
},
"type": "array"
},
"image_url": {
"description": "画像のURL。",
"example": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"type": "string"
},
"inventory_options": {
"$ref": "#/components/schemas/Catalog_inline_response_200_7_inventory_options"
},
"is_free": {
"description": "`true`の場合、アイテムは無料です。",
"example": "false",
"type": "string"
},
"name": {
"description": "アイテム名。",
"example": "Big Rocket",
"type": "string"
},
"price": {
"$ref": "#/components/schemas/Catalog_inline_response_200_5_price"
},
"sku": {
"description": "一意のアイテムID。SKUには、小文字のラテン英数字、ピリオド、ダッシュ、およびアンダースコアのみを含めることができます。",
"example": "big_rocket",
"type": "string"
},
"type": {
"description": "アイテムのタイプ：`consumable`/`expiration`/`permanent`/`lootboxes`/`physical`。",
"example": "virtual_good",
"type": "string"
},
"virtual_item_type": {
"description": "仮想アイテムのタイプ。",
"enum": [
"consumable",
"non_consumable",
"non_renewing_subscription"
],
"example": "non_consumable",
"type": "string"
},
"virtual_prices": {
"description": "仮想価格。",
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_8_virtual_prices"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_200_8": {
"properties": {
"items": {
"example": [
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
}
],
"description": "Big Rocket - description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": "100.99",
"amount_without_discount": "100.99",
"currency": "USD"
},
"sku": "big_rocket",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
}
]
},
{
"attributes": [
{
"external_id": "stack_size",
"name": "Stack size",
"values": [
{
"value": "5"
}
]
},
{
"external_id": "rating",
"name": "Rating",
"values": [
{
"value": "3.9"
}
]
},
{
"external_id": "genre",
"name": "Genre",
"values": [
{
"value": "Strategy"
},
{
"value": "Tactical"
},
"Turn-based"
]
}
],
"description": "description",
"groups": [
{
"external_id": "accessory",
"name": "Accessory"
}
],
"image_url": "http://image.png",
"inventory_options": {
"consumable": {
"usages_count": 1
},
"expiration_period": {
"type": "day",
"value": 1
}
},
"is_free": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"price": {
"amount": "101.0",
"amount_without_discount": "101.0",
"currency": "USD"
},
"sku": "shotgun_raider",
"type": "virtual_good",
"virtual_item_type": "non_renewing_subscription",
"virtual_prices": [
{
"amount": 100,
"amount_without_discount": 100,
"description": "description",
"image_url": "http://image.png",
"is_default": true,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test",
"type": "virtual_currency"
},
{
"amount": 200,
"amount_without_discount": 200,
"description": "description",
"image_url": "http://image.png",
"is_default": false,
"name": "SHOTGUN FOR TRUE RAIDERS",
"sku": "vc_test_2",
"type": "virtual_currency"
}
]
}
],
"items": {
"$ref": "#/components/schemas/Catalog_inline_response_200_8_items"
},
"type": "array"
}
},
"type": "object"
},
"Catalog_inline_response_404_2": {
"properties": {
"errorCode": {
"example": 4403,
"type": "integer"
},
"errorMessage": {
"example": "[0401-4403]: Item group not found",
"type": "string"
},
"statusCode": {
"example": 404,
"type": "integer"
}
},
"type": "object"
}
},
"requestBodies": {
"fill-cart-json-model": {
"content": {
"application/json": {
"schema": {
"example": [
{
"quantity": 123,
"sku": "booster_mega_1"
}
],
"properties": {
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"items": {
"description": "アイテムのリスト。",
"items": {
"minItems": 1,
"properties": {
"quantity": {
"default": 123,
"type": "number"
},
"sku": {
"default": "booster_mega_1",
"type": "string"
}
},
"required": [
"quantity",
"sku"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
}
}
},
"put-item-by-cart-id-json-model": {
"content": {
"application/json": {
"schema": {
"properties": {
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"quantity": {
"default": 123,
"description": "アイテム数量。",
"type": "number"
}
},
"type": "object"
}
}
}
},
"create-order-model": {
"content": {
"application/json": {
"schema": {
"example": {
"geotype": 13038
},
"properties": {
"currency": {
"$ref": "#/components/schemas/Cart-Payment_settings_currency"
},
"geotype": {
"description": "エクソラ側の配信者パートナーID。",
"type": "number"
},
"quantity": {
"description": "アイテム数量。",
"example": 1,
"type": "integer"
}
},
"required": [
"geotype",
"currency"
],
"type": "object"
}
}
},
"description": "注文作成データを持つオブジェクト。",
"required": true
},
"post-user-token-json-model": {
"content": {
"application/json": {
"schema": {
"properties": {
"user": {
"$ref": "#/components/schemas/email-required",
"description": "ユーザーの詳細。",
"type": "object"
}
},
"required": [
"user"
],
"type": "object"
}
}
}
}
},
"examples": {
"200-get-bundle-list": {
"value": {
"items": [
{
"attributes": {
"external_id": "genre",
"name": "Genre",
"values": [
{
"external_id": "genre_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Casual"
},
{
"external_id": "genre_eba07bfd0f982940773cba3744d97264dd58acd7",
"value": "Strategy"
},
{
"external_id": "genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8",
"value": "Mobile"
}
]
},
"bundle_type": "standard",
"content": [
{
"attributes": {
"external_id": "size",
"name": "Size",
"values": [
{
"external_id": "size_e3364991f92e751689a68b96598a5a5a84010b85",
"value": "Large"
}
]
},
"description": "Big Rocket - short description.",
"groups": [],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency",
"virtual_item_type": "non_consumable",
"virtual_prices": []
}
],
"description": "pricePoint_44056_1",
"groups": [],
"is_free": false,
"media_list": [],
"name": "kg_10.00_bundle",
"order": 999,
"price": {
"amount": 9.99,
"amount_without_discount": 9.99,
"currency": "USD"
},
"sku": "kg_1",
"total_content_price": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"type": "bundle",
"virtual_prices": []
}
]
}
},
"200-get-bundle": {
"value": {
"attributes": [],
"bundle_type": "standard",
"content": [
{
"attributes": [],
"description": "Big Rocket - short description.",
"groups": [],
"image_url": "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png",
"is_free": false,
"name": "Big Rocket",
"price": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"quantity": 100,
"sku": "big_rocket",
"type": "virtual_currency",
"virtual_prices": []
}
],
"description": "pricePoint_44056_1.",
"groups": [],
"is_free": false,
"media_list": [],
"name": "kg_10.00_bundle",
"order": 999,
"price": {
"amount": 9.99,
"amount_without_discount": 9.99,
"currency": "USD"
},
"sku": "kg_1",
"total_content_amount": {
"amount": 10.99,
"amount_without_discount": 10.99,
"currency": "USD"
},
"type": "bundle",
"virtual_prices": []
}
}
}
},
"x-tagGroups": [
{
"name": "カート",
"tags": [
"cart"
]
},
{
"name": "カタログ",
"tags": [
"game keys",
"virtual items & currency",
"bundles"
]
},
{
"name": "一般",
"tags": [
"user token"
]
},
{
"name": "通知",
"tags": [
"notifications"
]
},
{
"name": "注文",
"tags": [
"order"
]
}
]
}