> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# GET (/users/me/inventory)

> GET (/users/me/inventory)

# GET (/users/me/inventory)

將目前與所提供使用者相關聯的庫存集合傳回給呼叫者。
這些 URI 的網域是 `inventory.xboxlive.com`。

* [備註](#ID4EV)
* [查詢字串參數](#ID4EHB)
* [範例要求](#ID4EDE)
* [回應本文](#ID4ERE)

## 備註

此呼叫不會進行任何原則檢查、強制執行或篩選。呼叫者可以選擇傳遞查詢參數，以縮小傳回結果的範圍。

呼叫者可以使用先前回應所提供的接續權杖來分頁瀏覽結果：**/users/me/inventory?continuationToken=continuationTokenString**。

呼叫者可以使用特定項目 URL 呼叫詳細資料 API，以查看特定項目的資訊。

## 查詢字串參數

| 參數 | 類型 | 描述 |
| - | - | - |
| availability | 字串 | 要傳回之項目的目前可用性。預設值為 "Available"，會傳回目前日期介於開始日期與結束日期範圍內的項目。其他值包括 "All"，會傳回所有項目；以及 "Unavailable"，會傳回目前日期落在開始日期與結束日期範圍之外、因此目前無法使用的項目。 |
| container | 字串 | 選用。如果您將值設定為遊戲的產品識別碼，庫存結果只會包含與該遊戲相關的項目。從您的伺服器呼叫庫存，以將結果篩選為特定遊戲的產品時，這特別有用。 |
| expandSatisfyingEntitlements | 字串 | 旗標，表示回應是否在傳回的結果中包含使用者擁有的所有滿足權利。預設值為 "false"。當此參數的值為 "true" 時，透過滿足權利授與使用者的任何產品 (例如搭售項目、移轉至 XBOX One 的 XBOX 360 購買項目、訂閱權益等) 都會新增至結果。當此值為 "false" 時，結果只會傳回上層項目 (例如搭售方案的 ProductID)，而不會傳回個別包含的項目。**注意：** 只有在 URI 中未包含 itemType 參數時，才支援以 "true" 值使用此參數，否則您將會收到 HTTP 400 錯誤。 |
| productIds | 字串 | 您要從使用者庫存中特別擷取的 ProductId 集合，以 ',' 分隔。如果使用者的庫存結果中沒有所提供的 ProductID，該項目將不會出現在 API 呼叫的結果中。如果您傳入搭售方案的 productID，並將 expandSatisfyingEntitlements 參數設定為 true，則搭售方案中包含的所有項目都會在呼叫結果中傳回 (無論您是否在查詢字串中指定其 productId)。 |
| state | 字串 | 要傳回之項目的狀態。預設值為 "all"，會傳回所有項目。其他值為 "Enabled"，表示只應傳回已啟用的項目；"Suspended"，表示只應傳回已暫停的項目；"Expired"，表示只應傳回已過期的項目；"Cancelled"，表示只應傳回已取消的項目；以及 "Renewed"，表示只應傳回已續約的項目。 |

除此之外，此資源也支援標準的分頁機制。

## 範例要求

此 URI 方法的完整網域名稱為 `https://inventory.xboxlive.com/users/me/inventory.
		 `

> **注意：**\
> 會納入考量的使用者取決於所提供的權杖，其中可能包含多位使用者。如果您想要單一使用者的庫存，也必須提供您要專門考量之特定使用者的使用者雜湊。

.

## 回應本文

如果呼叫成功，服務會傳回庫存項目的陣列。請參閱 [inventoryItem (JSON)](https://docs.xbox.com/zh-TW/reference/live/rest/json/json-inventoryitem.md)。

### 範例回應

```cpp theme={null}
{
  "pagingInfo": {
    "continuationToken": string,
    "totalItems": int
  },
  "items":
  {
    "url": string,
    "itemType": "Music",
    "titleId": string,
    "containers": string,
    "obtained": DateTime,
    "startDate": DateTime,
    "endDate": DateTime,
    "state": "Enabled"  
}

```

## 另請參閱

##### 上層

[/users/me/inventory](https://docs.xbox.com/zh-TW/reference/live/rest/uri/marketplace/uri-inventory.md)

##### 進一步資訊

[EDS 通用標頭](https://docs.xbox.com/zh-TW/reference/live/rest/additional/edscommonheaders.md)

[EDS 參數](https://docs.xbox.com/zh-TW/reference/live/rest/additional/edsparameters.md)

[EDS 查詢精簡器](https://docs.xbox.com/zh-TW/reference/live/rest/additional/edsqueryrefiners.md)

[Marketplace URI](https://docs.xbox.com/zh-TW/reference/live/rest/uri/marketplace/atoc-reference-marketplace.md)

[其他參考](https://docs.xbox.com/zh-TW/reference/live/rest/additional/atoc-xboxlivews-reference-additional.md)


## Related topics

- [/users/me/inventory](https://docs.xbox.com/zh-TW/reference/live/rest/uri/marketplace/uri-inventory.md)
- [GET (/users/me)](https://docs.xbox.com/zh-TW/reference/live/rest/uri/presence/uri-usersmeget.md)
- [GET (/users/me/groups/{moniker} )](https://docs.xbox.com/zh-TW/reference/live/rest/uri/presence/uri-usersmegroupsmonikerget.md)
- [Get User Inventory](https://docs.xbox.com/api-reference/player-item-management/get-user-inventory.md)
- [/users/me](https://docs.xbox.com/zh-TW/reference/live/rest/uri/presence/uri-usersme.md)