Share via

inventoryItem (JSON)

The core inventory item represents the standard item on which an entitlement can be granted.

inventoryItem

The inventoryItem object has the following specification.

Member Type Description
url string Unique identifier for this specific inventory item.
itemType string Type of the item. Current values are
  • Unknown
  • Game
  • Movie
  • TVShow
  • MusicVideo
  • GameTrial
  • ViralVideo
  • TVEpisode
  • TVSeason
  • TVSeries
  • VideoPreview
  • Poster
  • Podcast
  • Image
  • BoxArt
  • ArtistPicture
  • GameContent
  • GameDemo
  • Theme
  • XboxOriginalGame
  • GamerTile
  • ArcadeGame
  • GameConsumable
  • Album
  • AlbumDisc
  • AlbumArt
  • GameVideo
  • BackgroundArt
  • TVTrailer
  • GameTrailer
  • VideoShort
  • Bundle
  • XnaCommunityGame
  • Promotional
  • MovieTrailer
  • SlideshowPreviewImage
  • ServerBackedGames
  • Marketplace
  • AvatarItem
  • LiveApp
  • WebGame
  • MobileGame
  • MobilePdlc
  • MobileConsumable
  • App
  • MetroGame
  • MetroGameContent
  • MetroGameConsumable
  • GameLayer
  • GameActivity
  • GameV2
  • SubscriptionV2
  • Subscription

    Note: Games are designated by GameV2, consumables are GameConsumable, and durable DLC is GameContent.
containers string This is the set of "containers" that contain this item. A user's inventory can be queried for items that belong to a specific container. These containers are determined when the item is added to the inventory by purchase.
obtained DateTime Date and time the item was added to the user's inventory.
startDate DateTime Date and time the item became or will become available for use.
endDate DateTime Date and time the item became or will become unusable.
state string The state of the item. Allowed values are Enabled, Suspended, Expired, Canceled, Renewed.
trial Boolean value Required. True if this entitlement is a trial; otherwise, false. If you buy the trial version of an entitlement and then buy the full version, you will receive both.
trialTimeRemaining TimeSpan Nullable. How much time is remaining on the trial, in minutes.
consumable array If the items is consumable, this contains an inline representation of the unique identifier (link) for the consumable inventory item, as well as its current quantity.

Sample JSON syntax

inventoryItem {
  "url": string,
  "itemType": "Music" | "Video" | "Game" | "AvatarItem" | "Subscription" | "DLC" | "Consumable" | ...,
  "obtained": DateTime,
  "beginDate": DateTime,
  "endDate": DateTime,
  "state": "Unavailable" | "Available" | "Suspended" | "Expired",
  "trial": true,
  "trialTimeRemaining":"23:12:14",
  ("consumable": {"url": string, "quantity": int})
}

Consumable inventory item

The consumable entity presents the minimal set of properties for a consumable item.

Member Type Description
url string Unique identifier for the specific consumable inventory item.
quantity 32-bit signed integer The current quantity of this inventory item. 
consumableInventoryItem {
  "url": string,
  "quantity": int
}

See also

Parent

JavaScript Object Notation (JSON) Object Reference

Reference

/users/me/inventory

/inventory/consumables/{itemID}

/inventory/{itemID}

  • Last updated on