GET (/users/me/inventory)
Provides the set of inventory currently associated with the provided user back to the caller.
The domain for these URIs is inventory.xboxlive.com.
Remarks
No policy checks, enforcement, or filtering will occur as a part of this call. Callers have the option of passing query parameters in order to narrow the scope of the results returned.
Callers can page through results with a continuation token as provided through a previous response: /users/me/inventory?continuationToken=continuationTokenString.
The caller may make a call to the details API with a specific item URL in order to see information about a specific item.
Query string parameters
| Parameter | Type | Description |
|---|---|---|
| availability | string | The current availability of items to return. Default is "Available" which returns items for which the current date falls between the start date and the end date range. Other values include "All", which returns all items, and "Unavailable" which returns items for which the current date falls outside the start date and end date range and it therefore not currently available. |
| container | string | Optional. If you set the value to the Product ID of a game, then the results from the inventory only include items related to that game. This is especially useful when calling the inventory from your server to filter results down to a specific game's products. |
| expandSatisfyingEntitlements | string | A flag that indicates if the response includes all satisfying entitlements that the user has within the results returned. The default is "false". When this parameter is used with a value of "true", any products that are granted to the user through satisfying entitlements such as bundled items, Xbox 360 purchases migrated to Xbox One, subscription benefits, etc. are added to the results. When this value is "false" then only the parent items such as the Bundle's ProductID are returned in the results and not the individual included items. Note: Using this parameter with a value of "true" is only supported if the itemType parameter is not included in the URI, otherwise you will receive an HTTP 400 error. |
| productIds | string | A collection of ProductIds that you want to specifically retrieve from the user's inventory, separated by ','. If the user does not have a supplied ProductID in their inventory results, that item will not appear in the results from the API call. If you pass in the productID of a bundle along with the expandSatisfyingEntitlements parameter set to true, all items included in the bundle are returned in the call results (whether you specified their productIds in your query string or not). |
| state | string | The state of the items to return. The default is "all", which returns all items. Other values are "Enabled", which indicates that only itemsthat are enabled should be returned, "Suspended", which indicates that only items that are suspended should be returned, "Expired", which indicates that only items which have expired should be returned, "Cancelled", which indicates that only items that are cancelled should be returned, and "Renewed", which indicates that only items that have been renewed should be returned. |
In addition to these, the resource supports the standard paging mechanics.
Sample request
The fully-qualified domain name for this URI method is https://inventory.xboxlive.com/users/me/inventory.
Note:
Which users are considered depends on the token provided, which may include multiple users. If you want a single user's inventory, you must also provide the user hash for the specific user you want to exclusively consider.
.
Response body
If the call is successful, the service returns an array of inventory items. See inventoryItem (JSON).
Sample response
{
"pagingInfo": {
"continuationToken": string,
"totalItems": int
},
"items":
{
"url": string,
"itemType": "Music",
"titleId": string,
"containers": string,
"obtained": DateTime,
"startDate": DateTime,
"endDate": DateTime,
"state": "Enabled"
}