Avails API Payload Samples

• Use case: You’re licensing an episode to multiple subscription channels with different format offerings. This example demonstrates how to submit availability for the same episode across two channels—one with both UHD and HD windows, and one with an SD window.
• Why use Full Extract: Full Extract replaces all availability data for a specific title/territory/business line combination, making it ideal when you want to ensure Prime Video has your complete, current availability picture.
• Operation: PutAvailsFullExtract

• Use case: You’re making a movie available for FVOD (Free ad-supported) viewing in both UHD and HD formats with multiple languages.
• Why use this pattern: This example shows how to offer multiple quality tiers for the same free-to-watch title.
• Operation: PutAvailsFullExtract

• Use case: You’re offering a movie for transactional viewing with rental (TVOD), electronic sell-through (EST), and pre-order electronic sell-through (POEST) options.
• Why use this pattern: TVOD content requires pricing information and allows you to offer multiple purchase/rental models simultaneously.
• Operation: PutAvailsFullExtract

• Use case: You’re submitting availability for a movie trailer to make it available for free viewing across multiple formats. Trailers are classified as “Supplemental” content and are a type of Value Added Material (VAM) - promotional or bonus content that enhances the customer experience beyond the primary title.
• Why use Full Extract: Full Extract ensures all availability windows for the trailer are current. Since trailers are promotional content, they’re often made available broadly without end dates to maintain ongoing discoverability.
• Operation: PutAvailsFullExtract

• Use case: You’re submitting availability for a TV series season trailer to promote an upcoming season. Like movie trailers, TV trailers are “Supplemental” content and are a type of Value Added Material (VAM) that enhances customer engagement with the series.
• Why use Full Extract: Full Extract ensures the trailer availability is complete and current. TV trailers often need updates as new seasons are announced or release dates change.
• Operation: PutAvailsFullExtract

• Use case: You’re submitting availability for a movie collection bundle that groups multiple related titles together at a discounted price. Bundles allow customers to purchase multiple movies as a package, often with a “Complete Your Bundle” discount if they already own some titles in the collection.
• What are Bundles? Bundles (also called Collections or Box Sets) group related content together for purchase as a package. Movie bundles typically feature films from the same franchise, director, genre, or theme. For detailed information about bundle types, specifications, and delivery requirements, go to: Overall Bundle Documentation.
• Why use Full Extract: Full Extract ensures all bundle availability data is current, including pricing, bundled titles, and discount terms. This is essential when bundle composition or pricing changes.
• Operation: PutAvailsFullExtract

• Use case: You’re submitting availability for a complete TV series bundle (box set) that includes all seasons. This allows customers who already own individual seasons to purchase remaining seasons at a discount.
• What are TV Bundles? TV bundles (box sets) group all seasons of a series together for purchase as a package. For detailed information, go to Overall Bundle Documentation.
• Operation: PutAvailsFullExtract

• Use case: You’re submitting availability for a movie with multiple pricing tiers over time, where the initial premium pricing period should be excluded from bundle discounts. This prevents customers from getting discounted access during the premium window.
• What is ExcludedFromBundleDiscount? This term prevents a title from being eligible for Complete Your Bundle discounts during specific availability windows. This is useful for specific pricing periods where you want to maintain full pricing.
• Operation: PutAvailsFullExtract

• Use case: You want to retrieve all current availability windows for a specific title in a territory and business line. This is useful for verifying what Prime Video has on file, troubleshooting discrepancies, or pulling data for reporting and reconciliation.
• Why use Full Extract: Full Extract retrieves all availability data for a specific ALID/territory/business line combination, giving you a complete picture of how the content is currently configured in Prime Video’s systems.
• Operation: GetAvailsFullExtract

• Use case: You want to validate all availability data for a title before submitting it to Prime Video’s live systems. This ensures your payload is correctly formatted and meets all business rules.
• Why use Full Extract validation: Full Extract validation checks all availability windows for a title/territory/business line combination, ensuring your complete submission is error-free before going live.
• Operation: ValidateAvailsFullExtract

• Use case: You need to completely remove all availability windows for a specific title in a territory and business line. This is a rare operation typically used when content was submitted in error or when contractual obligations require complete removal rather than expiration.
• Why use Full Extract: Full Extract delete removes all availability data for a specific ALID/territory/business line/contract combination. This is a broad operation that clears all windows matching these parameters.
• Operation: DeleteAvailsFullExtract

The Content API Suite enables you to automate content management workflows and receive real-time visibility into your content’s status on Prime Video. This suite includes:

• Avails API – Submit, update, retrieve, and delete content rights (avails) programmatically across all business lines and territories
• Offer Status API – Check if your titles are live on the Prime Video storefront and understand what’s blocking titles from going live
• Asset Status API – Monitor asset delivery status and receive instant feedback on content readiness
• Notifications API – Receive real-time notifications for asset delivery and offer status events, eliminating the need to poll status APIs

When you onboard to the Content API Suite, you’ll receive access to the APIs you request during the onboarding process. All APIs within this suite use MTLS (Mutual Transport Layer Security) certificate-based authentication with API keys.