Skip to main content

POST ()

消費型インベントリ アイテムの全部または一部が使用されたことを示し、要求された量だけ消費アイテムの数量を減らします。 これらの URI のドメインは inventory.xboxlive.com です。

注釈

  • 呼び出し元が消費するように要求した数量がアイテムの残りの供給量を超える場合、その呼び出しは拒否されます。
  • 呼び出し元が消費するように要求した数量は、0 より大きい正の整数である必要があります。消費値が 0 以下の呼び出しは拒否されます。
  • 呼び出し元が空のトランザクション ID を指定した場合、リクエストは拒否されます。
  • 利用可能な場合、タイトル要求 (title claim) がログに記録され、どのタイトルが消費を報告しているかを判別できるようになります。
  • 同じ transactionId を持つ追加の POST は、一定期間無視されます。
注:
この API の x-xbl-contract-version ヘッダーは “4” です。

URI パラメーター

| パラメーター| 種類| 説明| | --- | --- | --- | --- | | itemID| string| 単一のインベントリ アイテムに対してユーザーごとに一意の ID|

リクエスト本文

サンプル リクエスト

remove quantity フィールドを使用すると、呼び出し元は消費アイテムの残数から削除する数量を指定できます。Transaction ID フィールドは、同じ使用が二重にカウントされるリスクを抑えつつ、消費コンテンツ操作を再試行する手段を呼び出し元に提供します。

応答本文

POST に対する応答は、認証を通過し適切な承認コンテキストが割り当てられている場合、POST リクエストでサービスに渡されたのと同じ transactionId、消費アイテムの URL、およびアイテムの新しい数量値を含む受信確認となります。

サンプル応答

関連項目

親
/users/me/consumables/
詳細情報
EDS 共通ヘッダー EDS パラメーター EDS クエリ絞り込み条件 Marketplace URI 追加リファレンス
Last modified on October 19, 2026