L’API Offer Status vous permet de vérifier si vos titres sont en ligne sur la boutique Prime Video, et si ce n’est pas le cas, pourquoi. Centralisez les données de votre catalogue dans vos propres systèmes au lieu de vérifier manuellement Slate ou le site Prime Video, ce qui vous donne une visibilité en temps réel sur tous vos secteurs d’activité et territoires.
Pourquoi utiliser l’API Offer Status ?
- Opérations centralisées : importez les données du catalogue directement dans vos propres systèmes, ainsi que dans vos autres canaux de distribution, sans avoir à vous connecter à Slate pour chaque vérification de statut
- Résolution plus rapide des problèmes : détectez immédiatement les problèmes de disponibilité et comprenez ce qui empêche la mise en ligne de vos titres, réduisant ainsi le délai de résolution de 3 jours
- Gestion proactive du catalogue : surveillez l’intégralité de votre catalogue par programmation sur tous les territoires et types d’offres, vous permettant de faire évoluer vos opérations au fur et à mesure de la croissance de votre activité
- Vérification du lancement en temps réel : sachez instantanément au courant du lancement de votre contenu, sans avoir besoin de vérifier manuellement la page d’accueil ni d’attendre des mises à jour de statut
Format de requête
L’API Offer Status utilise une simple structure de récupération via requête GET où tous les paramètres de requête sont transmis via l’URL. Aucun corps de requête n’est requis. Cela facilite l’intégration dans vos systèmes ainsi que les tests à l’aide de clients HTTP ou d’outils de ligne de commande standards. Créez simplement l’URL avec votre identifiant de titre et les filtres optionnels, puis envoyez une requête GET pour récupérer le statut actuel de vos offres :
https://partnerapi.primevideo.com/v1/avails/{liscensor}/status/{ALID}?marketplace={Amazon Marketplace}&territory={territory}
Paramètres
Ce tableau définit les paramètres que vous pouvez utiliser pour demander des informations sur l’état de vos offres.
Paramètre |
Type |
Est obligatoire |
Description |
Concédant |
Chaîne de caractères |
Oui |
L’identifiant de votre organisation fourni par Prime Video lors de l’intégration |
ALID |
Chaîne de caractères |
Oui |
Identifiant du titre (ALID ou SKU) correspondant à votre contribution |
région du site |
Chaîne de caractères |
Non |
La région du site Amazon sur lequel le titre a été soumis. La valeur par défaut est GLOBAL et il n’est pas obligatoire de la fournir. |
territoire |
Chaîne de caractères |
Non |
Code de territoire à deux lettres (par exemple, US, GB, AU) pour lequel vous souhaitez vérifier le statut de l’offre. Ce paramètre est réglé par défaut à tous les territoires et il n’est pas obligatoire de le préciser. Tous les statuts d’offres seront renvoyés si cela n’est pas précisé |
Exemples de requêtes
https://partnerapi.primevideo.com/v1/avails/mgm/status/skuabc123?marketplace=global&territory=US
https://partnerapi.primevideo.com/v1/avails/mgm/status/skuabc123?marketplace=global
https://partnerapi.primevideo.com/v1/avails/mgm/status/skuabc123
Remarque : Plus les paramètres de votre demande sont spécifiques, plus votre réponse sera ciblée. Si vous omettez des paramètres facultatifs tels que la région du site et le territoire, l’API renverra des informations de statut pour tous les périmètres applicables associés à cet ALID.
Schéma de réponse
Le schéma de réponse définit la structure des données renvoyées par l’API Offer Status. La compréhension de ces types de données vous aidera à analyser la réponse et à intégrer efficacement les informations de statut dans vos systèmes.
Obtenir une réponse de statut
La réponse de premier niveau contenant des informations sur le statut de l’offre pour le titre demandé. Chaque réponse inclut des données de statut filtrées en fonction des paramètres de votre requête, ce qui vous permet de comprendre l’état de disponibilité dans les différents secteurs d’activité et territoires.
Attribut |
Type |
Est obligatoire |
Description |
OfferStatuses |
OfferStatus[] |
Oui |
Tableau d’objets de statut de l’offre, un par périmètre (combinaison secteur d’activité/territoire) |
erreurs |
chaîne de caractères |
Non |
Liste des erreurs en cas d’échec |
Type de statut de l’offre - Structure de données de base représentant le statut d’une offre unique. Cela inclut des informations de statut générales et des données détaillées au niveau des transactions pour chaque fenêtre de disponibilité.
Attribut |
Type |
Est obligatoire |
Description |
ALID |
Chaîne de caractères |
Oui |
Identifiant de titre correspondant à votre contribution de métadonnées |
GroupingEntity |
chaîne de caractères |
Conditionnel |
Identifiant d’une chaîne ou d’un abonnement (obligatoire pour les offres SVOD) |
Concédant |
Éditeur |
Oui |
Informations sur votre organisation qui accorde une licence à Prime Video |
OverallStatus |
Statut |
Oui |
Statut général pour toutes les fenêtres dans le contexte/périmètre de la disponibilité actuelle |
PlatformID |
Chaîne de caractères[] |
Oui |
Liste des identifiants de titre globaux (GTI) pour un titre |
Transaction |
Transaction[] |
Oui |
Liste des fenêtres de disponibilité et de leurs statuts |
Type d’éditeur
Identifie votre organisation en tant que concédant de licence de contenu. Cette valeur est fournie par Prime Video lors de l’intégration.
Attribut |
Type |
Obligatoire |
Remarques |
DisplayName |
Chaîne de caractères |
Oui |
Nom de votre organisation |
OrganizationID |
Chaîne de caractères |
Oui |
L’identifiant de votre organisation fourni par Prime Video lors de l’intégration (doit correspondre à la valeur utilisée dans les renseignements utiles) |
Type de statut
Fournit les informations générales sur le statut de l’offre, y compris la plage de dates et le code de progression actuel.
Attribut |
Type |
Obligatoire |
Remarques |
Commentaires |
Chaîne de caractères |
Non |
Notes lisibles par les humains, provenant d’Amazon (actuellement nulles) |
Début |
Date |
Oui |
Première date de début de fenêtre pour le contexte |
Fin |
Date |
Oui |
Dernière date de fin de fenêtre pour le contexte. |
Code de progression |
ENUM |
Oui |
Code de progression pour le contexte |
_horodatage |
Date |
Oui |
Dernière fois que le statut a changé ou a été mis à jour |
Type de transaction
Représente une fenêtre de disponibilité unique avec ses conditions de licence et son statut associés. Chaque transaction correspond à une combinaison spécifique de type de licence, de territoire et de profil de format.
Attribut |
Type |
Obligatoire |
Remarques |
ContractID |
Chaîne de caractères |
Oui |
Contrat auquel le titre est associé |
FeatureStatus |
FeatureStatus |
Oui |
Statut pour la fenêtre |
Fin |
Date |
Oui |
Dernière date de fin de fenêtre pour le contexte |
Code de progression |
ENUM |
Oui |
Code de progression pour le contexte |
_horodatage |
Date |
Oui |
La dernière fois que le statut a changé ou a été mis à jour |
FormatProfile |
FormatProfile[] |
Oui |
Qualité de la vidéo disponible. Valeurs autorisées : SD, HD, UHD, MAX |
LicenseType |
Enum |
Oui |
Valeurs autorisées : SVOD, FVOD, EST, POEST, VOD |
Territoire |
Chaîne de caractères[] |
Oui |
Territoire pour la fenêtre |
TransactionID |
Chaîne de caractères |
Non |
Disponible prochainement - cela consistera en un AvailID, transmis avec des extraits partiels (valeur actuellement nulle). |
FeatureStatus type
Fournit des informations de statut détaillées pour une fenêtre de disponibilité spécifique, notamment la plage de dates et le code de progression.
Attribut |
Type |
Obligatoire |
Remarques |
Commentaires |
Chaîne de caractères |
Non |
Notes lisibles par les humains, provenant d’Amazon (actuellement nulles) |
Début |
Date |
Oui |
Date de début de la fenêtre |
Fin |
Date |
Oui |
Date de fin de la fenêtre |
Code de progression |
ENUM |
Oui |
Code de progression pour la fenêtre (actuellement nul ; utilisez OverallStatus pour déterminer si le contexte est actif) |
_horodatage |
Date |
Oui |
Dernière fois que le statut a changé ou a été mis à jour |
FormatProfile type
Spécifie le niveau de qualité vidéo pour la disponibilité. Plusieurs profils de format peuvent être inclus dans une seule transaction si vous avez rendu votre contenu disponible dans plusieurs niveaux de qualité (par exemple, à la fois en HD et en UHD).
Attribut |
Type |
Obligatoire |
Remarques |
value[] |
Enum |
Oui |
Qualité de la vidéo disponible. Valeurs autorisées : SD, HD, UHD, MAX |
Remarque : Les schémas ci-dessus représentent la structure de réponse actuelle de l’API. Certains champs (tels que Comments, ProgressCode dans FeatureStatus et TransactionID) sont actuellement nuls mais il se peut qu’ils soient renseignés dans de prochaines versions.
Exemple de réponse
Cet exemple illustre une réponse d’API typique pour un titre SVOD avec plusieurs fenêtres de disponibilité sur différents territoires. La réponse montre comment les informations de statut sont structurées, y compris le statut général, les détails des transactions et les profils de format.
Exemple de SVOD :
[
{
"__type": "OfferStatus:http://internal.amazon.com/coral/com.amazon.pvpartnerapiofferstatusresourceserver/",
"ALID": "1ceMergeSeries5",
"GroupingEntity": null,
"Licensor": {
"DisplayName": "prodtest",
"OrganizationID": "prodtest"
},
"OverallStatus": {
"Comments": null,
"End": "2026-12-16T14:20:45Z",
"ProgressCode": "Live",
"Start": "2024-07-26T14:20:45Z",
"_timestamp": "2025-12-19T01:41:06.042Z"
},
"PlatformID": [
"amzn1.dv.gti.0d78e450-d295-4d6e-bf6e-b47af334bad0"
],
"Transaction": [
{
"ContractID": "PTG07",
"FeatureStatus": {
"Comments": null,
"End": "2026-12-16T14:20:45Z",
"ProgressCode": null,
"Start": "2024-07-26T14:20:45Z",
"_timestamp": "2025-12-19T01:41:06.042Z"
},
"FormatProfile": [
"MAX"
],
"LicenseType": "EST",
"PlatformLRD": null,
"Territory": [
"AU"
],
"TransactionID": [],
"_timestamp": "2025-12-19T01:41:06.042Z"
}
]
},
{
"__type": "OfferStatus:http://internal.amazon.com/coral/com.amazon.pvpartnerapiofferstatusresourceserver/",
"ALID": "1ceMergeSeries5",
"GroupingEntity": null,
"Licensor": {
"DisplayName": "prodtest",
"OrganizationID": "prodtest"
},
"OverallStatus": {
"Comments": null,
"End": "2026-12-16T14:20:45Z",
"ProgressCode": "Ready",
"Start": "2024-07-26T14:20:45Z",
"_timestamp": "2025-12-19T12:57:50.949Z"
},
"PlatformID": [
"amzn1.dv.gti.0d78e450-d295-4d6e-bf6e-b47af334bad0"
],
"Transaction": [
{
"ContractID": "PDTST",
"FeatureStatus": {
"Comments": null,
"End": "2026-12-16T14:20:45Z",
"ProgressCode": null,
"Start": "2024-07-26T14:20:45Z",
"_timestamp": "2025-12-19T12:57:50.949Z"
},
"FormatProfile": [
"MAX"
],
"LicenseType": "EST",
"PlatformLRD": null,
"Territory": [
"US"
],
"TransactionID": [],
"_timestamp": "2025-12-19T12:57:50.949Z"
}
]
}
]