Avails API - Prime Video Tech Docs

Avails API

Last updated 2026-02-16

The Prime Video Avails API is part of the Content API suite and enables you to manage the availability of your titles on Prime Video through direct integration with your content rights management systems. Submit, update, retrieve, or delete availability windows with greater accuracy and control than traditional file uploads.


Why Use the Avails API?

The API streamlines your content management workflow and gives you more control over your Prime Video catalog:

  • Automated management - Eliminate manual uploads and reduce errors by automating availability window submissions and updates, freeing your team to focus on strategic tasks
  • Increased efficiency - Update specific availability windows without resubmitting entire datasets, saving time and reducing redundant processing.
  • Direct feedback - Validate your data in real time and receive immediate error messages without logging into Slate for manual corrections.
  • Interoperability - Built on a REST interface that’s language, system, and platform-agnostic, accessible from any system with an internet connection.

API Operations & Endpoints

All endpoints are language-independent and accessible via HTTP 1.1 from any system with an internet connection. The Avails endpoints do not follow a specific protocol and can be called in any order based on your workflow needs.

About Extract Models
An extract model defines how you structure and submit availability data to Prime Video. Think of it as choosing between sending us your complete catalog information versus sending only the specific changes you need to make.

Operation 1 - Create/Update Avails

  • What it does: Adds new availability windows or updates existing ones for your titles.
  • Why you need it: This is how you tell Prime Video when and where your content should be available to customers. Whether you’re launching new content or extending an existing license, this operation ensures your availability data is current.

Operation 2 - Retrieve Avails

  • What it does: Retrieves current availability information from Prime Video’s systems.
  • Why you need it: Verify what availability data Prime Video has on file, troubleshoot discrepancies, or pull data for reporting and reconciliation purposes.

Operation 3 - Validate Avails

  • What it does: Checks your availability data for errors before you submit it to Prime Video’s live systems.
  • Why you need it: Catch formatting errors, missing required fields, or business rule violations before they impact your content availability. This saves time by eliminating the need to submit, wait for processing, then fix errors and resubmit.

Operation 4 - Delete Avails

  • What it does: Removes availability windows from Prime Video’s systems.
  • Why you need it: Handle one-off scenarios where availability needs to be completely removed rather than expired.
  • Important: 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.


HTTP Response Codes

All Avails endpoints return standard HTTP codes that tell you whether your API request succeeded or failed and whether errors are temporary (retryable) or permanent, enabling your system to automatically handle responses without manual intervention.

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

Note: For retryable errors (500, 503), implement retry logic with appropriate delays between attempts. Non-retryable errors (400, 401, 404) indicate issues with your request that require correction before resubmitting.


API Schemas

The schemas outlined in this documentation are designed to help developers integrate with the Avails API. All payload schemas adhere to the MDDF API v2.6 standard. While you can include any MDDF API v2.6 attributes in your payload, Prime Video only processes supported attributes—unsupported attributes will be ignored.

Note: For a complete reference of supported attributes matching our EMA avails specification, see the EMA avails column in the Core Data Types table below. For information on how avails are managed and used across Prime Video, see the Content rights page.


Converting MDDF XML to JSON

The MDDF Avails API defines its schema in XML format, but supports payloads in both XML and JSON. Prime Video Avails APIs use JSON-encoded payloads. The process for converting MDDF XML to JSON is outlined below:

Namespaces are omitted

Nested elements become nested properties

Multiple elements with the same name become array elements

Attributes go in properties and prepended with an underscore


Common Schema Data Types

The Avails API schema supports the following data types:

Type

Description

Boolean

Boolean type. Allowed values: true, false

Integer

32-bit signed integer.

LongInteger

64-bit signed integer.

Decimal

Floating point number.

String

An array of characters.

Timestamp

ISO time stamp.

Enum

An enumerated string with a pre-defined set of allowed values.

Struct

Structure serves as an aggregator for other attributes.

Array

Collection of items of ASME type. Designated by [].

Note: The maximum number of items allowed in batch requests is limited to 100.


Request and Response Schemas

This section defines the data structures for all Avails API operations. These schemas specify the exact format for requests you send to Prime Video and responses you receive back. Understanding these structures is essential for successful API integration.

Schema 1 - Create/Update Avails


These schemas define the structure for creating or updating availability windows in Prime Video’s system. Use these when you need to submit new content rights or modify existing ones.

PutAvailsAPIRequest type
This is the primary request object for submitting a single availability window.

Attribute

Type

Is mandatory

Description

avail

Avail

Yes

Availability data - This is the top level attribute of any put or validate request

PutAvailsAPIResponse type

The response you’ll receive after submitting an availability window. Check the success field to confirm the operation completed, and review errors if the submission failed.

Attribute

Type

Is mandatory

Description

success

Boolean

Yes

Status of operation

errors

Error[]

No

List of errors in case of failure

PutAvailsBatchAPIRequest type
Use this schema when you need to submit multiple availability windows in a single API call. Batch operations improve efficiency when managing large catalogs or making bulk updates.

Attribute

Type

Is mandatory

Description

requestItems

PutAvailsBatchAPIRequestItem[]

Yes

List of individual requests

PutAvailsBatchAPIResponse type
The batch response returns individual results for each item in your batch request. Each response item corresponds to a request item via the requestItemId.

Attribute

Type

Is mandatory

Description

responseItems

PutAvailsBatchAPIResponseItem[]

Yes

List of response items

PutAvailsBatchAPIRequestItem type
Each item in a batch request requires a unique identifier and path that specifies the operation type (Full Extract) and target resource.

Attribute

Type

Is mandatory

Description

requestItemId

String

Yes

Unique identifier of item in batch request. This is a unique string that you will use to identify each item in the batch and will link to the batch response from us.

path

String

Yes

Path to a resource for this request item.
For Full Extract model the format is:
/avails/{licensor}/full-extract/{ALID}

body

PutAvailsBatchAPIRequestItemBody

Yes

Availability data

PutAvailsBatchAPIRequestItemBody type
The body of each batch request item contains the actual availability data you’re submitting.

Attribute

Type

Is mandatory

Description

avail

Avail

Yes

Availability data

PutAvailsBatchAPIResponseItem type
Each response item in the batch indicates success or failure for the corresponding request. Use the requestItemId to match responses to your original requests.

Attribute

Type

Is mandatory

Description

requestItemId

String

Yes

Unique identifier of item in batch request

success

Boolean

Yes

Status of operation

errors

Error[]

No

List of errors in case of failure

Schema 2 - Retrieve Avails


These schemas define how to retrieve existing availability windows from Prime Video’s system. Use these to query current rights information for your content.

GetAvailsAPIResponse type
The response contains the complete availability data for the requested content, including all licensing terms and territorial rights.

Attribute

Type

Is mandatory

Description

avail

Avail

Yes

Availability data

success

Boolean

Yes

Status of operation

errors

Error[]

No

List of errors in case of failure

GetAvailsBatchAPIRequest
Retrieve multiple availability windows in a single API call. This is efficient when you need to check rights for multiple titles or transactions.

Attribute

Type

Is mandatory

Description

requestItems

GetAvailsBatchAPIRequestItem[]

Yes

List of individual requests

GetAvailsBatchAPIResponse
Returns the availability data for each requested item. Each response corresponds to a request via the requestItemId.

Attribute

Type

Is mandatory

Description

responseItems

GetAvailsBatchAPIResponseItem[]

Yes

List of response items

GetAvailsBatchAPIRequestItem
Each get request item specifies the path to the resource you want to retrieve.

Attribute

Type

Is mandatory

Description

requestItemId

String

Yes

Unique identifier of item in batch request

path

String

Yes

Path to a resource for this request item.
For Full Extract model the format is:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}

GetAvailsBatchAPIResponseItem
Each response item contains the availability data if the retrieval was successful, or error details if it failed.

Attribute

Type

Is mandatory

Description

requestItemId

String

Yes

Unique identifier of item in batch request

success

Boolean

Yes

Status of operation

errors

Error[]

No

List of errors in case of failure

avail

Avail

No

Avail object

Schema 3 - Validate Avails


These schemas allow you to test your availability data before submitting it to Prime Video’s system. Validation catches errors early without creating or modifying actual availability windows.

ValidateAvailsAPIRequest type
The validation response indicates whether your data passes all validation rules. Review any errors before submitting the actual create or update request.

Attribute

Type

Is mandatory

Description

avail

Avail

Yes

Availability data

ValidateAvailsAPIResponse type
The validation response indicates whether your data passes all validation rules. Review any errors before submitting the actual create or update request.

Attribute

Type

Is mandatory

Description

success

Boolean

Yes

Status of operation

errors

Error[]

No

List of errors in case of failure

ValidateAvailsBatchAPIRequest type
Validate multiple availability windows in a single call. This is particularly useful when preparing large batch submissions.

Attribute

Type

Is mandatory

Description

requestItems

ValidateAvailsBatchAPIRequestItem[]

Yes

List of individual requests

ValidateAvailsBatchAPIResponse type
Returns validation results for each item in your batch. Each response corresponds to a request item via the requestItemId.

Attribute

Type

Is mandatory

Description

responseItems

ValidateAvailsBatchAPIResponseItem[]

Yes

List of response items

ValidateAvailsBatchAPIRequestItem type
Each validation request item includes the resource path with /validate appended to distinguish it from actual create or update operations.

Attribute

Type

Is mandatory

Description

requestItemId

String

Yes

Unique identifier of item in batch request

path

String

Yes

Path to a resource for the request:
Full Extract model: /avails/{licensor}/full-extract/{ALID}/validate

body

ValidateAvailsBatchAPIRequestItemBody

Yes

Request body

ValidateAvailsBatchAPIRequestItemBody type
Contains the availability window data to be validated.

Attribute

Type

Is mandatory

Description

avail

Avail

Yes

Availability data

ValidateAvailsBatchAPIResponseItem type
Each validation response item shows whether the corresponding data passed validation checks.

Attribute

Type

Is mandatory

Description

requestItemId

String

Yes

Unique identifier of item in batch request

success

Boolean

Yes

Status of operation

errors

Error[]

No

List of errors in case of failure

Schema 4 - Delete Avails


These schemas define how to remove availability windows from Prime Video’s system.

Important: We strongly recommend expiring content by adjusting the end date rather than deleting, except for specific use cases such as addressing compliance requirements. Expiring content maintains your historical data and audit trail, which is valuable for reporting and reconciliation.

DeleteAvailsAPIResponse type
Confirms whether the deletion operation completed successfully. Check the success field and review any errors.

Attribute

Type

Is mandatory

Description

success

Boolean

Yes

Status of operation

errors

Error[]

No

List of errors in case of failure

DeleteAvailsBatchAPIRequest type
Delete multiple availability windows in a single API call. This is useful for bulk takedowns or rights expirations.

Attribute

Type

Is mandatory

Description

requestItems

DeleteAvailsBatchAPIRequestItem[]

Yes

List of individual requests

DeleteAvailsBatchAPIResponse type
Returns deletion results for each item in your batch request.

Attribute

Type

Is mandatory

Description

responseItems

DeleteAvailsBatchAPIResponseItem[]

Yes

List of response items.

DeleteAvailsBatchAPIRequestItem type
Each delete request item specifies the path to the resource to be removed.

Attribute

Type

Is mandatory

Description

requestItemId

String

Yes

Unique identifier of item in batch request

path

String

Yes

Path to a resource for this request item.
For Full Extract model the format is:
/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}&contractID={CPH|FIXED_FEE}&channelIdentity={Channel}

DeleteAvailsBatchAPIResponseItem type
Each response item confirms whether the deletion succeeded for the corresponding request.

Attribute

Type

Is mandatory

Description

requestItemId

String

Yes

Unique identifier of item in batch request

success

Boolean

Yes

Status of operation

errors

Error[]

No

List of errors in case of failure

Core Data Types


These fundamental data types are used throughout the API schemas. Understanding these structures is essential for working with any avails operation. For more reference, please refer to the Content Rights page.

Error type
Standard error structure returned when operations fail. The code identifies the error type, while message provides human-readable details.

Attribute

Type

Is mandatory

Description

code

String

Yes

A string describing the error type.
Validation error codes: APIV{number}, CRMSV{number}
Service error codes: APIE{number}, CRMSE{number}
Examples: APIV400, CRMSE500

message

String

Yes

Human-readable description of error

Avail type
The core data structure representing a complete availability window. This includes all information about content rights, licensing terms, territories, and business conditions.

Attribute

Type

Required

Notes

EMA File Mapping

ALID

String

Yes

Specifies title identifier. Must match ALID specified in metadata contribution.

ALID

Disposition

AvailDisposition

Yes

Specifies extract model granularity.

N/A

Licensor

Publisher

Yes

Specifies information about entity granting license to Prime Video.

N/A

Asset

AvailAsset[]

Yes

Information about asset. Only a single asset should be specified in the list.

N/A

Transaction

AvailTrans[]

Yes

Information about transaction.

N/A

SharedEntitlement

AvailSharedEntitlement[]

No

Information on entitlements for other services.

N/A

AvailDisposition type
Defines whether this is a Full Extract or Full Delete operation, and whether it’s creating/updating or deleting data.

Attribute

Type

Required

Notes

EMA File Mapping

EntryType

Enum

Yes

Allowed values: FullExtract, FullDelete

Disposition

Publisher type
Identifies your organization as the content licensor. This value is provided by Prime Video during onboarding.

Attribute

Type

Required

Notes

EMA File Mapping

DisplayName

String

Yes

Specifies name of Prime Video partner. This value will be provided to partners by Prime Video. Must be same value as used in EMA files.

DisplayName

AvailAsset type
Describes the content asset being licensed. The structure varies based on WorkType (Movie, Episode, Season, etc.).

Attribute

Type

Required

Notes

EMA File Mapping

_contentID

String

Yes

Specifies content ID for this asset. Typically the same as ALID.

ContentID

WorkType

Enum

Yes

Allowed values: Movie, Short, Episode, Season, Supplemental

WorkType

Metadata

AvailUnitMetadata

Conditional

Describes metadata for Movie or Short. Required when WorkType is Movie or Short.

N/A

EpisodeMetadata

AvailEpisodeMetadata

Conditional

Describes metadata for Episode. Required when WorkType is Episode.

N/A

SeasonMetadata

AvailSeasonMetadata

Conditional

Describes metadata for Season. Required when WorkType is Season.

N/A

AvailSharedEntitlement type
Specifies entitlements for other digital ecosystems like DMA (Digital Movie Alliance).

Attribute

Type

Required

Notes

EMA File Mapping

_ecosystem

Enum

Yes

Allowed values: DMA
Note: UVVU - Ultraviolet not supported.

N/A

EcosystemID

String

Yes

Ecosystem specific title identifier

DMA_ID

AvailUnitMetadata type
Metadata for standalone content like movies or shorts.

Attribute

Type

Required

Notes

EMA File Mapping

TitleInternalAlias

String[]

Yes

Title Name. Only a single title name should be specified in the list.

TitleInternalAlias

AvailEpisodeMetadata type
Metadata specific to TV episodes, including episode number and parent season/series information.

Attribute

Type

Required

Notes

EMA File Mapping

TitleInternalAlias

String[]

Yes

Title Name for Episode. Only a single title name should be specified in the list.

EpisodeTitleInternalAlias

EpisodeNumber

ContentSequenceInfo

Yes

Number of this episode within season.

EpisodeNumber

SeasonMetadata

AvailSeasonMetadata

Conditional

Describes metadata for Season. Required when WorkType is Episode or Season.

N/A

SeriesMetadata

AvailSeriesMetadata

Conditional

Describes metadata for Series. Required when WorkType is Episode or Season.

N/A

AvailSeasonMetadata type
Metadata for TV seasons, including season number and episode count.

Attribute

Type

Required

Notes

EMA File Mapping

SeasonContentID

String

Yes

ALID for season.

SeasonContentID

SeasonTitleInternalAlias

String[]

No

Title Name for Season. Only a single title name should be specified in the list.

SeasonTitleInternalAlias

SeasonNumber

ContentSequenceInfo

Yes

Number for this season within series.

SeasonNumber

NumberOfEpisodes

Integer

Yes

Number of episodes in this season.

EpisodeCount

SeriesMetadata

AvailSeriesMetadata

Conditional

Describes metadata for Series. Required when WorkType is Season.

N/A

AvailSeriesMetadata type
Metadata for TV series, providing the top-level series information.

Attribute

Type

Required

Notes

EMA File Mapping

SeriesContentID

String

Yes

ALID for series.

SeriesContentID

SeriesTitleInternalAlias

String[]

No

Title Name for Series. Only a single title name should be specified in the list.

SeriesTitleInternalAlias

NumberOfSeasons

Integer

No

Number of seasons in this series.

SeasonCount

AvailTrans type
Defines a specific licensing transaction, including territory, dates, license type, and business terms. This is where you specify the actual rights being granted.

Attribute

Type

Required

Notes

EMA File Mapping

_TransactionID

String

No

Unique identifier for availability window. Optional when using FullExtract.

AvailID

LicenseType

Enum

Yes

Allowed values: SVOD, FVOD, EST, POEST, VOD

LicenseType

Territory

Region[]

Yes

Territory where distribution is allowed. Only a single territory item must be provided. All Transactions within a single Avail object must have the same territory.

Territory

Start

DateTime

Yes

Start date and time for distribution in ISO format.

NOTE: If no timezone is included we will use the eastern most timezone in the region. However, you can include any timezone if you want a specific release time.

Start

End

DateTime

No

End date and time for distribution in ISO format. If not provided, distribution has unlimited duration.

NOTE: If no timezone is included we will use the eastern most timezone in the region. However, you can include any timezone if you want a specific takedown time.

End

AssetLanguage

AssetLanguage[]

No

Language for asset expressed as ISO language code with asset type. Allowed asset types: subtitle, audio, subdub, sub, dub, ov, mta, any

AssetLanguage

AllowedLanguage

AssetLanguage[]

No

ISO language code with asset type. Allowed asset types: subtitle, audio, sub, dub, subdub, any

AllowedLanguages

HoldbackLanguage

AssetLanguage[]

No

ISO language code with asset type. Allowed asset types: subtitle, audio, sub, dub, subdub, any

HoldbackLanguage

LicenseRightsDescription

String

No

Used to specify publishing priority.

LicenseRightsDescription

FormatProfile

AvailFormatProfile

Yes

Quality of availed video. Allowed values: SD, HD, UHD

FormatProfile

ContractID

String

No

Specifies contractual information. Allowed values:
- CPH
- FIXED_FEE
- FIXED_FEE:{Deal ID}
When submitting avails, FIXED_FEE options are restricted by licensor.

ContractID

Terms

AvailTerms[]

Yes

Specifies list of business terms for availability window.

OtherTerms

OtherInstructions

String

No

Additional processing instructions for availability window.

OtherInstructions

Region type
Specifies a geographic territory using ISO country codes.

Attribute

Type

Required

Notes

EMA File Mapping

country

String

Yes

2-letter ISO 3166-1 country code

N/A

AssetLanguage type
Defines language availability for audio and subtitle assets.

Attribute

Type

Required

Notes

EMA File Mapping

value

String

Yes

Language for asset expressed as RFC 5646 language code with asset type.

N/A

_asset

String

No

Different set of values are allowed, depending on the language attribute from AvailTrans type.
Allowed values for AvailTrans.AssetLanguage:
subtitle, audio, subdub, sub, dub, ov, mta, any.
This attribute requires the same asset submitted for all languages.
Allowed values for AvailTrans.AllowedLanguage and AvailTrans. HoldbackLanguage:
subtitle, audio, sub, dub, subdub, any.
When asset value is “subdub”, “any”, or the value is absent, it will fanout to two assets: “subtitle” and “audio”.
Assets “sub” and “dub” are converted to their MDDF equivalent “subtitle” and “audio”.

N/A

AvailFormatProfile type
Specifies the video quality tier for the availability.

Attribute

Type

Required

Notes

EMA File Mapping

value

Enum

Yes

Quality of availed video. Allowed values: SD, HD, UHD

N/A

AvailTerms type
Flexible structure for specifying business terms. Each term has a name and a value of the appropriate type (Money, Text, Event, Boolean, Duration, or Number).

Attribute

Type

Required

Notes

EMA File Mapping

_termName

String

Yes

Identifies the term. The value is case-insensitive. For a list of allowed values, see below.

N/A

Money

Money

No

For more details see below.

N/A

Text

String

No

For more details see below.

N/A

Event

DateTime

No

For more details see below.

N/A

Boolean

Boolean

No

For more details see below.

N/A

Duration

String

No

For more details see below.

N/A

Number

Integer

No

For more details see below.

N/A

Money type
Represents monetary values with currency specification.

Attribute

Type

Required

Notes

EMA File Mapping

value

Decimal

No

Monetary value, required for some price types

N/A

_currency

String

Yes

ISO currency code

N/A

ContentSequenceInfo type
Specifies sequence numbers for episodes and seasons.

Attribute

Type

Required

Notes

EMA File Mapping

Number

Integer

Yes

Content sequence number, such as episode number or season number

N/A

Supported Avail terms
The following table lists all supported business terms that can be included in the AvailTerms array. Each term controls specific aspects of licensing, pricing, advertising, and customer experience.

Term name

Attribute

Required

Notes

EMA File Mapping

ChannelIdentity

Text

Yes

Identifier for a channel or subscription.

GroupIdentity

Tier

Text

Conditional

Pricing tier. Required if license type is POEST.

PriceType

SRP

Money

Conditional

Suggested retail price. Required if license type is POEST.

SRP

WSP

Money

Conditional

Wholesale price. Required if license type is POEST.

PriceValue

Category

Text

Conditional

Price category. Required if license type is POEST.

PriceValue

AnnounceDate

Event

No

Date when the retailer is permitted to announce the availability start date of the title within the available territory.

AnnounceDate

SuppressionLiftDate

Event

Conditional

First date a title could be publicly announced as becoming available at a specific future date in territory of avail. Required if license type is POEST.

SuppressionLiftDate

RentalDuration

Duration

Conditional

Duration of rental period in hours. Required if license type is SVOD.

RentalDuration

WatchDuration

Duration

Conditional

How long user has to complete viewing once started, in hours. Required if license type is SVOD.

WatchDuration

Download

Text

No

License includes permission to download. Valid values are Yes and No. When license type is SVOD, both rental duration and watch duration must be specified.

Download

Exclusive

Boolean

No

Assets are exclusive within the scope of the Transaction.

Exclusive

ExclusiveAttributes

Text

No

Specifies type of exclusivity. Only considered when Exclusive is true. A default value will be used if not provided when Exclusive is true.

ExclusiveAttributes

BrandingRights

Boolean

No

Indicates partner intent to display branding.

BrandingRights

BrandingRightsAttributes

Text

No

Specifies branding text. Only considered when BrandingRights is true. A default value will be used if not provided when BrandingRights is true.

BrandingRightsAttributes

allowAds

Boolean

No

Determines whether ads are allowed or prohibited. This term can appear only once.

Not available in EMA

allowedAdPlacement

Text

Conditional

Specifies location in roll where ads can be inserted. Allowed values are: PreRoll, MidRoll, PostRoll, Overlays, PauseAds, Squeezebacks.
Allowed only when allowAds is true.
This term can appear more than once. Either allowedAdPlacement or prohibitedAdPlacement can be specified, but not both.

Not available in EMA

prohibitedAdPlacement

Text

Conditional

Specifies location in roll where ads cannot be inserted. Allowed values are: PreRoll, MidRoll, PostRoll,Overlays, PauseAds, Squeezebacks.
This term can appear more than once.
Allowed only when allowAds is true.
Either allowedAdPlacement or prohibitedAdPlacement can be specified, but not both.

Not available in EMA

cuepointDeliveryAndUsage

Text

No

Specifies cuepoint delivery and usage obligations. Allowed values: PartnerWillDeliverAndPrimeVideoMustUse, PrimeVideoWillUseIfDelivered, NoDeliveryOrUsageObligations, TalentObligated.
Allowed only when allowAds is true.

Not available in EMA

blindBasisSelling

Text

No

Allowed values: GuaranteedImpressions, NoGuaranteedImpressions
This attribute should only be present if allowAds is set to true.

Not available in EMA

sponsorships

Text

No

Allowed values: Permitted, Prohibited, PermittedWithRestrictions.
This attribute should only be present if allowAds is set to true.

Not available in EMA

sponsorshipsRestrictions

Text

Conditional

Free-form text
This attribute should only be present if sponsorships is set to AllowedWithRestrictions.

Not available in EMA

talentAndAmazonAdGuidelines

Text

No

Allowed values: NoRestrictions, ConsultationRequired
This attribute should only be present if allowAds is set to true.

Not available in EMA

talentRestrictions

Text

Conditional

Free-form text
This attribute should only be present if talentAndAmazonAdGuidelines is set to ConsultationRequired.

Not available in EMA

adLoadLimit

Text

No

Number of ad minutes per hour. Value must be a valid integer.
This attribute should only be present if allowAds is set to true.

Not available in EMA

adKey

Text

No

Free-form text
Unique identifier for mapping content to ad management servers.

Not available in EMA

CompleteYourBundleDiscountPercentage

Number

No

Percentage discount applied when customers complete a bundle by purchasing remaining titles they don’t already own. For example, a 20% discount means customers who own Season 1 of a 2-season bundle receive 20% off Season 2.

Not available in EMA

ExcludedFromBundleDiscount

Boolean

No

When set to true, excludes this availability window from bundle discount eligibility. Use during premium pricing periods (e.g., new releases) or for titles that should maintain full pricing. When absent or false, the title is eligible for bundle discounts.

Not available in EMA

BusinessLine Enumeration
The BusinessLine enumeration specifies the Prime Video business model under which content is licensed and distributed. This determines how customers access the content and how revenue is generated.

Value

Description

TVOD

TVOD means purchase or rental. Related license types: EST, VOD, POEST

PRIME_SUBSCRIPTION

Amazon Prime or Amazon Kids+ subscription. Related license types: SVOD

CHANNELS

Third-party channel subscription. Related license types: SVOD

FVOD

Free content. Related license types: FVOD

Note: The BusinessLine value determines which business model applies to your content availability. When submitting avails, ensure the BusinessLine aligns with your contractual agreement with Prime Video. If you have questions about which BusinessLine values are available for your partnership, contact your Prime Video representative.


Sample Payload Avails

The following examples demonstrate how to structure your API calls for common integration scenarios. See Payload Examples for complete request/response pairs with properly formatted JSON that you can use as templates for your integration.


FAQs

The following sections provide answers to common questions about working with the Avails API.

General API use

Content removal and date changes

Submit avails

Can’t find what you’re looking for?

Contact us


Errore interno del server. Riprova tra qualche istante.
La tua sessione è scaduta

Accedi per continuare

Accedi
edit