Inventory Scenarios

This document describes Marketplace Inventory APIs. The Inventory service is a publicly-available service that at a high level answers the question: What does a user own or currently have access to?

Core Service Scenarios

1. A game or publisher wants to enumerate inventory for a single user.
2. A game or publisher wants to view details about a single inventory item (for a single user).
3. A game or publisher wants to view details about a single consumable entitlement (for a single user).
4. A game or publisher wants to report the usage of a consumable inventory item.

General Guidelines

• Inventory APIs are never used to purchase any content (durable or consumable) or increase the remaining quantity of a consumable item – this must be done through Marketplace URIs.
• Inventory items are all stamped with a product ID that can be used to compare inventory between users or the catalog (Entertainment Discovery Services, or EDS). You may also need to perform a lookup in the catalog of a specific inventory item in order to get additional information about the product.
• Inventory APIs don’t provide you with historical information about an inventory item such as how it was purchased.
• Subscriptions are listed as an inventory item.
• The inventory service answers the question of what the user owns, not necessarily what the user can play or access right now, so there may be items returned that the user cannot use in some circumstances. For example, they may own some inventory restricted to a different geographic region.
• There are no concurrency checks on consumable items (two users attempting to use the same consumable).

Reference

/users/me/inventory

/inventory/consumables/{itemID}

/inventory/{itemID}