購入したアイテムをユーザーに付与する

Digital Distribution Hub API

In-Game Store & Buy Button API

概要

API定義をダウンロードする

ユーザー属性

管理者

個人用カタログ

バンドル

管理者

カタログ

カート＆決済

カート（クライアント側）

カート（サーバー側）

決済（クライアント側）

決済（サーバー側）

注文

無料アイテム

通常

ウェブフック

先行予約

マーチャント

カタログ

共通地域

ゲームキー

カタログ

資格

管理者

プレイヤーインベントリ

クライアント

管理

クロスインベントリ

プロモーション

通常

クーポン

プロモーションコード

Unique catalog offers

ディスカウント

ボーナス

仮想アイテム & 仮想通貨

管理者

カタログ

仮想決済

NFTアイテム

管理者

カタログ

制限

管理

REWARD CHAINS & VALUE POINTS

管理者

クライアント

Pay Station API

Publisher Account API

Subscriptions API

Webhooks

購入したアイテムをユーザーに付与する

post/v2/project/{project_id}/inventory/purchase

指定されたユーザーインベントリに、指定された購入アイテムを追加します。

注意

一度に処理できる操作は最大50個です。この制限を超える操作は無視されます。

SecuritybasicAuth

Request

path Parameters

project_id

required

integer

Default: 44056

プロジェクトID。

Request Body schema: application/json

Array

required

object

id	string Default: "d342dad2-9d59-11e9-a384-42010aa8003f" プラットフォーム上でユニークなユーザー識別子。

required

Array of objects non-empty

Array (non-empty)

sku required	string Default: "booster_mega_1" アイテムクラス識別子。SKUには、英小文字、ピリオド、ダッシュ、およびアンダースコアのみが含まれます。
quantity required	number Default: 1 このクラスのアイテムが付与されるために必要な数。

required

object

amount required	string Default: "2.99" 控除前の購入金額。
currency required	string Default: "USD" ISO 4217に基づく通貨を購入します。
external_purchase_id required	string Default: "10-534-35" 購入したプラットフォームからの購入インボイス識別子。
external_purchase_date required	string Default: "2020-01-01T05:00:00+05:00" ISO 8601に基づく購入日。

comment

string [ 1 .. 255 ] characters

Default: "Monthly challenge rewards"

操作説明。例：「毎月のチャレンジリワード」。

object [ 1 .. 200 ] properties

プロジェクト特有のパラメータ。

additional property	Array of arrays or object or string or integer or null or number or boolean
One of: arrays

platform

string

Default: "xsolla"

ユーザーがプレイするパブリッシングプラットフォーム。

Enum: "playstation_network" "xbox_live" "xsolla" "pc_standalone" "nintendo_shop" "google_play" "app_store_ios" "android_standalone" "ios_standalone" "android_other" "ios_other" "pc_other"

Responses

200

ユーザーの購入に成功しました。

422

処理不可能なエンティティー。

Request samples

application/json

[{"purchase": {"amount": "3.5",
"comment": "xsolla",
"currency": "USD",
"custom_parameters": [{"user_device_info": {"engine_version": "Unity 2020.2.0b5",
"os": "windows"
},
"user_public_id": {"nickname": "player1"
}
},
{"comment": "xsolla",
"custom_parameters": {"content_creator_rewards": [{"content_creator": {"id": "cc1"
},
"reward": {"amount": "10.00",
"currency": "USD"
}
},
{"content_creator": {"id": "cc2"
},
"reward": {"amount": "15.00",
"currency": "RUB"
}
}
]
},
"items": [{"quantity": 5,
"sku": "panda_sdk3"
},
{"quantity": 3,
"sku": "panda_sdk2"
}
],
"platform": "xsolla",
"purchase": {"amount": "3.5",
"currency": "USD",
"external_purchase_date": "2020-01-01T00:00:00+05:00",
"external_purchase_id": "1000001"
},
"user": {"id": "83857636-65b4-11e8-9ccb-42010a8a001c"
}
}
],
"external_purchase_date": "2020-01-01T00:00:00+05:00",
"external_purchase_id": "1000000",
"items": [{"quantity": 5,
"sku": "panda_sdk"
},
{"quantity": 3,
"sku": "panda_sdk2"
}
],
"platform": "xsolla",
"user": {"id": "672c91cd-65db-4b6e-ad68-6e93b21249d8"
}
}
}
]

Response samples

application/json

{"count": 2,
"operations": [{"amount": "2.99",
"comment": "Quest completed",
"currency": "USD",
"custom_parameters": {"array_param": [{"user_device_info": {"engine_version": "Unity 2020.2.0b5",
"os": "windows"
},
"user_public_id": {"nickname": "player1"
}
},
{"user_device_info": {"engine_version": "UE 4.25",
"os": "mac"
},
"user_public_id": {"nickname": "player2"
}
}
]
},
"external_purchase_date": "2020-01-01T05:00:00+05:00",
"external_purchase_id": "10-534-35",
"items": [{"quantity": 5,
"sku": "boots_1"
},
{"quantity": 3,
"sku": "crystal_pack_1"
}
],
"order_id": 123456,
"platform": "xbox_live",
"user_id": "0125760a-6810-11e9-84c0-42010aa80029"
},
{"amount": "2.99",
"comment": "Daily reward",
"currency": "USD",
"custom_parameters": null,
"external_purchase_date": "2020-01-01T05:00:00+05:00",
"external_purchase_id": "10-534-35",
"items": [{"quantity": 2,
"sku": "helmet_1"
},
{"quantity": 3,
"sku": "minigun_1"
}
],
"order_id": 123457,
"platform": "xbox_live",
"user_id": "a7d10a4e-3f68-43cc-a6b2-893d2c68fd14"
}
]
}