La API de Offer Status te permite verificar si tus títulos están activos en la tienda de Prime Video y, de no ser así, el motivo. Centraliza los datos de tu catálogo en tus propios sistemas en lugar de consultar manualmente Slate o la tienda, brindándote visibilidad en tiempo real en todas tus líneas de negocio y territorios.
¿Por qué usar la API de Offer Status?
- Operaciones centralizadas: extrae los datos del catálogo directamente a tus propios sistemas junto con tus otros canales de distribución; no hace falta que inicies sesión en Slate para cada verificación de estado
- Resolución de problemas más rápida: detecta problemas de disponibilidad de inmediato y comprende qué está impidiendo que tus títulos se publiquen, lo que reduce el tiempo de resolución hasta en 3 días
- Gestión proactiva del catálogo: monitorea todo tu catálogo de forma programática en todos los territorios y tipos de oferta, lo que te permite escalar las operaciones a medida que tu negocio crece
- Verificación de lanzamiento en tiempo real: conoce al instante cuándo tu contenido se lanza con éxito sin realizar verificaciones manuales en la tienda ni esperar actualizaciones de estado
Esquemas de solicitud y respuesta
Esta sección proporciona las especificaciones técnicas para que los desarrolladores integren la API de Offer Status en sus sistemas. Usa esta referencia para comprender el formato de la solicitud, la estructura de la respuesta y los tipos de datos que devuelve la API.
Formato de la solicitud
La API de Offer Status usa una estructura de recuperación simple mediante solicitudes GET, donde todos los parámetros de consulta se pasan por la URL; no necesitas un cuerpo de solicitud. Esto facilita la integración en tus sistemas y las pruebas con clientes HTTP estándar o herramientas de línea de comandos. Simplemente construye la URL con tu identificador de título y los filtros opcionales, luego envía una solicitud GET para obtener el estado actual de tus ofertas:
https://partnerapi.primevideo.com/v1/avails/{liscensor}/status/{ALID}?marketplace={Amazon Marketplace}&territory={territory}
Parámetros
Esta tabla define los parámetros que puedes usar para consultar información sobre el estado de la oferta.
Parámetro |
Tipo |
Es obligatorio |
Descripción |
licensor |
String |
Sí |
El identificador de tu organización proporcionado por Prime Video durante el proceso de incorporación. |
ALID |
String |
Sí |
Identificador de título (ALID o SKU) que coincida con tu contribución. |
marketplace |
String |
No |
El Marketplace de Amazon al que enviaste el título. El valor predeterminado es GLOBAL y no es necesario proporcionarlo. |
territory |
String |
No |
Código de territorio de dos letras (p. ej., US, GB, AU) del que quieras consultar el estado de la oferta. El valor predeterminado son todos los territorios y no es necesario proporcionarlo. Si no lo proporcionas, se devolverán todos los estados de las ofertas |
Ejemplos de solicitudes
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: Cuanto más específicos sean tus parámetros de solicitud, más precisa será la respuesta. Si omites parámetros opcionales como marketplace y territory, la API devolverá información de estado para todos los alcances aplicables asociados con ese ALID.
Esquema de respuesta
El esquema de respuesta define la estructura de los datos que devuelve la API de Offer Status. Comprender estos tipos de datos te ayudará a analizar la respuesta e integrar la información de estado en tus sistemas de forma eficaz.
Respuesta de obtención de estado
La respuesta de nivel superior que contiene información sobre el estado de la oferta para el título solicitado. Cada respuesta incluye datos de estado filtrados por tus parámetros de solicitud, lo que te permite comprender el estado de disponibilidad en las diferentes líneas de negocio y territorios.
Atributo |
Tipo |
Es obligatorio |
Descripción |
OfferStatuses |
OfferStatus[] |
Sí |
Matriz (array) de objetos de estado de la oferta, uno por cada alcance (combinación de línea de negocio y territorio). |
errores |
string |
No |
Lista de errores en caso de falla |
Tipo de Offer Status: La estructura de datos principal que representa el estado de una sola oferta. Esta incluye información de estado general y datos detallados a nivel de transacción para cada ventana de disponibilidad.
Atributo |
Tipo |
Es obligatorio |
Descripción |
ALID |
String |
Sí |
Identificador de título que coincida con tu contribución de metadatos |
GroupingEntity |
string |
Condicional |
Identificador de un canal o suscripción (requerido para ofertas de SVOD). |
Licensor |
Publisher |
Sí |
Información sobre tu organización que otorga la licencia a Prime Video. |
OverallStatus |
Status |
Sí |
Estado general de todas las ventanas en el contexto o alcance de disponibilidad (avail) actual |
PlatformID |
String[] |
Sí |
Lista de Identificadores Globales de Título (GTI) de un título. |
Transaction |
Transaction[] |
Sí |
Una lista de ventanas de disponibilidad y sus estados. |
Tipo de Publisher
Identifica a tu organización como el licensor del contenido. Este valor lo proporciona Prime Video durante el proceso de incorporación.
Atributo |
Tipo |
Requerido |
Notas |
DisplayName |
String |
Sí |
Nombre descriptivo de tu organización |
OrganizationID |
String |
Sí |
El identificador de tu organización proporcionado por Prime Video durante el proceso de incorporación (debe coincidir con el valor usado en los avails). |
Tipo de Status
Proporciona la información del estado general de la oferta, incluido el rango de fechas y el código de progreso actual.
Atributo |
Tipo |
Requerido |
Notas |
Comments |
String |
No |
Notas de Amazon legibles para humanos (actualmente nulas) |
Start |
Date |
Sí |
La fecha de inicio de ventana más temprana para el contexto |
End |
Date |
Sí |
La fecha de finalización de ventana más tardía para el contexto. |
Progress Code |
ENUM |
Sí |
Código de progreso para el contexto |
_timestamp |
Date |
Sí |
Última vez que el estado cambió o se actualizó |
Tipo de Transaction
Representa una única ventana de disponibilidad con sus términos de licencia y estado asociados. Cada transacción corresponde a una combinación específica de tipo de licencia, territorio y perfil de formato.
Atributo |
Tipo |
Requerido |
Notas |
ContractID |
String |
Sí |
Contrato al que está asociado el título |
FeatureStatus |
FeatureStatus |
Sí |
Estado de la ventana |
End |
Date |
Sí |
La fecha de finalización de ventana más tardía para el contexto. |
Progress Code |
ENUM |
Sí |
Código de progreso para el contexto |
_timestamp |
Date |
Sí |
La última vez que el estado cambió o se actualizó |
FormatProfile |
FormatProfile[] |
Sí |
Calidad del vídeo ofrecido. Valores permitidos: SD, HD, UHD, MAX |
LicenseType |
Enum |
Sí |
Valores permitidos: SVOD, FVOD, EST, POEST, VOD |
Territory |
String[] |
Sí |
Territorio para la ventana |
TransactionID |
String |
No |
Próximamente: será el AvailID enviado con extractos parciales (actualmente es nulo). |
Tipo de FeatureStatus
Proporciona información detallada del estado para una ventana de disponibilidad específica, incluyendo el rango de fechas y el código de progreso.
Atributo |
Tipo |
Requerido |
Notas |
Comments |
String |
No |
Notas de Amazon legibles para humanos (actualmente nulas) |
Start |
Date |
Sí |
Fecha de inicio de la ventana |
End |
Date |
Sí |
Fecha de finalización de la ventana |
Progress Code |
ENUM |
Sí |
Código de progreso para la ventana (actualmente es nulo; utiliza OverallStatus para determinar si el contexto está activo) |
_timestamp |
Date |
Sí |
Última vez que el estado cambió o se actualizó |
Tipo de FormatProfile
Especifica el nivel de calidad de video para la disponibilidad. Se pueden incluir múltiples perfiles de formato en una sola transacción si has puesto a disposición tu contenido en múltiples niveles de calidad (por ejemplo, tanto HD como UHD).
Atributo |
Tipo |
Requerido |
Notas |
value[] |
Enum |
Sí |
Calidad del vídeo ofrecido. Valores permitidos: SD, HD, UHD, MAX |
Nota: Los esquemas anteriores representan la estructura de respuesta actual de la API. Algunos campos (como Comments, ProgressCode en FeatureStatus y TransactionID) son actualmente nulos, pero podrían completarse en futuras versiones.
Ejemplo de respuesta
Este ejemplo muestra una respuesta típica de la API para un título de SVOD con múltiples ventanas de disponibilidad en distintos territorios. La respuesta ilustra cómo se estructura la información de estado, incluyendo el estado general, los detalles de la transacción y los perfiles de formato.
Ejemplo 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"
}
]
}
]
