GET (/users/me/inventory)

Renvoie à l’appelant l’ensemble de l’inventaire actuellement associé à l’utilisateur fourni. Le domaine de ces URI est inventory.xboxlive.com.

Remarques
Paramètres de chaîne de requête
Exemple de requête
Corps de la réponse

Remarques

Aucune vérification, application ou filtrage de stratégie n’a lieu dans le cadre de cet appel. Les appelants ont la possibilité de transmettre des paramètres de requête afin de restreindre la portée des résultats renvoyés. Les appelants peuvent parcourir les résultats page par page à l’aide d’un jeton de continuation fourni dans une réponse précédente : /users/me/inventory?continuationToken=continuationTokenString. L’appelant peut appeler l’API de détails avec l’URL d’un élément spécifique afin d’afficher des informations sur cet élément.

Paramètres de chaîne de requête

Paramètre	Type	Description
availability	string	Disponibilité actuelle des éléments à renvoyer. La valeur par défaut est « Available », qui renvoie les éléments pour lesquels la date actuelle est comprise entre la date de début et la date de fin. Les autres valeurs sont « All », qui renvoie tous les éléments, et « Unavailable », qui renvoie les éléments pour lesquels la date actuelle se situe en dehors de la plage comprise entre la date de début et la date de fin et qui ne sont donc pas disponibles actuellement.
container	string	Facultatif. Si vous définissez la valeur sur l’ID de produit d’un jeu, les résultats de l’inventaire n’incluent que les éléments liés à ce jeu. Ceci est particulièrement utile lorsque vous appelez l’inventaire depuis votre serveur pour filtrer les résultats sur les produits d’un jeu spécifique.
expandSatisfyingEntitlements	string	Indicateur qui précise si la réponse inclut tous les droits satisfaisants dont dispose l’utilisateur parmi les résultats renvoyés. La valeur par défaut est « false ». Lorsque ce paramètre est utilisé avec la valeur « true », tous les produits accordés à l’utilisateur par le biais de droits satisfaisants, tels que les éléments groupés, les achats XBOX 360 migrés vers XBOX One, les avantages d’abonnement, etc., sont ajoutés aux résultats. Lorsque cette valeur est « false », seuls les éléments parents, tels que le ProductID du pack, sont renvoyés dans les résultats, et non les éléments individuels inclus. Remarque : L’utilisation de ce paramètre avec la valeur « true » n’est prise en charge que si le paramètre itemType n’est pas inclus dans l’URI ; sinon, vous recevrez une erreur HTTP 400.
productIds	string	Collection de ProductIds que vous souhaitez récupérer spécifiquement dans l’inventaire de l’utilisateur, séparés par des virgules (’,’). Si l’utilisateur ne possède pas un ProductID fourni dans ses résultats d’inventaire, cet élément n’apparaîtra pas dans les résultats de l’appel d’API. Si vous transmettez le productID d’un pack avec le paramètre expandSatisfyingEntitlements défini sur true, tous les éléments inclus dans le pack sont renvoyés dans les résultats de l’appel (que vous ayez spécifié ou non leurs productIds dans votre chaîne de requête).
state	string	État des éléments à renvoyer. La valeur par défaut est « all », qui renvoie tous les éléments. Les autres valeurs sont « Enabled », qui indique que seuls les éléments activés doivent être renvoyés, « Suspended », qui indique que seuls les éléments suspendus doivent être renvoyés, « Expired », qui indique que seuls les éléments expirés doivent être renvoyés, « Cancelled », qui indique que seuls les éléments annulés doivent être renvoyés, et « Renewed », qui indique que seuls les éléments renouvelés doivent être renvoyés.

En plus de ceux-ci, la ressource prend en charge les mécanismes de pagination standard.

Exemple de requête

Le nom de domaine complet de cette méthode d’URI est https://inventory.xboxlive.com/users/me/inventory.

Remarque :
Les utilisateurs pris en compte dépendent du jeton fourni, qui peut inclure plusieurs utilisateurs. Si vous souhaitez obtenir l’inventaire d’un seul utilisateur, vous devez également fournir le hachage de l’utilisateur spécifique que vous souhaitez prendre en compte exclusivement.

Corps de la réponse

Si l’appel réussit, le service renvoie un tableau d’éléments d’inventaire. Consultez inventoryItem (JSON).

Exemple de réponse

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

Voir aussi

Parent

/users/me/inventory

Informations supplémentaires

En-têtes courants EDS Paramètres EDS Affineurs de requête EDS URI de la Marketplace Référence supplémentaire

Introduction

Onboarding & Access

Setup & Install

Build Your First Title

GET (/users/me/inventory)

GET (/users/me/inventory)

Remarques

Paramètres de chaîne de requête

Exemple de requête

Corps de la réponse

Exemple de réponse

Voir aussi

Parent

Informations supplémentaires

​GET (/users/me/inventory)

​Remarques

​Paramètres de chaîne de requête

​Exemple de requête

​Corps de la réponse

​Exemple de réponse

​Voir aussi

Parent

Informations supplémentaires

GET (/users/me/inventory)

Remarques

Paramètres de chaîne de requête

Exemple de requête

Corps de la réponse

Exemple de réponse

Voir aussi