This section provides request and response examples for common Avails API operations. Each example demonstrates the correct JSON structure and required fields, helping you build and test your integration with Prime Video. Use these examples as templates when submitting and updating your avails—you can copy them directly into your console to verify your implementation before delivering content to Prime Video.
Create/Update Avails API Payload Samples
The Avails API allows you to create and update availability windows for your content in Prime Video’s system. This section provides request and response examples, demonstrating how to structure your API calls for different scenarios.
Example 1: Channel Episode with Multiple Avails
Request 1: Episode-Level Availability with 2 windows - This request creates availability for an episode on subscription channel with two video format tiers UHD & HD:
{
"avail": {
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"ALID": "demoALID",
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Episode",
"EpisodeMetadata": {
"TitleInternalAlias": [
"Avail Strikes Back: Season 1, Episode 2"
],
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Avail Strikes Back: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77
},
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Avail Strikes Back"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "availId123",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "mgm_plus_subscription"
},
{
"_termName": "adKey",
"Text": "Break776353"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "mgm_plus_subscription"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
Request 2: Season-Level Availability for Single Video Window
This request creates availability for the entire Season 1 on a different subscription channel in SD format:
{
"avail": {
"ALID": "demoALID_For_Season_01",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID_For_Season_01",
"WorkType": "Season",
"SeasonMetadata": {
"SeasonContentID": "demoALID_For_Season_01",
"SeasonTitleInternalAlias": [
"Avail Strikes Back: Season 1"
],
"SeasonNumber": {
"Number": 1
},
"NumberOfEpisodes": 77,
"SeriesMetadata": {
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"Avail Strikes Back"
],
"NumberOfSeasons": 4
}
}
}
],
"Transaction": [
{
"_TransactionID": "availId789season",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"ContractID": "CPH",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "A4K"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
Example 2: FVOD Movie with Multiple Locales
{
"avail": {
"ALID": "demoALID",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Harry Potter and Marge Simpson"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movie",
"LicenseType": "FVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456movie",
"LicenseType": "FVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
},
{
"_termName": "Category",
"Text": "sub"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": false
}
]
}
]
}
}
Example 3: TVOD Movie
{
"avail": {
"ALID": "demoALID",
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "DemoDMA_Title_ID"
}
],
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Harry Potter and Marge Simpson"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movie",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 8.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 7.99,
"_currency": "USD"
}
},
{
"_termName": "RentalDuration",
"Duration": "PT720H"
},
{
"_termName": "WatchDuration",
"Duration": "PT48H"
},
{
"_termName": "Download",
"Text": "No"
},
{
"_termName": "Exclusive",
"Boolean": true
},
{
"_termName": "ExclusiveAttributes",
"Text": "SECOND_RUN_EXCLUSIVE"
}
]
},
{
"_TransactionID": "availId456movie",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 19.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 18.99,
"_currency": "USD"
}
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "Exclusive",
"Boolean": false
},
{
"_termName": "AnnounceDate",
"Event": "2022-05-22T10:00:00Z"
}
]
},
{
"_TransactionID": "availId789movie",
"LicenseType": "POEST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2023-03-14T09:00:00Z",
"End": "2029-05-22T10:00:00Z",
"LicenseRightsDescription": "DAB",
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"HoldbackLanguage": [
{
"value": "fr-CA",
"_asset": "subtitle"
},
{
"value": "fr-CA",
"_asset": "audio"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 18.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 17.99,
"_currency": "USD"
}
},
{
"_termName": "Download",
"Text": "Yes"
},
{
"_termName": "Exclusive",
"Boolean": false
},
{
"_termName": "AnnounceDate",
"Event": "2022-05-22T10:00:00Z"
},
{
"_termName": "SuppressionLiftDate",
"Event": "2022-07-24T10:00:00Z"
}
]
}
]
}
}
Example 4: Movie Trailer
{
"avail": {
"ALID": "demoALID",
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Supplemental",
"Metadata": {
"TitleInternalAlias": [
"Movie: Trailer"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123movietrailer",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2024-12-09T14:00:00Z",
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
}
]
},
{
"_TransactionID": "availId123movietrailer",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2024-12-09T14:00:00Z",
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
}
]
}
]
}
Example 5: TV Series Trailer
{
"avail": {
"ALID": "demoALID",
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "demoALID",
"WorkType": "Supplemental",
"Metadata": {
"TitleInternalAlias": [
"Title Name - Season 3: Official Final Trailer"
]
}
}
],
"Transaction": [
{
"_TransactionID": "availId123tvtrailer",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2025-09-05T13:00:00Z",
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
}
]
},
{
"_TransactionID": "availId123tvtrailer",
"LicenseType": "SVOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2025-09-05T13:00:00Z",
"Terms": [
{
"_termName": "ChannelIdentity",
"Text": "FVOD"
}
]
}
]
}
}
Example 6: Movie Bundle with Discount
{
"avail": {
"ALID": "TEST_COLLECTION",
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "mgm"
},
"Asset": [
{
"_contentID": "TEST_COLLECTION",
"WorkType": "Collection",
"Metadata": {
"TitleInternalAlias": [
"TEST COLLECTION (4)"
]
},
"BundleAsset": [
{
"BundledALID": "Bundle_Movie_1"
},
{
"BundledALID": "Bundle_Movie_2"
},
{
"BundledALID": "Bundle_Movie_3"
},
{
"BundledALID": "Bundle_Movie_4"
}
]
}
],
"Transaction": [
{
"_TransactionID": "Bundle_collection_est",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "Max"
},
"Start": "2025-10-18T04:00:00Z",
"End": "2032-11-22T04:59:59.999Z",
"Terms": [
{
"_termName": "Tier",
"Text": "CAT EST",
"Money": {
"_currency": "USD"
}
},
{
"_termName": "SRP",
"Money": {
"value": 44.99,
"_currency": "USD"
}
},
{
"_termName": "CompleteYourBundleDiscountPercentage",
"Number": 20
}
]
}
]
}
}
Example 7: TV Series Bundle
{
"avail": {
"ALID": "Test_TV_Bundle_1",
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "TestLicensor"
},
"Asset": [
{
"_contentID": "Test_TV_Bundle_1",
"WorkType": "Series",
"SeriesMetadata": {
"SeriesTitleInternalAlias": [
"TV_Bundle_Test"
],
"NumberOfSeasons": 2
}
}
],
"Transaction": [
{
"_TransactionID": "tv_bundle_series_est",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "Max"
},
"Start": "2025-08-26T04:00:00Z",
"End": "2100-01-01T04:59:59.999Z",
"AssetLanguage": [
{
"value": "EN"
}
],
"Terms": [
{
"_termName": "SRP",
"Money": {
"value": 44.99,
"_currency": "USD"
}
},
{
"_termName": "WSP",
"Money": {
"value": 28.34,
"_currency": "USD"
}
},
{
"_termName": "CompleteYourBundleDiscountPercentage",
"Number": 50
}
]
}
]
}
}
Example 8: Movie exc. from Bundles discount
{
"avail": {
"ALID": "SKU12345",
"Disposition": {
"EntryType": "FullExtract"
},
"Licensor": {
"DisplayName": "TestLicensor"
},
"SharedEntitlement": [
{
"_ecosystem": "DMA",
"EcosystemID": "Test1234567"
}
],
"Asset": [
{
"_contentID": "SKU12345",
"WorkType": "Movie",
"Metadata": {
"TitleInternalAlias": [
"Exclude_from_Bundles_Test"
]
}
}
],
"Transaction": [
{
"_TransactionID": "exclude_bundle_uhd_premium",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2025-11-25T05:00:00Z",
"End": "2026-04-07T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 12.99,
"_currency": "USD"
}
},
{
"_termName": "ExcludedFromBundleDiscount",
"Boolean": true
}
]
},
{
"_TransactionID": "exclude_bundle_hd_premium",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2025-11-25T05:00:00Z",
"End": "2026-04-07T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 12.99,
"_currency": "USD"
}
},
{
"_termName": "ExcludedFromBundleDiscount",
"Boolean": true
}
]
},
{
"_TransactionID": "exclude_bundle_sd_premium",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2025-11-25T05:00:00Z",
"End": "2026-04-07T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 12.99,
"_currency": "USD"
}
},
{
"_termName": "ExcludedFromBundleDiscount",
"Boolean": true
}
]
},
{
"_TransactionID": "exclude_bundle_uhd_midtier",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2026-04-07T04:00:00Z",
"End": "2027-04-07T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 10.99,
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_hd_midtier",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2026-04-07T04:00:00Z",
"End": "2027-04-07T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 10.99,
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_sd_midtier",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2026-04-07T04:00:00Z",
"End": "2027-04-07T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 10.99,
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_uhd_catalog",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2027-04-07T04:00:00Z",
"End": "2031-01-01T04:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 11.99,
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_hd_catalog",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2027-04-07T04:00:00Z",
"End": "2031-01-01T04:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 11.99,
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_sd_catalog",
"LicenseType": "EST",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2027-04-07T04:00:00Z",
"End": "2031-01-01T04:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "WSP",
"Money": {
"value": 11.99,
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_uhd_vod_premium",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2025-10-28T04:00:00Z",
"End": "2026-04-27T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "Category",
"Text": "NR",
"Money": {
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_hd_vod_premium",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2025-10-28T04:00:00Z",
"End": "2026-04-27T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "Category",
"Text": "NR",
"Money": {
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_sd_vod_premium",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2025-10-28T04:00:00Z",
"End": "2026-04-27T03:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "Category",
"Text": "NR",
"Money": {
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_uhd_vod_catalog",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "UHD"
},
"Start": "2026-04-27T04:00:00Z",
"End": "2031-01-01T04:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "Category",
"Text": "LB",
"Money": {
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_hd_vod_catalog",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "HD"
},
"Start": "2026-04-27T04:00:00Z",
"End": "2031-01-01T04:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "Category",
"Text": "LB",
"Money": {
"_currency": "USD"
}
}
]
},
{
"_TransactionID": "exclude_bundle_sd_vod_catalog",
"LicenseType": "VOD",
"Territory": [
{
"country": "US"
}
],
"FormatProfile": {
"value": "SD"
},
"Start": "2026-04-27T04:00:00Z",
"End": "2031-01-01T04:59:59Z",
"AssetLanguage": [
{
"value": "en"
}
],
"AllowedLanguage": [
{
"_asset": "audio",
"value": "en"
},
{
"_asset": "subtitle",
"value": "en"
}
],
"Terms": [
{
"_termName": "Category",
"Text": "LB",
"Money": {
"_currency": "USD"
}
}
]
}
]
}
}
Retrieve Avails API samples
This section provides request and response examples, demonstrating how to structure your API calls to access existing content rights information.
Example 1: Retrieve Title Availability
REQUEST
Method: GET
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid?territory=US&businessLine=PRIME_SUBSCRIPTION
RESPONSE
StatusCode: 200
Body:
{
"avail": {
"ALID": "demoAlid",
"Asset": [
{
"EpisodeMetadata": {
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonNumber": {
"Number": 1
},
"SeasonTitleInternalAlias": [
"AvailStrikesBack:Season1"
]
},
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"AvailStrikesBack"
]
},
"TitleInternalAlias": [
"TestTitleName"
]
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
},
"Transaction": [
{
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"ContractID": "CPH",
"End": "2029-05-22T10:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseRightsDescription": "DAB",
"LicenseType": "SVOD",
"Start": "2023-03-14T09:00:00Z",
"Terms": [
{
"Text": "prime",
"_termName": "ChannelIdentity"
},
{
"Text": "Yes",
"_termName": "Download"
},
{
"Duration": "PT720H",
"_termName": "RentalDuration"
},
{
"Duration": "PT48H",
"_termName": "WatchDuration"
},
{
"Money": {
"_currency": "USD",
"value": 15.99
},
"_termName": "SRP"
},
{
"Boolean": true,
"_termName": "Exclusive"
},
{
"_termName": "ExclusiveAttributes"
}
],
"Territory": [
{
"country": "US"
}
]
}
]
},
"success": true
}
Validate Avails API samples
The Avails API allows you to test your availability windows for errors before submitting them to Prime Video’s live systems. This section provides request and response examples, demonstrating how to structure your API calls to catch errors early in your integration workflow.
Example 1: Validate Complete Data Availability
REQUEST
Method: POST
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid/validate
Body:
{
"avail": {
"ALID": "demoAlid",
"Asset": [
{
"EpisodeMetadata": {
"EpisodeNumber": {
"Number": 2
},
"SeasonMetadata": {
"NumberOfEpisodes": 77,
"SeasonContentID": "demoALID_For_Season_01",
"SeasonNumber": {
"Number": 1
},
"SeasonTitleInternalAlias": [
"AvailStrikesBack:Season1"
]
},
"SeriesMetadata": {
"NumberOfSeasons": 4,
"SeriesContentID": "demoALID_For_Series",
"SeriesTitleInternalAlias": [
"AvailStrikesBack"
]
},
"TitleInternalAlias": [
"TestTitleName"
]
},
"WorkType": "Episode",
"_contentID": "demoAlid"
}
],
"Licensor": {
"DisplayName": "testlicensor"
},
"Transaction": [
{
"AssetLanguage": [
{
"value": "en-US"
},
{
"value": "fr-FR"
},
{
"value": "fr-CA"
}
],
"ContractID": "CPH",
"End": "2029-05-22T10:00:00Z",
"FormatProfile": {
"value": "UHD"
},
"HoldbackLanguage": [
{
"_asset": "subtitle",
"value": "fr-CA"
},
{
"_asset": "audio",
"value": "fr-CA"
}
],
"LicenseRightsDescription": "DAB",
"LicenseType": "SVOD",
"Start": "2023-03-14T09:00:00Z",
"Terms": [
{
"Text": "prime",
"_termName": "ChannelIdentity"
},
{
"Text": "Yes",
"_termName": "Download"
},
{
"Duration": "PT720H",
"_termName": "RentalDuration"
},
{
"Duration": "PT48H",
"_termName": "WatchDuration"
},
{
"Money": {
"_currency": "USD",
"value": 15.99
},
"_termName": "SRP"
},
{
"Boolean": true,
"_termName": "Exclusive"
},
{
"_termName": "ExclusiveAttributes"
}
],
"Territory": [
{
"country": "US"
}
]
}
]
}
}
RESPONSE
StatusCode: 200
Body:
{
"success": true,
"validationErrors": []
}
Delete Avails API samples
Note: We strongly recommend expiring content by adjusting the end date rather than deleting, except for one-off use cases. Expiring maintains your historical data and audit trail.
Example 1: Remove All Availability for a Title
REQUEST
Method: Delete
Url: https://partnerapi.primevideo.com/v1/avails/testlicensor/full-extract/demoAlid?territory=US&businessLine=PRIME_SUBSCRIPTION&contractId=CPH
RESPONSE:
{
"success": true
}
Helpful References
You can easily onboard to our Prime Video APIs. Detailed information on how to onboard to each API suite is available in the Onboarding guide. Please note that the onboarding process for the Content API suite and Analytics API suite are separate.