The Offer Status API lets you check if your titles are live on the Prime Video storefront—and if not, why. Centralize your catalog data in your own systems instead of manually checking Slate or the storefront, giving you real-time visibility across all your business lines and territories.
Why Use the Offer Status API?
- Centralized Operations – Pull catalog data directly into your own systems alongside your other distribution channels—no need to log into Slate for every status check
- Faster Issue Resolution – Detect availability issues immediately and understand what’s blocking your titles from going live, reducing resolution time by up to 3 days
- Proactive Catalog Management – Monitor your entire catalog programmatically across all territories and offer types, enabling you to scale operations as your business grows
- Real-Time Launch Verification – Know instantly when your content launches successfully without manual storefront checks or waiting for status updates
Request Format
The Offer Status API uses a simple retrieve via GET request structure where all query parameters are passed through the URL—no request body is required. This makes it easy to integrate into your systems and test using standard HTTP clients or command-line tools. Simply construct the URL with your title identifier and optional filters, then send a GET request to retrieve the current status of your offers:
https://partnerapi.primevideo.com/v1/avails/{liscensor}/status/{ALID}?marketplace={Amazon Marketplace}&territory={territory}
Parameters
This table defines the parameters you can use to query offer status information.
Parameter |
Type |
Is mandatory |
Description |
licensor |
String |
Yes |
Your organization identifier provided by Prime Video during onboarding |
ALID |
String |
Yes |
Title identifier (ALID or SKU) matching your contribution |
marketplace |
String |
No |
The Amazon Marketplace that the title was submitted to. This defaults to GLOBAL and is not required to be provided. |
territory |
String |
No |
Two-letter territory code (e.g., US, GB, AU) that you would like to check the offer status. This defaults to all territories and is not required to be provided. All offer statuses will be returned if this is not provided |
Example Requests
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
Note: The more specific your request parameters, the more targeted your response will be. If you omit optional parameters like marketplace and territory, the API will return status information for all applicable scopes associated with that ALID.
Response Schema
The response schema defines the structure of data returned by the Offer Status API. Understanding these data types will help you parse the response and integrate status information into your systems effectively.
Get Status Response
The top-level response containing offer status information for the requested title. Each response includes status data filtered by your request parameters, allowing you to understand the availability state across different business lines and territories.
Attribute |
Type |
Is mandatory |
Description |
OfferStatuses |
OfferStatus[] |
Yes |
Array of offer status objects, one per scope (business line/territory combination) |
errors |
string |
No |
List of errors in case of failure |
Offer Status TypeThe core data structure representing the status of a single offer. This includes overall status information and detailed transaction-level data for each availability window.
Attribute |
Type |
Is mandatory |
Description |
ALID |
String |
Yes |
Title identifier matching your metadata contribution |
GroupingEntity |
string |
Conditional |
Identifier for a channel or subscription (required for SVOD offers) |
Licensor |
Publisher |
Yes |
Information about your organization granting license to Prime Video |
OverallStatus |
Status |
Yes |
Overall status for all windows in the current avail context/scope |
PlatformID |
String[] |
Yes |
List of Global Title Identifiers(GTI) for a title |
Transaction |
Transaction[] |
Yes |
A list of availability windows and their statuses |
Publisher type
Identifies your organization as the content licensor. This value is provided by Prime Video during onboarding.
Attribute |
Type |
Required |
Notes |
DisplayName |
String |
Yes |
Friendly name of your organization |
OrganizationID |
String |
Yes |
Your organization identifier provided by Prime Video during onboarding (must match value used in avails) |
Status type
Provides the overall status information for the offer, including the date range and current progress code.
Attribute |
Type |
Required |
Notes |
Comments |
String |
No |
Human-readable notes from Amazon (currently null) |
Start |
Date |
Yes |
Earliest window start date for the context |
End |
Date |
Yes |
Latest window end date for the context. |
Progress Code |
ENUM |
Yes |
Progress Code for the context |
_timestamp |
Date |
Yes |
Last time the status changed or was updated |
Transaction type
Represents a single availability window with its associated licensing terms and status. Each transaction corresponds to a specific license type, territory, and format profile combination.
Attribute |
Type |
Required |
Notes |
ContractID |
String |
Yes |
Contract the title is associated with |
FeatureStatus |
FeatureStatus |
Yes |
Status for the window |
End |
Date |
Yes |
Latest window end date for the context |
Progress Code |
ENUM |
Yes |
Progress code for the context |
_timestamp |
Date |
Yes |
The last time the status changed or was updated |
FormatProfile |
FormatProfile[] |
Yes |
Quality of availed video. Allowed values: SD, HD, UHD, MAX |
LicenseType |
Enum |
Yes |
Allowed values: SVOD, FVOD, EST, POEST, VOD |
Territory |
String[] |
Yes |
Territory for the window |
TransactionID |
String |
No |
Coming soon—will be the AvailID passed in with partial extracts (currently null). |
FeatureStatus type
Provides detailed status information for a specific availability window, including the date range and progress code.
Attribute |
Type |
Required |
Notes |
Comments |
String |
No |
Human-readable notes from Amazon (currently null) |
Start |
Date |
Yes |
Window start date |
End |
Date |
Yes |
Window end date |
Progress Code |
ENUM |
Yes |
Progress code for the window (currently null—use OverallStatus to determine if the context is live) |
_timestamp |
Date |
Yes |
Last time the status changed or was updated |
FormatProfile type
Specifies the video quality tier for the availability. Multiple format profiles can be included in a single transaction if you’ve availed your content in multiple quality tiers (for example, both HD and UHD).
Attribute |
Type |
Required |
Notes |
value[] |
Enum |
Yes |
Quality of availed video. Allowed values: SD, HD, UHD, MAX |
Note: The schemas above represent the current API response structure. Some fields (such as Comments, ProgressCode in FeatureStatus, and TransactionID) are currently null but may be populated in future releases.
Sample Response
This example demonstrates a typical API response for an SVOD title with multiple availability windows across different territories. The response shows how status information is structured, including overall status, transaction details, and format profiles.
SVOD Example:
[
{
"__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"
}
]
}
]