The Avails API endpoints are language-independent and can be accessed by any system with an internet connection. They use HTTP 1.1 for transmitting requests and responses.
Endpoints
The Avails API endpoints support the following operations.
PutAvailsFullExtractPUT https://partnerapi.primevideo.com/v1/avails/{licensor}/full-extract/{ALID}
- Description: Creates or updates availability information for a title.
- Input: JSON-encoded PutAvailsAPIRequest
- Output: JSON-encoded PutAvailsAPIResponse
GetAvailsFullExtractGET https://partnerapi.primevideo.com/v1/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}
- Description: Retrieves availability information for a specific content scope.
- Output: JSON-encoded GetAvailsAPIResponse
DeleteAvailsFullExtractDELETE https://partnerapi.primevideo.com/v1/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH|FIXED_FEE}&channelIdentity={Channel}
- Description: Deletes availability information for a specific content scope.
- Output: JSON-encoded DeleteAvailsAPIResponse
ValidateAvailsFullExtractPOST https://partnerapi.primevideo.com/v1/avails/{licensor}/full-extract/{ALID}/validate
- Description: Performs a validation check on availability information.
- Input: JSON-encoded ValidateAvailsAPIRequest
- Output: JSON-encoded ValidateAvailsAPIResponse
PutAvailsBatchFullExtractPOST https://partnerapi.primevideo.com/v1/avails/full-extract/batch/put
- Description: Creates or updates availability information in bulk.
- Input: JSON-encoded PutAvailsBatchAPIRequest
- Output: JSON-encoded PutAvailsBatchAPIResponse
PutAvailsPartialExtractPUT https://partnerapi.primevideo.com/v1/avails/{licensor}/partial-extract/transactions/{transactionID}
- Description: Creates or updates individual availability windows using unique identifiers.
- Input: JSON-encoded PutAvailsAPIRequest
- Output: JSON-encoded PutAvailsAPIResponse
GetAvailsPartialExtractGET https://partnerapi.primevideo.com/v1/avails/{licensor}/partial-extract/transactions/{transactionID}
- Description: Retrieves availability windows based on a unique identifier.
- Output: JSON-encoded GetAvailsAPIResponse
DeleteAvailsPartialExtractDELETE https://partnerapi.primevideo.com/v1/avails/{licensor}/partial-extract/transactions/{transactionID}
- Description: Deletes availability windows based on a unique identifier.
- Output: JSON-encoded DeleteAvailsAPIResponse
ValidateAvailsPartialExtractPOST https://partnerapi.primevideo.com/v1/avails/{licensor}/partial-extract/transactions/{transactionID}/validate
- Description: Validates availability windows using a unique identifier.
- Input: JSON-encoded ValidateAvailsAPIRequest
- Output: JSON-encoded ValidateAvailsAPIResponse
PutAvailsBatchPartialExtractPOST https://partnerapi.primevideo.com/v1/avails/partial-extract/batch/put
- Description: Creates or updates individual availability windows in bulk.
- Input: JSON-encoded PutAvailsBatchAPIRequest
- Output: JSON-encoded PutAvailsBatchAPIResponse
GetAvailsBatchPartialExtractPOST https://partnerapi.primevideo.com/v1/avails/partial-extract/batch/get
- Description: Retrieves availability windows in bulk using unique identifiers.
- Output: JSON-encoded GetAvailsBatchAPIResponse
DeleteAvailsBatchPartialExtractPOST https://partnerapi.primevideo.com/v1/avails/partial-extract/batch/delete
- Description: Deletes availability windows in bulk.
- Output: JSON-encoded DeleteAvailsBatchAPIResponse
HTTP response codes
All Avails endpoints will return a standard set of HTTP codes as outlined in the following table.
HTTP Code |
Description |
Retryable |
200 |
API call was successful. Callers should check response object for additional details. |
N/A |
400 |
Bad request including validation failures. |
No |
401 |
Not authorized. |
No |
404 |
Not found. |
No |
500 |
Internal error. |
Yes |
503 |
Dependency error. |
Yes |
