L’API Offer Status ti consente di verificare se i tuoi titoli sono disponibili nella vetrina Prime Video e in caso negativo, il perché. Centralizza i dati del tuo catalogo nei tuoi sistemi invece di controllare manualmente Slate o la vetrina, offrendoti visibilità in tempo reale su tutte le tue linee di business e territori.
Perché utilizzare l’API Offer Status?
- Operazioni centralizzate: estrai i dati del catalogo direttamente nei tuoi sistemi insieme agli altri canali di distribuzione, senza bisogno di accedere a Slate per ogni controllo dello stato
- Risoluzione più rapida dei problemi: rileva immediatamente i problemi di disponibilità e scopri cosa impedisce la pubblicazione dei tuoi titoli, riducendo i tempi di risoluzione fino a 3 giorni
- Gestione proattiva del catalogo: monitora l’intero catalogo in modo programmatico su tutti i territori e i tipi di offerta, consentendoti di scalare le operazioni man mano che la tua azienda cresce
- Verifica del lancio in tempo reale: scopri immediatamente quando i tuoi contenuti vengono lanciati con successo senza controlli manuali sulla vetrina o attese di aggiornamenti di stato
Request Format
L’API Offer Status utilizza una semplice struttura di recupero tramite GET in cui tutti i parametri della query vengono passati attraverso l’URL: non è richiesto alcun corpo della richiesta. Ciò semplifica l’integrazione nei sistemi e il test utilizzando client HTTP standard o strumenti da riga di comando. Basta creare l’URL con l’identificatore del titolo e i filtri opzionali, quindi inviare una richiesta GET per recuperare lo stato attuale delle tue offerte:
https://partnerapi.primevideo.com/v1/avails/{liscensor}/status/{ALID}?marketplace={Amazon Marketplace}&territory={territory}
Parametri
Questa tabella definisce i parametri che è possibile utilizzare per interrogare le informazioni sullo stato dell’offerta.
Parametro |
Tipo |
È obbligatorio |
Descrizione |
licensor |
Stringa |
Sì |
L’identificativo della tua organizzazione fornito da Prime Video durante l’onboarding |
ALID |
Stringa |
Sì |
Identificatore del titolo (ALID o SKU) corrispondente al tuo contributo |
marketplace |
Stringa |
No |
L’Amazon Marketplace a cui è stato inviato il titolo. Il valore predefinito è GLOBAL e non deve essere fornito. |
territory |
Stringa |
No |
Codice territoriale di due lettere (ad es. US, GB, AU) di cui desideri verificare lo stato dell’offerta. Questa impostazione è predefinita per tutti i territori e non deve essere fornita. Tutti gli stati dell’offerta verranno restituiti se non vengono forniti |
Richieste di esempio
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
Nota: Più specifici sono i parametri della tua richiesta, più mirata sarà la tua risposta. Se ometti parametri opzionali come marketplace e territorio, l’API restituirà informazioni sullo stato per tutti gli ambiti applicabili associati a quell’ALID.
Schema di risposta
Lo schema di risposta definisce la struttura dei dati restituiti dall’API Offer Status. La comprensione di questi tipi di dati ti aiuterà ad analizzare la risposta e a integrare efficacemente le informazioni sullo stato nei tuoi sistemi.
Ottieni risposta sullo stato
La risposta di primo livello contenente le informazioni sullo stato dell’offerta per il titolo richiesto. Ogni risposta include dati sullo stato filtrati in base ai parametri della richiesta, che consentono di comprendere lo stato di disponibilità in diverse linee di business e territori.
Attributo |
Tipo |
È obbligatorio |
Descrizione |
OfferStatuses |
OfferStatus[] |
Sì |
Serie di oggetti sullo stato dell’offerta, uno per ambito (combinazione linea di business/territorio) |
errors |
string |
No |
Elenco degli errori in caso di insuccesso |
Tipo di stato dell’offerta. La struttura dei dati di base che rappresenta lo stato di una singola offerta. Ciò include informazioni generali sullo stato e dati dettagliati a livello di transazione per ogni finestra di disponibilità.
Attributo |
Tipo |
È obbligatorio |
Descrizione |
ALID |
Stringa |
Sì |
Identificatore del titolo corrispondente al tuo contributo ai metadati |
GroupingEntity |
string |
Condizionale |
Identificatore per un canale o un abbonamento (richiesto per le offerte SVOD) |
Licensor |
Publisher |
Sì |
Informazioni sulla tua organizzazione che concede la licenza a Prime Video |
OverallStatus |
Status |
Sì |
Stato generale per tutte le finestre nel contesto/ambito di disponibilità corrente |
PlatformID |
String[] |
Sì |
Elenco dei Global Title Identifier (GTI) per un titolo |
Transaction |
Transaction[] |
Sì |
Un elenco delle finestre di disponibilità e dei relativi stati |
Tipo di Publisher
Identifica la tua organizzazione come licenziante dei contenuti. Questo valore viene fornito da Prime Video durante l’onboarding.
Attributo |
Tipo |
Obbligatorio |
Note |
DisplayName |
Stringa |
Sì |
Nome descrittivo della tua organizzazione |
OrganizationID |
Stringa |
Sì |
L’identificativo della tua organizzazione fornito da Prime Video durante l’onboarding (deve corrispondere al valore utilizzato in avails) |
Tipo di stato
Fornisce le informazioni generali sullo stato dell’offerta, incluso l’intervallo di date e il codice di avanzamento corrente.
Attributo |
Tipo |
Obbligatorio |
Note |
Commenti |
Stringa |
No |
Note leggibili da Amazon (attualmente nullo) |
Inizio |
Data |
Sì |
Data di inizio della prima finestra per il contesto |
Fine |
Data |
Sì |
Data di fine della finestra più recente per il contesto. |
Codice di avanzamento |
ENUM |
Sì |
Codice di avanzamento per il contesto |
_timestamp |
Data |
Sì |
L’ultima volta che lo stato è cambiato o è stato aggiornato |
Tipo di transazione
Rappresenta una singola finestra di disponibilità con i termini e lo stato di licenza associati. Ogni transazione corrisponde a una specifica combinazione di tipo di licenza, territorio e profilo di formato.
Attributo |
Tipo |
Obbligatorio |
Note |
ContractID |
Stringa |
Sì |
Contratto a cui è associato il titolo |
FeatureStatus |
FeatureStatus |
Sì |
Stato della finestra |
Fine |
Data |
Sì |
Data di fine della finestra più recente per il contesto |
Codice di avanzamento |
ENUM |
Sì |
Codice di avanzamento per il contesto |
_timestamp |
Data |
Sì |
L’ultima volta che lo stato è cambiato o è stato aggiornato |
FormatProfile |
FormatProfile[] |
Sì |
Qualità del video disponibile. Valori consentiti: SD, HD, UHD, MAX |
LicenseType |
Enum |
Sì |
Valori consentiti: SVOD, FVOD, EST, POEST, VOD |
Territorio |
String[] |
Sì |
Territorio per la finestra |
TransactionID |
Stringa |
No |
Prossimamente: verrà l’AvailID passato con estrazioni parziali (attualmente nullo). |
FeatureStatus type
Fornisce informazioni dettagliate sullo stato per una finestra di disponibilità specifica, tra cui l’intervallo di date e il codice di avanzamento.
Attributo |
Tipo |
Obbligatorio |
Note |
Commenti |
Stringa |
No |
Note leggibili da Amazon (attualmente nullo) |
Inizio |
Data |
Sì |
Data di inizio della finestra |
Fine |
Data |
Sì |
Data di fine della finestra |
Codice di avanzamento |
ENUM |
Sì |
Codice di avanzamento per la finestra (attualmente nullo: usa OverallStatus per determinare se il contesto è attivo) |
_timestamp |
Data |
Sì |
L’ultima volta che lo stato è cambiato o è stato aggiornato |
Tipo FormatProfile
Specifica il livello di qualità video per la disponibilità. È possibile includere più profili di formato in un’unica transazione se hai utilizzato i tuoi contenuti in più livelli di qualità (ad esempio, sia HD che UHD).
Attributo |
Tipo |
Obbligatorio |
Note |
value[] |
Enum |
Sì |
Qualità del video disponibile. Valori consentiti: SD, HD, UHD, MAX |
Nota: Gli schemi sopra riportati rappresentano l’attuale struttura di risposta dell’API. Alcuni campi (come Comments, ProgressCode in FeatureStatus e TransactionID) sono attualmente nulli ma potrebbero essere compilati nelle versioni future.
Esempio di risposta
Questo esempio dimostra una tipica risposta API per un titolo SVOD con più finestre di disponibilità in diversi territori. La risposta mostra come sono strutturate le informazioni sullo stato, inclusi lo stato generale, i dettagli delle transazioni e i profili di formato.
Esempio 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"
}
]
}
]