TvShow Elements

Note: After clicking a link in the diagram, the element scrolls into focus below the diagram.

Diagram

├── Partner
└── Works
    ├── Movie
    ├── TvEpisode
    ├── TvSeason
    ├── TvShow
    │   ├── ID
    │   ├── ExternalID
    │   ├── Titles
    │   │   └── Title
    │   ├── Copyright
    │   ├── Offers
    │   │   ├── SubscriptionOffer
    │   │   │   ├── Regions
    │   │   │   │   └── Territories
    │   │   │   ├── WindowStart
    │   │   │   ├── WindowEnd
    │   │   │   └── LaunchDetails
    │   │   │       ├── Quality
    │   │   │       ├── AudioLanguage
    │   │   │       ├── Subtitle
    │   │   │       └── LaunchId
    │   │   └── FreeOffer
    │   │       ├── Regions
    │   │       │   └── Territories
    │   │       ├── WindowStart
    │   │       ├── WindowEnd
    │   │       └── LaunchDetails
    │   │           ├── Quality
    │   │           ├── AudioLanguage
    │   │           ├── Subtitle
    │   │           └── LaunchId
    │   ├── IsAdultProducts
    │   │   └── IsAdultProduct
    │   ├── ReleaseYear
    │   ├── ShortDescriptions
    │   │   └── ShortDescription
    │   ├── Synopses
    │   │   └── Synopsis
    │   ├── MetadataAvailabilityDates
    │   │   └── MetadataAvailabilityDate
    │   ├── Images
    │   │   └── Image
    │   │       ├── Url
    │   │       └── Locale
    │   ├── Runtimes
    │   │   └── RuntimeMinutes
    │   ├── Color
    │   ├── Credits
    │   │   ├── CastMember
    │   │   │   ├── Name
    │   │   │   ├── ExternalID
    │   │   │   └── Role
    │   │   └── CrewMember
    │   │       ├── Name
    │   │       ├── ExternalID
    │   │       └── Job
    │   ├── Studios
    │   │   └── Studio
    │   ├── Language
    │   ├── CustomerRating
    │   │   ├── Score
    │   │   ├── MaxValue
    │   │   └── Count
    │   ├── Rank
    │   ├── IsOriginals
    │   │   └── IsOriginal
    │   ├── Genres
    │   │   └── Genre
    │   ├── ContentRatings
    │   │   └── ContentRating
    │   │       ├── System
    │   │       └── Certification
    │   └── ReleaseDates
    │       └── ReleaseDate
    └── Extra

<?xml version="1.0" encoding="utf-8" ?>

<Catalog xmlns="http://www.amazon.com/FireTv/2014-04-11/ingestion" version="FireTv-v1.11">

  <!-- This sample Amazon Fire TV catalog shows you how to use the TvShow work type. Examples use various tagging, from the minimum information required to the inclusion of all optional elements. The final example contains information on which elements are required and which are optional. -->
  <!-- Note that most elements are the same in all work types, with only the last 1-3 elements changing from type to type. The majority of what applies here also applies to other work types. -->

  <Partner>Everything Ever Made Filmworks</Partner>
  <Works>

    <!-- This example provides pretty much the minimal information for a valid entry. While valid, it will be difficult for a user to locate this work through search or browse. The more metadata you can provide, the better. -->
    <TvShow>
      <ID>TV2329880</ID>
      <Title locale="en-US">Office Factor</Title>
      <Offers>
        <SubscriptionOffer>
          <Regions>
            <Country>US</Country>
          </Regions>
        </SubscriptionOffer>
      </Offers>
    </TvShow>

    <!-- This entry adds some optional information that gives the work more visibility. For instance, the work can now be found through a search for the star's name. Also, once the user locates the work, they can read more about it. -->
    <TvShow>
      <ID>TV234567</ID>
      <!-- Optional -->
      <ExternalID scheme="imdb">tt7717488</ExternalID>
      <Title locale="en-US">Depth of Field</Title>
      <Offers>
        <SubscriptionOffer>
          <Regions>
            <Country>US</Country>
            <Country>FR</Country>
            <Country>BE</Country>
          </Regions>
          <!-- Optional -->
            <LaunchDetails>
              <Quality>HD</Quality>
            </LaunchDetails>
        </SubscriptionOffer>
      </Offers>
      <!-- Optional -->
      <ShortDescription locale="en-US">The behind-the-scenes and on-the-field drama of high school football in Rhode Island.</ShortDescription>
      <!-- Optional -->
      <Credits>
        <CastMember>
          <Name locale="en-US">Marvin Petinez</Name>
          <ExternalID scheme="imdb">nm0000000</ExternalID>
          <Role locale="en-US">Coach Omar Johnston</Role>
        </CastMember>
      </Credits>
      <ReleaseDate>2014-09-01T20:00:00</ReleaseDate>
    </TvShow>

    <!-- This entry provides all of the possible information. We've included comments to tell you about whether each element is required or optional, valid values for certain entries, and some usage notes. -->
    <TvShow>
      <!-- Required. ID must be at least one character long and unique in catalog. -->
      <ID>TV098765</ID>

      <!-- Optional. Multiple instances allowed. If present, scheme attribute is required (accepted values imdb, tms, isan, ean, and upc). -->
      <ExternalID scheme="imdb">tt3012532</ExternalID>
      <ExternalID scheme="tms">MV000000000000</ExternalID>
      <ExternalID scheme="isan">0000-0000-0F00-0000-X-0000-0000-Y</ExternalID>
      <ExternalID scheme="ean">0011559514120</ExternalID>
      <ExternalID scheme="upc">123456789990</ExternalID>

      <!-- Required (locale attribute also required). Multiple instances allowed, but only one for each locale. -->
      <Title locale="en-US">Annedroids</Title>
      <Title locale="fr-FR">Les robots d'Anne</Title>

      <!-- Optional. One instance only. If present, locale attribute required. -->
      <Copyright locale="en-US">© 2013 Amazon Studios</Copyright>

      <!-- Required. One instance only. -->
      <Offers>
        <!-- You have a choice of 2 offer types: FreeOffer or SubscriptionOffer. -->
        <!-- You must include at least one offer. -->

        <SubscriptionOffer>
          <!-- Required. One instance only. -->
          <Regions>
            <!-- At least one Country required. -->
            <Country>US</Country>
            <Country>CA</Country>
          </Regions>

          <!-- Optional. One instance only. -->
          <WindowStart>2013-04-19T12:00:00</WindowStart>

          <!-- Optional. One instance only. -->
          <WindowEnd>2020-04-19T00:00:00</WindowEnd>

          <!-- Optional. Multiple instances allowed for different LaunchIds. -->
          <LaunchDetails>
            <!-- Optional. Accepted values SD, HD, and UHD. Multiple instances allowed for different qualities. -->
            <Quality>HD</Quality>

            <!-- Optional. Multiple instances allowed for different audio languages. -->
            <AudioLanguage>en-US</AudioLanguage>

            <!-- Optional. Multiple instances allowed for different subtitle languages. -->
            <Subtitle>fr</Subtitle>
            <Subtitle>es</Subtitle>
            <Subtitle>ja</Subtitle>

            <!-- Optional. Only one LaunchId is allowed under each LaunchDetails element -->
            <LaunchId>TV098765_HD_en</LaunchId>
          </LaunchDetails>

          <LaunchDetails>
            <Quality>SD</Quality>
            <AudioLanguage>en-US</AudioLanguage>
            <Subtitle>fr</Subtitle>
            <Subtitle>es</Subtitle>
            <Subtitle>ja</Subtitle>
            <LaunchId>TV098765_HD_en_es</LaunchId>
          </LaunchDetails>
        </SubscriptionOffer>

        <FreeOffer>
          <!-- Required. One instance only. -->
          <Regions>
            <!-- At least one Country required. -->
            <Country>AS</Country>
            <Country>GU</Country>
            <Country>MP</Country>
            <Country>UM</Country>
          </Regions>

          <!-- Optional. One instance only. -->
          <WindowStart>2013-04-19T12:00:00</WindowStart>

          <!-- Optional. One instance only. -->
          <WindowEnd>2020-04-19T00:00:00</WindowEnd>

          <!-- Optional. Multiple instances allowed for different LaunchIds. -->
          <LaunchDetails>
            <!-- Optional. Accepted values SD, HD, and UHD. Multiple instances allowed for different qualities. -->
            <Quality>SD</Quality>

            <!-- Optional. Multiple instances allowed for different audio languages. -->
            <AudioLanguage>en-US</AudioLanguage>

            <!-- Optional. Multiple instances allowed for different subtitle languages. -->
            <Subtitle>fr</Subtitle>
            <Subtitle>es</Subtitle>
            <Subtitle>ja</Subtitle>

            <!-- Optional. Only one LaunchId is allowed under each LaunchDetails element -->
            <LaunchId>TV098765_SD_en</LaunchId>
          </LaunchDetails>

          <LaunchDetails>
            <Quality>SD</Quality>
            <AudioLanguage>en-US</AudioLanguage>
            <Subtitle>fr</Subtitle>
            <Subtitle>es</Subtitle>
            <Subtitle>ja</Subtitle>
            <LaunchId>TV098765_SD_en_es</LaunchId>
          </LaunchDetails>
        </FreeOffer>

      </Offers>

      <!-- Optional, but highly recommended. One instance only. Should match the year in the ReleaseDate element, if present. While this element is optional, we recommend that you include it. This value is used in matching this work with the same work from other providers to bundle all offers into a single search result. -->
      <ReleaseYear>2013</ReleaseYear>

      <!-- Optional. If present, the locale attribute is required. Multiple instances allowed, but only one for each locale. -->
      <ShortDescription locale="en-US">Eleven-year old Anne builds androids. Nick discovers Anne's secret lab and, with Shania, befriends Anne. Together they solve scientific problems through real-life solutions.</ShortDescription>

      <!-- Optional. If present, the locale attribute is required. Multiple instances allowed, but only one for each locale. -->
      <Synopsis locale="en-US">Eleven-year old genius and kid-scientist Anne has invented and built her own amazing androids. Nick discovers Anne's secret junkyard laboratory and enlists the help of Shania to befriend Anne and her mechanical companions. Together they help solve Anne's scientific problems through real-life solutions.</Synopsis>

      <!-- Optional, but recommended. One instance only. At least 50% of your entries must include this element and the image it points to must be valid. -->
      <Images>
        <Image>
          <Url>http://amzf.tmsimg.com/assets/28873/p28873_k_h2_aa.jpg</Url>
        </Image>
      </Images>

      <!-- Optional. One instance only. Value should be 2880 or less to avoid a warning in the ingestion report. This element is usually not used with this work type. -->
      <RuntimeMinutes>625</RuntimeMinutes>

      <!-- Optional. One instance only. Accepted values color and black_and_white. -->
      <Color>color</Color>

      <!-- Optional. One instance only. Must include at least one cast member or crew member. -->
      <Credits>
        <!-- Optional if at least one CrewMember element is present, otherwise required. Multiple instances allowed. -->
        <CastMember>
          <!-- Required, locale attribute also required. Multiple instances allowed. -->
          <Name locale="en-US">Addison Holley</Name>

          <!-- Optional. Multiple instances allowed. If present, scheme attribute is required (accepted values imdb, tms, isan, ean, and upc). -->
          <ExternalID scheme="imdb">nm3204147</ExternalID>

          <!-- Required, locale attribute also required. Multiple instances allowed. -->
          <Role locale="en-US">Anne</Role>
        </CastMember>

        <CastMember>
          <Name locale="en-US">Jadiel Dowlin</Name>
          <ExternalID scheme="imdb">nm6636855</ExternalID>
          <Role locale="en-US">Nick</Role>
        </CastMember>

        <!-- Optional if at least one CastMember element is present, otherwise required. Multiple instances allowed. -->
        <CrewMember>
          <!-- Required, locale attribute also required. Multiple instances allowed. -->
          <Name locale="en-US">J.J. Johnson</Name>

          <!-- Optional. Multiple instances allowed. If present, scheme attribute is required (accepted values imdb, tms, isan, ean, and upc). -->
          <ExternalID scheme="imdb">nm1664945</ExternalID>

          <!-- Required, locale attribute also required. Multiple instances allowed. -->
          <Job locale="en-US">Writer</Job>
          <Job locale="en-US">Director</Job>
        </CrewMember>
      </Credits>

      <!-- Optional. One instance only. -->
      <Studios>
        <!-- When present, Studios must include at least one Studio. Multiple instances allowed. -->
        <Studio>Amazon Studios</Studio>
        <Studio>Sinking Ship Entertainment</Studio>
      </Studios>

      <!-- Optional. One instance only. -->
      <Language>en</Language>

      <!-- Optional. One instance only. -->
      <CustomerRating>
        <!-- Required. One instance only. -->
        <Score>7.3</Score>

        <!-- Required. One instance only. -->
        <MaxValue>10</MaxValue>

        <!-- Optional. One instance only. -->
        <Count>135</Count>
      </CustomerRating> 

      <!-- Optional. One instance only. 1 is the top rank. -->
      <Rank>2</Rank>

      <!-- Optional. One instance only. Accepted values are original, licensed, unknown, and other. -->
      <Source>original</Source>

      <!-- Optional. One instance only. -->
      <Genres>
        <!-- When present, Genres must include at least one Genre. Multiple instances allowed. The locale attribute is required. -->
        <Genre locale="en-US">Family</Genre>
      </Genres>

      <!-- Optional. One instance only. -->
      <ContentRatings>
        <!-- When present, ContentRatings must include at least one ContentRating. Multiple instances allowed.-->
        <ContentRating>
          <!-- Required. One instance only. -->
          <System>TV Parental Guidelines</System>

          <!-- Required. One instance only. -->
          <Certification>TV-G</Certification>
        </ContentRating>
      </ContentRatings>

      <!-- Optional. One instance only. For use in Japan only. -->
      <JP_Require18PlusAgeConfirmation>false</JP_Require18PlusAgeConfirmation>

      <!-- Optional. One instance only. The year should match the value in the ReleaseYear element, if present. -->
      <ReleaseDate>2013-04-19T00:00:00</ReleaseDate>
    </TvShow>
  </Works>
</Catalog>

Catalog

The root element of a CDF file. Each catalog file must contain a single Catalog element which contains the rest of the file.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	none
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Partner` (required, one allowed) `Works` (required, one allowed)
Attributes	`xmlns`: Required. The XML namespace. `version`: Optional. The version of the schema this catalog uses. Refer to the schema "id" to figure out which schema version you are using. Although this attribute is optional for compatibility reasons, Amazon recommends that you provide the version. Data Type: Enum. Enum Values: `FireTv-v1.2`, `FireTv-v1.3`, `FireTv-v1.4`, `FireTv-v1.5`, `FireTv-v1.6`, `FireTv-v1.7`, `FireTv-v1.8`, `FireTv-v1.9`, `FireTv-v1.10`, `FireTv-v1.11`, `FireTv-v2.0`

Example:

<xml version="1.0" encoding="utf-8" ?>
<Catalog xmlns="http://www.amazon.com/FireTv/2014-04-11/ingestion" version="FireTv-v1.3">
  <Partner>Everything Ever Made Filmworks</Partner>
  <Works>
    ...
  </Works>
<Catalog>

Partner

Identifies you as the provider of this catalog. There is no required format, but it should be human-readable. As a good convention, use your app's name as it is seen in the Amazon Appstore. You might also use your full provider name. Each catalog file must contain a single Partner element.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Catalog`
Content Model	simpleType (no children)
Child Elements	None
Data Type	string

Example:

<Catalog xmlns="http://www.amazon.com/FireTv/2014-04-11/ingestion" version="FireTv-v1.3">
  <Partner>Everything Ever Made Filmworks</Partner>
  ...
<Catalog>

Works

Contains all of the individual entries in your catalog: movies, TV shows, seasons, specials, mini-series, episodes, and extras. Each catalog file must contain a single Works element. The Works element can contain as many work entries as needed, and as many of each type as needed.

Note: In CDF v1.0 to v1.2, the Works element was required to contain at least a single work. As of CDF v1.3, it can be empty. This will have the effect of removing your catalog's contents from Amazon Fire TV's universal browse and search.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Catalog`
Content Model	contentType — sequence and choice. You can optionally include any of the child elements under a `Works` element, and that child element can appear multiple times, in whatever order you want them in.
Child Elements	`Movie` (optional, unlimited) `TvEpisode` (optional, unlimited) `TvSeason` (optional, unlimited) `TvShow` (optional, unlimited) `Extra` (optional, unlimited)
Attributes	None

Example:

<Catalog>
  <Partner>Everything Ever Made Filmworks</Partner>
  <Works>
    ...
  </Works>
</Catalog>

Movie

Represents a feature-length film, but can also be used for short films. This work can be a theatrical release or a made-for-TV movie.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Works`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`ID` (required, one allowed) `ExternalID` (optional, unlimited) `Titles` (required, unlimited) `Copyright` (optional, one allowed) `Offers` (optional, one allowed) `IsAdultProducts` (optional, one allowed) `ReleaseYear` (optional, one allowed) `ShortDescriptions` (optional, one allowed) `Synopses` (optional, one allowed) `MetadataAvailabilityDates` (optional, one allowed) `Images` (required, one allowed) `Runtimes` (optional, one allowed) `Color` (optional, one allowed) `Credits` (optional, one allowed) `Studios` (optional, one allowed) `Language` (optional, one allowed) `CustomerRating` (optional, one allowed) `Rank` (optional, one allowed) `IsOriginals` (optional, one allowed) `Genres` (optional, one allowed) `ContentRatings` (optional, one allowed) `ReleaseDates` (optional, one allowed)
Attributes	None

Example:

<Movie>
    <ID>AMZN-0011</ID>
    <ExternalID scheme="imdb">tt0000008</ExternalID>
    <Titles>
        <!-- If the territories attribite is omitted, then the title is available globally, as shown below -->
        <Title locale="en-US">Global English Movie Title</Title>
        <!-- The below title is available only in the US -->
        <Title locale="es" territories="US">Spanish US Movie Title</Title>
    </Titles>
    <Copyright locale="en-US">Amazon 2021</Copyright>
    <Offers>
        <FreeOffer>
            <Regions>
                <Territories>GB, DE</Territories>
            </Regions>
            <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
            <WindowEnd>2030-01-01T07:00:00-07:00</WindowEnd>
            <LaunchDetails>
                <Quality>SD</Quality>
                <AudioLanguage>en-US</AudioLanguage>
                <Subtitle>en-US</Subtitle>
                <Subtitle>es</Subtitle>
                <LaunchId>AMZN-0011-enUS-SD</LaunchId>
            </LaunchDetails>
        </FreeOffer>
        <SubscriptionOffer>
            <Regions>
                <Territories>US, CA</Territories>
            </Regions>
            <WindowStart>2021-02-06T12:00:00-07:00</WindowStart>
            <WindowEnd>2022-01-01T07:00:00-07:00</WindowEnd>
            <LaunchDetails>
                <Quality>HD</Quality>
                <AudioLanguage>en-US</AudioLanguage>
                <Subtitle>en-US</Subtitle>
                <Subtitle>es</Subtitle>
                <LaunchId>AMZN-0011-enUS-HD</LaunchId>
            </LaunchDetails>
        </SubscriptionOffer>
    </Offers>
    <IsAdultProducts>
        <!-- if no territory is provided, then the field value is applicable worldwide. -->
        <IsAdultProduct>false</IsAdultProduct>
        <IsAdultProduct territories="IN,DE">true</IsAdultProduct>
    </IsAdultProducts>
    <ReleaseYear>1959</Releaseyear>
    <ShortDescriptions>
        <ShortDescription locale="en-US" territories="US">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</ShortDescription>
    </ShortDescriptions>
    <Synopses>
        <Synopsis locale="en-US" territories="US, GB">Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</Synopsis>
        <Synopsis locale="es" territories="MX">Nulla pellentesque dignissim enim sit amet venenatis urna cursus. Metus vulputate eu scelerisque felis imperdiet. Ullamcorper a lacus vestibulum sed. Sed ullamcorper morbi tincidunt ornare. Odio aenean sed adipiscing diam donec adipiscing tristique risus. Sed vulputate mi sit amet mauris commodo quis. Ac tortor dignissim convallis aenean et tortor at risus. Turpis tincidunt id aliquet risus feugiat in. A scelerisque purus semper eget duis at tellus at. Volutpat ac tincidunt vitae semper.</Synopsis>
        <Synopsis locale="en">Arcu odio ut sem nulla pharetra. Lobortis scelerisque fermentum dui faucibus in. Netus et malesuada fames ac turpis. Aenean sed adipiscing diam donec adipiscing. Egestas egestas fringilla phasellus faucibus scelerisque eleifend donec. Lectus magna fringilla urna porttitor rhoncus dolor purus non. Nibh ipsum consequat nisl vel pretium lectus quam id. Eu consequat ac felis donec et odio pellentesque diam. Lorem ipsum dolor sit amet consectetur adipiscing elit. Quisque egestas diam in arcu cursus. Tristique sollicitudin nibh sit amet. Eleifend quam adipiscing vitae proin sagittis nisl rhoncus mattis rhoncus.</Synopsis>
    </Synopses>
    <MetadataAvailabilityDates>
        <MetadataAvailabilityDate>2021-08-01T12:00:00Z</MetadataAvailabilityDate>
        <MetadataAvailabilityDate territories="US,CA,GB">2021-09-01T12:00:00Z</MetadataAvailabilityDate>
    </MetadataAvailabilityDates>
    ...
    ...
</Movie>

TvEpisode

A single episode of a TvShow, normally also associated with a TvSeason.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Works`
Content Model	complexType – sequence with some choice. Must contain required child elements in specified order. However, either `ShowID` or `ShowTitle`, but not both. Also, either `SeasonID` or `SeasonInShow`, but not both.
Child Elements	`ID` (required, one allowed) `ExternalID` (optional, unlimited) `Titles` (required, unlimited) `Copyright` (optional, one allowed) `Offers` (optional, one allowed) `IsAdultProducts` (optional, one allowed) `ReleaseYear` (optional, one allowed) `ShortDescriptions` (optional, one allowed) `Synopses` (optional, one allowed) `MetadataAvailabilityDates` (optional, one allowed) `Images` (required, one allowed) `Runtimes` (optional, one allowed) `Color` (optional, one allowed) `Credits` (optional, one allowed) `Studios` (optional, one allowed) `Language` (optional, one allowed) `CustomerRating` (optional, one allowed) `Rank` (optional, one allowed) `IsOriginals` (optional, one allowed) `Genres` (optional, one allowed) `ContentRatings` (optional, one allowed) `ShowID` (required, one allowed) `ShowTitle` (required, one allowed) `SeasonID` (required, one allowed) `SeasonInShow` (required, one allowed) `SeasonTitle` (optional, one allowed) `EpisodeInSeason` (required, one allowed) `OriginalAirDates` (optional, one allowed)
Attributes	None

Example:

<TvShow>
  <ID>ABC-123457</ID>
  ...
</TvShow>
<TvSeason>
  <ID>TVS-987654</ID>
  ...
</TvSeason>
<TvEpisode>
  <ID>TVE2329880</ID>
  ...
  <ShowID>ABC-123457</ShowID>
  <SeasonID>TVS-987654</SeasonInShow>
  <EpisodeInSeason>5</EpisodeInSeason>
</TvEpisode>

TvSeason

One of the basic work types, a TvSeason is a single season of a TvShow. When the SeasonID of a TvEpisode has the same value as the ID of a TvSeason, that episode declares itself part of the season.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Works`
Content Model	complexType – sequence with some choice. Must contain required child elements in specified order. However, either `ShowID` or `ShowTitle`, but not both.
Child Elements	`ID` (required, one allowed) `ExternalID` (optional, unlimited) `Titles` (required, unlimited) `Copyright` (optional, one allowed) `Offers` (optional, one allowed) `IsAdultProducts` (optional, one allowed) `ReleaseYear` (optional, one allowed) `ShortDescriptions` (optional, one allowed) `Synopses` (optional, one allowed) `MetadataAvailabilityDates` (optional, one allowed) `Images` (required, one allowed) `Runtimes` (optional, one allowed) `Color` (optional, one allowed) `Credits` (optional, one allowed) `Studios` (optional, one allowed) `Language` (optional, one allowed) `CustomerRating` (optional, one allowed) `Rank` (optional, one allowed) `IsOriginals` (optional, one allowed) `Genres` (optional, one allowed) `ContentRatings` (optional, one allowed) `ShowID` (required, one allowed) `ShowTitle` (required, one allowed) `SeasonInShow` (required, one allowed)
Attributes	None

Example:

<TvShow>
  <ID>ABC-123457</ID>
  ...
</TvShow>
<TvSeason>
  <ID>TVS2329880</ID>
  <ShowID>ABC-123457</ShowID>
  <SeasonInShow>5</SeasonInShow>
</TvSeason>
<TvEpisode>
  ...
  <ShowID>ABC-123457</ShowID>
  <SeasonID>TVS2329880</SeasonID>
  ...
</TvEpisode>

TvShow

A televised series made up of seasons and episodes. When the ShowID of a TvSeason or a TvEpisode has the same value as the ID of a TvShow, that season or episode declares itself part of the show.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Works`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`ID` (required, one allowed) `ExternalID` (optional, unlimited) `Titles` (required, unlimited) `Copyright` (optional, one allowed) `Offers` (optional, one allowed) `IsAdultProducts` (optional, one allowed) `ReleaseYear` (optional, one allowed) `ShortDescriptions` (optional, one allowed) `Synopses` (optional, one allowed) `MetadataAvailabilityDates` (optional, one allowed) `Images` (required, one allowed) `Runtimes` (optional, one allowed) `Color` (optional, one allowed) `Credits` (optional, one allowed) `Studios` (optional, one allowed) `Language` (optional, one allowed) `CustomerRating` (optional, one allowed) `Rank` (optional, one allowed) `IsOriginals` (optional, one allowed) `Genres` (optional, one allowed) `ContentRatings` (optional, one allowed) `ReleaseDates` (optional, one allowed)
Attributes	None

Example:

<TvShow>
  <ID>RS-2329880</ID>
  ...
</TvShow>
<TvSeason>
  <ID>TVS2329880</ID>
  ...
  <ShowID>RS-2329880</ShowID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <ShowID>RS-2329880</ShowID>
  <SeasonID>TVS2329880</SeasonID>
  ...
</TvEpisode>

Extra

A clip that can be a standalone work or, more commonly, can be associated with another work (either external or in your catalog). Generally think of these as the equivalent of an extra feature included on a DVD.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Works`
Content Model	complexType – sequence with some choice. Must contain required child elements in specified order. However, either `RelatesToID` or `RelatesToExternalID`, but not both.
Child Elements	`ID` (required, one allowed) `ExternalID` (optional, unlimited) `Titles` (required, unlimited) `Copyright` (optional, one allowed) `Offers` (optional, one allowed) `IsAdultProducts` (optional, one allowed) `ReleaseYear` (optional, one allowed) `ShortDescriptions` (optional, one allowed) `Synopses` (optional, one allowed) `MetadataAvailabilityDates` (optional, one allowed) `Images` (required, one allowed) `Runtimes` (optional, one allowed) `Color` (optional, one allowed) `Credits` (optional, one allowed) `Studios` (optional, one allowed) `Language` (optional, one allowed) `CustomerRating` (optional, one allowed) `Rank` (optional, one allowed) `IsOriginals` (optional, one allowed) `Genres` (optional, one allowed) `ContentRatings` (optional, one allowed) `Type` (required, one allowed) `RelatesToID` (required, unlimited) `RelatesToExternalID` (required, unlimited)
Attributes	None

Example:

<Extra>
  <ID>EXTRA-11111</ID>
  ...
  <Type>clip</Type>
</Extra>

An identifier string for a work. This value must be at least one character long and must be unique among all other IDs in your catalog. Two works with the same ID will cause your catalog to be rejected by the ingestion system. Devise an ID scheme and use it unfailingly to avoid duplicate IDs. For instance, you could use your Partner ID + the work type + a long identifier such as a GUID, for an ID such as AmazonStudios_ Movie_01152ce2-de7e-44c1-9736-e8f3b15a1ddf. Any scheme that assures unique IDs within your catalog is valid.

Two things to keep in mind when constructing IDs:

When you update an existing catalog, the IDs for your works should not change. If an ID disappears from your catalog, we assume that work is no longer available on your service and it is removed from our index. If it returns later, it should have the same ID as before. If you change ID schemes after ingestion, it can negatively affect the customer experience.
IDs should only contain the following characters: . , -, +, 0-9, A-Z, a-z. If you wish to launch your app with a URI, use LaunchID inside of a LaunchDetails block (a property of offers).

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	simpleType (no children)
Child Elements	None
Data Type	NonEmptyToken

Example:

<Movie>
  <ID>AmazonStudios_Movie_01152ce2-de7e-44c1-9736-e8f3b15a1ddf</ID>
  ...
</Movie>

ExternalID

An identifier for a work under an external classification, such as IMDb. This value is used in content matching, to compare a work or person against that in another catalog to determine whether they're the same work or person. It can also be used as the source of external content such as images. Each element that contains an ExternalID can contain as many as needed.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`CastMember` `CrewMember` `Extra` `Movie` `TvEpisode` `TvSeason` `TvShow`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`scheme`: Required. The external source that provided this ID. Data Type: Enum. Enum Values: `imdb`: The Internet Movie Database (IMDb). IDs can be found as part of the URL of a given page. `tms`: An OnTV domain — used to be Tribune Media Service, but it is essentially one of the older Gracenote ID spaces. `isan`: The International Standard Audiovisual Number (ISAN), an alphanumeric strings of 26 characters, usually presented broken by dashes. `ean`: The European Article Number (EAN) is a barcode standard, a 12- or 13-digit product identification code. Each EAN uniquely identifies the product, manufacturer, and its attributes. `upc`: Universal Product Code (UPC) is a 12-digit bar code used extensively for retail packaging in United States. `asin`: Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. `gvd`: Gracenote Video Data — the Gracenote ID provides "unique identifiers for TV programs and movies [to] enable linking to TV schedule data and on-demand catalogs". `region`: Optional. Region for which the `externalId` is relevant, such as marketplace for Amazon ASINS or country for a TMS ID. For example, `US` for a TMS scheme. Data Type: string

Example:

<Movie>
  <ID>MV123456</ID>
  <ExternalID scheme="imdb">tt0000000</ExternalID>
  <ExternalID scheme="tms">MV000000000000</ExternalID>
  <ExternalID scheme="isan">0000-0000-0F00-0000-X-0000-0000-Y</ExternalID>
  <ExternalID scheme="ean">0011559514120</ExternalID>
  <ExternalID scheme="upc">123456789990</ExternalID>
  ...
</Movie>

Titles

Contains a work's title. Each work can contain one Titles element.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	simpleType (no children)
Child Elements	`Title` (required, unlimited)
Data Type	Localized string

Example:

<TvShow>
  <ID>TV123456</ID>
  <Titles>
    ...
  </Titles>
  ...
</TvShow>

Title

A work's title. Each work can contain multiple Title elements for the purpose of providing localized titles.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`Titles`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string `territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.
Data Type	TerritoryStringType - Same as string with the addition of the `locale`, `pronunciation`, and `territories` attributes.

Example:

<TvShow>
  <ID>TV123456</ID>
  <Titles>
    <!-- If the territories attribite is omitted, then the title is available globally, as shown below -->
    <Title locale="en-US">Global English Movie Title</Title>
    <!-- The below title is available only in the US -->
    <Title locale="es" territories="US">Spanish US Movie Title</Title>
  </Titles>
  ...
</TvShow>

A statement of the work's copyright.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string
Data Type	Localized string

Example:

<Copyright locale="en-US">© 2014 Amazon Studios</Copyright>

Offers

Contains the offers through which a viewer can play a given work: for free, by having a subscription to the service, through rental, or through purchase. Each work type can contain only one Offers element, and that Offers element must contain at least one offer type.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – choice. Either one child element or another required, but not both.
Child Elements	`SubscriptionOffer` (required, one allowed) `FreeOffer` (required, one allowed)
Attributes	None

Example:

<Offers>
  <FreeOffer>
    <Regions>
      <Territories>US, PR, VI, GB, DE</Territories>
    </Regions>
    <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
    <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
    <LaunchDetails>
      <Quality>SD</Quality>
    </LaunchDetails>
  </FreeOffer>
  <SubscriptionOffer>
    <Regions>
      <Territories>CA</Territories>
    </Regions>
    <LaunchDetails>
      <Quality>HD</Quality>
    </LaunchDetails>
  </SubscriptionOffer>
</Offers>

SubscriptionOffer

The work can be watched by subscribers to the provider's service. If necessary, you can have multiple SubscriptionOffer elements under Offers. SubscriptionOffer is one of the two offer types. Important: The SubscriptionOffer element is optional, but at least one offer type is required under Offers.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Offers`
Content Model	complexType – sequence with some choice. Must contain required child elements in specified order.
Child Elements	`Regions` (required, unlimited) `LaunchDetails` (optional, unlimited) `WindowStart` (optional, one allowed) `WindowEnd` (optional, one allowed)
Attributes	None

Example:

<SubscriptionOffer>
  <Regions>
    <Territories>US, CA</Territories>
  </Regions>
  <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
  <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
    <LaunchId>EXTRA-11113_HD_en-US</LaunchId>
  </LaunchDetails>
</SubscriptionOffer>

Regions

Contains the countries in which a given offer is available. Each offer type can contain only a single Regions element.

⚠Important! After Aug 31, 2021, "US" in this field will no longer include the US Territories. In order to include offers in these territories, explicitly add the region. See Example below for implementation.

US territory codes for reference:
USVI = VI, Guam = GU, Puerto Rico = PR, Mariana Islands = MP.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`SubscriptionOffer` `FreeOffer`
Content Model	complexType – choice. Either one child element or another required, but not both.
Child Elements	`Territories` (required, one allowed)
Attributes	None

Example:

<FreeOffer>
  <Regions>
    <Territories>US, PR, VI, GB, DE, AT</Territories>
  </Regions>
  ...
</FreeOffer>

Territories

A comma separated list of countries, regions, or territories in which a particular offer is available.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Regions`
Content Model	simpleType (no children)
Child Elements	None
Data Type	TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.

Example:

<SubscriptionOffer>
  <Regions>
    <Territories>US, PR, VI, GB, DE, AT</Territories>
  </Regions>
  ...
</SubscriptionOffer>

WindowStart

The date and time after which the work becomes available under a particular offer. Using WindowStart and WindowEnd, you can declare an offer to be available only for a specific window of time. Before and after that window, that offer is not shown to the viewer. If no offer is available at the time, the work itself is not shown to the viewer. Each offer can have only one WindowStart.

WindowStart and WindowEnd can be used together or separately to control a work's availablility under an offer.

WindowStart only: The work is available indefinitely from that time forward unless it is removed from the catalog.
WindowEnd only: The work is available immediately, but only until that time.
WindowStart + WindowsEnd: The work is available only in that window of time.
Neither WindowStart nor WindowEnd: The work is immediately available and always will be unless it is removed from the catalog.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`SubscriptionOffer` `FreeOffer`
Content Model	simpleType (no children)
Child Elements	None
Data Type	dateTime

Example:

<FreeOffer>
  ...
  <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
  <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
  ...
</FreeOffer>

WindowEnd

The date and time after which the work will no longer be available under a particular offer. Each offer can have only one WindowEnd. Using WindowStart and WindowEnd, you can declare an offer to be available only for a specific window of time. After the time specified by WindowEnd, the offer is no longer presented to the viewer. If all offers have expired, the work itself is not shown to the viewer.

WindowStart and WindowEnd can be used together or separately to control a work's availablility under an offer.

WindowStart only: The work is available indefinitely from that time forward unless it is removed from the catalog.
WindowEnd only: The work is available immediately, but only until that time.
WindowStart + WindowsEnd: The work is available only in that window of time.
Neither WindowStart nor WindowEnd: The work is immediately available and always will be unless it is removed from the catalog.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`SubscriptionOffer` `FreeOffer`
Content Model	simpleType (no children)
Child Elements	None
Data Type	dateTime

Example:

<FreeOffer>
  ...
  <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
  <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
  ...
</FreeOffer>

LaunchDetails

Contains elements that specify a work's available video quality, audio language, and subtitle options under a particular offer. LaunchDetails also contains an optional LaunchId which allows a direct launch of the work in a specific configuration of quality, language, and subtitle.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`SubscriptionOffer` `FreeOffer`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Quality` (optional, unlimited) `AudioLanguage` (optional, unlimited) `Subtitle` (optional, unlimited) `LaunchId` (optional, one allowed)
Attributes	None

Example:

<FreeOffer>
  <Regions>
    <Territories>US, CA</Territories>
  </Regions>
  <LaunchDetails>
    <Quality>SD</Quality>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <AudioLanguage>fr-FR</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
    <LaunchId>EXTRA-11113_HD_en-US</LaunchId>
  </LaunchDetails>
</FreeOffer>

Quality

The visual quality of the work: standard definition (SD), high definition (HD), and ultra high definition (UHD). A work can be offered with multiple visual quality options.

Note: There are two elements named Quality. The first, a direct child of each offer type, was deprecated in CDF v1.2. The second is a child of LaunchDetails, and therefore a grandchild of each offer type. This newer, non-deprecated Quality element is the one we discuss here, although other than their parent elements, the two are identical in form and content.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`LaunchDetails`
Content Model	simpleType (no children)
Child Elements	None
Data Type	Enum: `SD`, `HD`, `UHD`

Example:

<FreeOffer>
  ...
  <LaunchDetails>
    <Quality>HD</Quality>
    <Quality>UHD</Quality>
    <Quality>SD</Quality>
  </LaunchDetails>
  ...
</FreeOffer>

AudioLanguage

An audio option for the work when that work has been dubbed into additional languages. You can include as many AudioLanguage elements as needed to specify the work's available alternatives. AudioLanguage is optional but strongly recommended for dubbed content. AudioLanguage ensures your content displays the correct subtitle languages.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`LaunchDetails`
Content Model	simpleType (no children)
Child Elements	None
Data Type	language

Example:

<LaunchDetails>
  <Quality>SD</Quality>
  <Quality>HD</Quality>
  <AudioLanguage>en-US</AudioLanguage>
  <AudioLanguage>es-MX</AudioLanguage>
  <Subtitle>en-US</Subtitle>
  <Subtitle>es-MX</Subtitle>
  <LaunchId>MV123456_HD_es-MX_en</LaunchId>
</LaunchDetails>

Subtitle

A language option for the work's subtitles. A work can have multiple subtitle options.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`LaunchDetails`
Content Model	simpleType (no children)
Child Elements	None
Data Type	language

Example:

<SubscriptionOffer>
  ...
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
  </LaunchDetails>
</SubscriptionOffer>

LaunchId

An identifier that allows you to launch a work with a specific configuration of video quality, audio language, and subtitles (or any subset of those three). A LaunchId does not have a given format — the format must only be understood by your app's logic. Each LaunchDetails element can contain only a single LaunchId, so to specify more than one LaunchId, you must include multiple LaunchDetails elements.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`LaunchDetails`
Content Model	simpleType (no children)
Child Elements	None
Data Type	token

Example:

<SubscriptionOffer>
  ...
  <LaunchDetails>
    <Quality>SD</Quality>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <AudioLanguage>fr-FR</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <LaunchId>EXTRA-11113_HD_en-US</LaunchId>
  </LaunchDetails>
  <LaunchDetails>
    <Quality>SD</Quality>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <AudioLanguage>fr-FR</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <LaunchId>EXTRA-11113_SD_fr-FR_en-US</LaunchId>
  </LaunchDetails>
</SubscriptionOffer>

Property	Detail
Use
How Many Allowed
Parent Elements
Content Model
Child Elements
Attributes
Data Type

FreeOffer

The work is free to view at any time, or optionally is free only during a given window. If necessary, you can have multiple FreeOffer elements under Offers. Important: The FreeOffer element is optional, but at least one offer type is required under Offers. FreeOffer is one of the two offer types.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Offers`
Content Model	complexType – sequence with some choice. Must contain required child elements in specified order.
Child Elements	`Regions` (required, unlimited) `LaunchDetails` (optional, unlimited) `WindowStart` (optional, one allowed) `WindowEnd` (optional, one allowed)
Attributes	None

Example:

<FreeOffer>
  <Regions>
    <Territories>US, GB, DE</Territories>
  </Regions>
  <WindowStart>2014-02-06T12:00:00-07:00</WindowStart>
  <WindowEnd>2016-01-01T07:00:00-07:00</WindowEnd>
  <LaunchDetails>
    <Quality>HD</Quality>
    <AudioLanguage>en-US</AudioLanguage>
    <Subtitle>en-US</Subtitle>
    <Subtitle>fr</Subtitle>
    <Subtitle>es</Subtitle>
    <LaunchId>EXTRA-11113_HD_en-US</LaunchId>
  </LaunchDetails>
</FreeOffer>

IsAdultProducts

Contains identification of a work as content for adult audiences only.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`IsAdultProduct` (required, unlimited)
Attributes	None

Example:

<IsAdultProducts>
  <!-- if no territory is provided, then the field value is applicable worldwide. -->
  <IsAdultProduct>false</IsAdultProduct>
  <IsAdultProduct territories="IN,DE">true</IsAdultProduct>
</IsAdultProducts>

IsAdultProduct

Identifies a work as content for adult audiences only.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`IsAdultProducts`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.
Data Type	TerritoryBooleanType - Same as boolean with the addition of the `territories` attribute.

Example:

<IsAdultProducts>
  <!-- if no territory is provided, then the field value is applicable worldwide. -->
  <IsAdultProduct>false</IsAdultProduct>
  <IsAdultProduct territories="IN,DE">true</IsAdultProduct>
</IsAdultProducts>

ReleaseYear

Optional, but highly recommended. The year in which the work was originally released to the public, or the first air date in the case of television. Note that this value should match the year given in the same work's ReleaseDate or OriginalAirDate element.

Note: While this element is optional, Amazon recommends that you include it. This value is particularly helpful for allowing this work to be matched with the same work from other providers, which improves the customer search experience by bundling all offers for the work into a single search result. That, in turn, improves the discoverability of your particular offer.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	simpleType (no children)
Child Elements	None
Data Type	int

Example:

<TvEpisode>
  ...
  <ReleaseYear>1959</ReleaseYear>
  ...
</TvEpisode>

ShortDescriptions

A two- or three-line description of a work's content for locales and territories.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`ShortDescription` (required, unlimited)
Attributes	None

Example:

<Movie>
  ...
  <ShortDescriptions>
    ...
  </ShortDescriptions>
  ...
</Movie>

ShortDescription

Contains a two- or three-line description of a work's content. Do not use information included elsewhere, such as the work's title, for the ShortDescription. Each work can contain multiple ShortDescription elements for the purpose of providing localized descriptions. To provide a longer, more detailed description, use the Synopsis element.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`ShortDescriptions`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string `territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.
Data Type	TerritoryStringType - Same as string with the addition of the `locale`, `pronunciation`, and `territories` attributes.

Example:

<Movie>
...
  <ShortDescriptions>
    <ShortDescription locale="en-US" territories="US">Alan shows us some trees and sings songs about them.</ShortDescription>
  </ShortDescriptions>
...
</Movie>

Synopses

Contains a full description of the content varying by locale and territory.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Synopsis` (required, unlimited)
Attributes	None

Example:

<Movie>
...
  <Synopses>
    ...
  </Synopses>
...
</Movie>

Synopsis

A description of a work's content. Synopsis is intended to give more detail than ShortDescription. Do not use the ShortDescription or the work's Title as the Synopsis. Each work can contain multiple Synopsis elements for the purpose of providing localized descriptions.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`Synopses`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string
Data Type	TerritoryStringType - Same as string with the addition of the `locale`, `pronunciation`, and `territories` attributes.

Example:

<Movie>
...
  <Synopses>
    <Synopsis locale="en-US" territories="US, CA">Alan Smithee, man about town and fervent urban arborist, takes us on a musical journey around his home town, stopping by some favorite trees to sing about them. As expected from Mr. Smithee, no path runs straight and his plans meander as he encounters guest stars and battles a lumberjack with a literal ax to grind.</Synopsis>
  </Synopses>
...
</Movie>

MetadataAvailabilityDates

Contains MetadataAvailabilityDate that vary by territories. Any field without a territory value is assumed to be applicable worldwide.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`MetadataAvailabilityDate` (required, one allowed)
Attributes	None

Example:

<Movie>
  <ID>MV-123456</ID>
  ...
  <MetadataAvailabilityDates>
    ...
  </MetadataAvailabilityDates>
  ...
</Movie>

MetadataAvailabilityDate

Date after which metadata information should be available to viewers. Including this information improves matching. Note that MetadataAvailabilityDate is the same as WindowStart; however, in addition to hiding the Play button, including MetadataAvailabilityDate hides the metadata associated with the content until the date indicated. Combining MetadataAvailabilityDate with WindowStart will show information at the time of premiere (for example, The Man in the High Castle premiere).

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`MetadataAvailabilityDates`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.
Data Type	TerritoryDateTimeType - Same as dateTime with the addition of the `territories` attribute.

Example:

<Movie>
  <ID>MV-123456</ID>
  ...
  <MetadataAvailabilityDates>
    // Movie available in US, CA and GB on Sep 1, while rest of the territories
    // on Sep 15
    <MetadataAvailabilityDate>2021-09-15T12:00:00Z</MetadataAvailabilityDate>
    <MetadataAvailabilityDate territories="US,CA,GB">2021-09-01T12:00:00Z</MetadataAvailabilityDate>
  </MetadataAvailabilityDates>
  ...
</Movie>

Images

Images to represent the TV or movie content. See Image for image size details.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Image` (required, unlimited)
Attributes	None

Example:

<Movie>
  ...
  <Images>
    <Image>
      ...
    </Image>
  </Images>
  ...
 </Movie>

Image

An image to represent the TV or movie content. Images should be in JPG or PNG format (JPG preferred). Use a 16:9 aspect ratio, with dimensions at least 853px wide x 480px high for TV shows/seasons/episodes. Larger sizes are better (1920px wide x 1080px high is ideal); Amazon will scale images as needed. Images smaller than 853px wide x 480px, or images following other aspect ratios, will not be used. In those cases, another image source (for example, IMDb) or a placeholder image will be used instead.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`Images`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Url` (required, one allowed) `Locale` (optional, unlimited)
Attributes	`territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.

Example:

<Movie>
  ...
    <Images>
      <Image territories="VI,GU,PR,GB">
        <Url>http://amzf.tmsimg.com/assets/28873/p28873_k_h2_aa.jpg</Url>
        <Locale>en</Locale>
      </Image>
      <Image territories="US">
        <Url>http://amzf.tmsimg.com/assets/28873/p28873_k_h2_haa.jpg</Url>
        <Locale>en</Locale>
      </Image>
    </Images>
  ...
</Movie>

Url

A URL for the image. See Image for details on image size and dimensions.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Image`
Content Model	simpleType (no children)
Child Elements	None
Data Type	anyURI

Example:

<Movie>
  ...
    <Images>
      <Image>
        <Url>http://sample-server.net/cds/1.0/image/B23R/FJK8/9FAR/39RTE_992.png</Url>
        <Locale>es</Locale>
      </Image>
    </Images>
    ...
  </Movie>

Locale

The language for the image. See Image for details on image size and dimensions.

Note: If you are providing data for different locales, we strongly encourage you to include this element. Adding the locale element ensures your content is matched correctly across languages and regions.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Image`
Content Model	simpleType (no children)
Child Elements	None
Data Type	language

Example:

<Image>
   <Url>http://sample-server.net/cds/1.0/image/B23R/FJK8/9FAR/39RTE_992.png</Url>
   <Locale>es</Locale>
</Image>

Runtimes

Contains overall running time of the content varying by locale and territory.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`RuntimeMinutes` (required, unlimited)
Attributes	None

Example:

<TvEpisode>
  ...
  <Runtimes>
    <RuntimeMinutes territories="VI,GU,PR,GB">37</RuntimeMinutes>
    <RuntimeMinutes territories="US">46</RuntimeMinutes>
  </Runtimes>
  ...
</TvEpisode>

RuntimeMinutes

The overall running time of the content, in minutes. This is a non-negative number and is expected to be less than 2880, though there may be instances that legitimately exceed that value.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`Runtimes`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.
Data Type	TerritoryInteger - Same as int with the addition of the `territories` attribute.

Example:

<TvEpisode>
  ...
  <Runtimes>
    <RuntimeMinutes territories="VI,GU,PR,GB">37</RuntimeMinutes>
    <RuntimeMinutes territories="US">46</RuntimeMinutes>
  </Runtimes>
  ...
</TvEpisode>

Color

Specifies whether the movie is primarily in color or in black-and-white.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	simpleType (no children)
Child Elements	None
Data Type	Enum: `color`, `black_and_white`

Example:

<Movie>
  ...
  <Color>black_and_white</Color>
  ...
</Movie>

Credits

Contains elements that represent a work's cast and crew members. The same person can appear as both cast or crew multiple times. Each work can contain only one Credits element. If present, Credits must contain at least one CastMember or CrewMember, though it can contain as many of each of those elements as needed.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – choice. Either one child element or another required, but not both.
Child Elements	`CastMember` (required, one allowed) `CrewMember` (required, one allowed)
Attributes	None

Example:

<Credits>
  <CastMember>
    <Name locale="en-US">Alan Smithee</Name>
    <Role locale="en-US">Self</Role>
  </CastMember>
</Credits>

CastMember

Provides information about a person in the work's cast, such as an actor, host, narrator, or voice talent. When present, the optional Credits element must include at least one entry, either a CastMember or a CrewMember. You can include as many CastMember elements as needed.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`Credits`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Name` (required, unlimited) `ExternalID` (optional, unlimited) `Role` (optional, unlimited)
Attributes	None

Example:

<Credits>
  <CastMember>
    <Name locale="en-US">Alan Smithee</Name>
    <ExternalID scheme="imdb">tt0000000</ExternalID>
    <Role locale="en-US">Self</Role>
  </CastMember>
</Credits>

Name

Relates to works. The name of a work's cast or crew member. For a cast member, this is the person's name and not their character's name.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`CastMember` `CrewMember`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string
Data Type	Localized string

Example:

<CastMember>
  <Name locale="en-US">Alan Smithee</Name>
  ...
</CastMember>

ExternalID

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`CastMember` `CrewMember` `Extra` `Movie` `TvEpisode` `TvSeason` `TvShow`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`scheme`: Required. The external source that provided this ID. Data Type: Enum. Enum Values: `imdb`: The Internet Movie Database (IMDb). IDs can be found as part of the URL of a given page. `tms`: An OnTV domain — used to be Tribune Media Service, but it is essentially one of the older Gracenote ID spaces. `isan`: The International Standard Audiovisual Number (ISAN), an alphanumeric strings of 26 characters, usually presented broken by dashes. `ean`: The European Article Number (EAN) is a barcode standard, a 12- or 13-digit product identification code. Each EAN uniquely identifies the product, manufacturer, and its attributes. `upc`: Universal Product Code (UPC) is a 12-digit bar code used extensively for retail packaging in United States. `asin`: Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. `gvd`: Gracenote Video Data — the Gracenote ID provides "unique identifiers for TV programs and movies [to] enable linking to TV schedule data and on-demand catalogs". `region`: Optional. Region for which the `externalId` is relevant, such as marketplace for Amazon ASINS or country for a TMS ID. For example, `US` for a TMS scheme. Data Type: string

Example:

<Movie>
  <ID>MV123456</ID>
  <ExternalID scheme="imdb">tt0000000</ExternalID>
  <ExternalID scheme="tms">MV000000000000</ExternalID>
  <ExternalID scheme="isan">0000-0000-0F00-0000-X-0000-0000-Y</ExternalID>
  <ExternalID scheme="ean">0011559514120</ExternalID>
  <ExternalID scheme="upc">123456789990</ExternalID>
  ...
</Movie>

Role

The character's name in a work, as played by a CastMember. Examples are Robin Hood, Sir Lancelot du Lac, Athena, or Self. Do not use "actor" (all CastMember entries are actors) or "unknown" for this value. A CastMember element can contain multiple Role elements if that person played multiple roles.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`CastMember`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string `locale`: Required. The device or software's language setting under which to use this string. Data Type: language
Data Type	Localized string

Example:

<Credits>
  <CastMember>
    <Name locale="en-US">Alan Smithee</Name>
    <ExternalID scheme="imdb">tt0000000</ExternalID>
    <Role locale="en-US">Robin Hood</Role>
    <Role locale="en-US">Self</Role>
  </CastMember>
</Credits>

CrewMember

Contains elements that provide information about a person in the work's off-screen crew, such as a director, writer, cinematographer, best boy, animator, or grip. When present, the optional Credits must include at least one entry, either a CastMember or a CrewMember. You can include as many CrewMember elements as needed.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Credits`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Name` (required, unlimited) `ExternalID` (optional, unlimited) `Job` (required, unlimited)
Attributes	None

Example:

<Credits>
  <CrewMember>
    <Name locale="en-US">Alan Smithee</Name>
    <ExternalID scheme="imdb">tt0000000</ExternalID>
    <Job locale="en-US">Director</Job>
  </CrewMember>
</Credits>

Job

The position held by a work's CrewMember, such as director, cinematographer, writer, or animator. A CrewMember can have as many Job elements as needed.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`CrewMember`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string
Data Type	Localized string

Example:

<CrewMember>
  <Name locale="en-US">Alan Smithee</Name>
  <ExternalID scheme="imdb">tt0000000</ExternalID>
  <Job locale="en-US">Grip</Job>
</CrewMember>

Studios

Contains one or more Studio elements that identify the studio(s) that produced the work.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `TvSpecial` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Studio` (optional, unlimited)
Attributes	None

Example:

<TvEpisode>
  ...
  <Studios>
    <Studio>Amazon Studios</Studio>
    <Studio>Another Production Company</Studio>
  </Studios>
  ...
</TvEpisode>

Studio

The studio that produced the work. A work can have multiple Studio entries.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`Studios`
Content Model	simpleType (no children)
Child Elements	None
Data Type	string

Example:

<TvEpisode>
  ...
  <Studios>
    <Studio>Amazon Studios</Studio>
    <Studio>Another Production Company</Studio>
  </Studios>
  ...
</TvEpisode>

Language

The language in which the work was originally produced, which can refer to either the audio or, in the case of a silent work, on-screen text. A work can contain only one Language element. Also use AudioLanguage to specify any dubbed options. While it is possible to submit your catalog without a language, it's strongly recommended to add the content's language as a best practice, particularly if you have content available in multiple languages. You need to specify the language for each version of your content to ensure Amazon matches your content to the correct language.

If you want to provide your content in multiple regions with different languages, you need to provide localized content in the respective language. For example, if you want to provide an English film in Japan, you need to provide a Japanese version of the film.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	simpleType (no children)
Child Elements	None
Data Type	language

Example:

<Movie>
  ...
  <Language>ja</Language>
  ...
</Movie>

CustomerRating

Contains elements that provide the average customer rating for a work, the maximum rating value, and the number of ratings that contributed to the score. Each work can contain only one CustomerRating element.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Score` (required, one allowed) `MaxValue` (required, one allowed) `Count` (optional, one allowed)
Child Elements Notes	`Count` is only available in CDF v1.2 and later.
Attributes	None

Example:

<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>

Score

An average score (rating) for a work based on customer feedback. How you gather that information is up to you, as well as setting the MaxValue to give a scale to the rating system. You can add an optional Count of how many votes contributed to the Score. A CustomerRating can contain only a single Score.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`CustomerRating`
Content Model	simpleType (no children)
Child Elements	None
Data Type	decimal (positive value)

Example:

<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>

MaxValue

The highest possible value for a work's customer rating. Each CustomerRating can contain only one MaxValue.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	simpleType (no children)
Child Elements	None
Data Type	decimal (positive value)

Example:

<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>

Count

The number of users that have contributed to a customer rating Score. Only one Count is allowed per CustomerRating.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`CustomerRating`
Content Model	simpleType (no children)
Child Elements	None
Data Type	Non-negative long

Example:

<CustomerRating>
  <Score>8.2</Score>
  <MaxValue>10</MaxValue>
  <Count>512</Count>
</CustomerRating>

Rank

A numerical popularity score relative to the other items in your catalog. The highest rank is defined as 1. How you determine the rankings is up to you, but it is acceptable for multiple items to have the same rank. A work can have only a single Rank element.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	simpleType (no children)
Child Elements	None
Data Type	int

Example:

<TvShow>
  ...
  <Rank>36</Rank>
  ...
</TvShow>

IsOriginals

Contains whether the item is a provider original. Content originality can vary for different countries and territories. For example, a movie could be a Prime Video original worldwide except for Japan and Canada. This element allows you to indicate which territories have a different originality from the worldwide setting.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`IsOriginal` (required, unlimited)
Attributes	None

Example:

<IsOriginals>
  <!-- For worldwide originality of an item, use the IsOriginal child element without the territories attribute. -->
  <IsOriginal>true</IsOriginal>
  <!-- If the same content shouldn't be a provider original in US and CA, then add the additional element, below  -->
  <IsOrignal territories="US,CA">false</IsOrignal>
</IsOriginals>

IsOriginal

Describes whether the item is a provider original. Content originality can vary for different countries and territories. For example, a movie could be a Prime Video original worldwide except for Japan and Canada. This element allows you to indicate which territories have a different originality from the worldwide setting.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`IsOriginals`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.
Data Type	TerritoryBooleanType - Same as boolean with the addition of the `territories` attribute.

Example:

<IsOriginals>
  <!-- For worldwide originality of an item, use the IsOriginal child element without the territories attribute. -->
  <IsOriginal>true</IsOriginal>
  <!-- If the same content shouldn't be a provider original in US and CA, then add the additional element, below  -->
  <IsOrignal territories="US,CA">false</IsOrignal>
</IsOriginals>

Genres

Contains one or more Genre tags used to describe the category of the work, such as comedy, horror, or documentary.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`Genre` (required, unlimited)
Attributes	None

Example:

<Genres>
  <Genre locale="en-US">horror</Genre>
  <Genre locale="en-US">sci-fi</Genre>
</Genres>

Genre

The genre of the work, such as comedy, horror, drama, or documentary. A work can be described through multiple Genre elements if necessary. For optimized search and matching, attempt to use standard genre descriptions. Use multiple Genre tags rather than combine several descriptions into a single string.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`Movie`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string
Data Type	Localized string

Example:

<Genres>
  <Genre locale="en-US">horror</Genre>
  <Genre locale="en-US">sci-fi</Genre>
</Genres>

ContentRatings

Contains one or more official ratings for the work, as determined by a specified certifying agency. Only one ContentRatings element is allowed per work.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow` `TvSeason` `TvEpisode` `Extra`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`ContentRating` (required, unlimited)
Attributes	None

Example:

<ContentRatings>
  <ContentRating territories="US,PR,VI">
    <System>MPAA</System>
    <Certification>PG-13</Certification>
  </ContentRating>
  <ContentRating>
    <System>Eirin</System>
    <Certification>R15+</Certification>
  </ContentRating>
</ContentRatings>

ContentRating

Contains elements that specify a rating system or organization and the rating they gave the work. When present, the optional ContentRatings must contain at least one ContentRating. You can have as many ContentRating elements as you need, one for each system/rating pair.

ContentRatings is required for the following countries: US, Brazil, Australia, Japan. For all other countries, ContentRatings is strongly recommended.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`ContentRatings`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`System` (required, one allowed) `Certification` (required, one allowed)
Attributes	`territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.

Example:

<ContentRatings>
  <ContentRating territories="US,PR,VI">
    <System>MPAA</System>
    <Certification>PG-13</Certification>
  </ContentRating>
  <ContentRating>
    <System>Eirin</System>
    <Certification>R15+</Certification>
  </ContentRating>
</ContentRatings>

System

The rating system, normally an official organization, that determined a work's rating. Each rating can have only one System.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`ContentRating`
Content Model	simpleType (no children)
Child Elements	None
Data Type	string

Example:

<ContentRatings>
  <ContentRating>
    <System>MPAA</System>
    <Certification>G</Certification>
  </ContentRating>
</ContentRatings>

Certification

The certification or rating given to the work under a specified certification System. Only one Certification element is allowed for each ContentRating.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`ContentRating`
Content Model	simpleType (no children)
Child Elements	None
Data Type	string

Example:

<ContentRatings>
  <ContentRating territories="US,PR,VI">
    <System>MPAA</System>
    <Certification>PG-13</Certification>
  </ContentRating>
<ContentRating>

ShowID

Used to tie a TvEpisode or a TvSeason to a TvShow in your catalog. This value must match the ID value in a TvShow element. You have the option of using ShowID or ShowTitle to specify the show, but not both. Always use ShowID when the TvShow is in your catalog.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`TvSeason` `TvEpisode`
Content Model	simpleType (no children)
Child Elements	None
Data Type	token

Example:

<TvShow>
  <ID>TV-2329880</ID>
  ...
</TvShow>
<TvSeason>
  ...
  <ShowID>TV-2329880</ShowID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <ShowID>TV-2329880</ShowID>
  ...
</TvEpisode>

ShowTitle

Used to tie a TvEpisode or a TvSeason to a TvShow in your catalog. This value is simply a string for use in the UI and is not required to match any title in your catalog. You have the option of using ShowID or ShowTitle to specify the show, but not both. Use ShowTitle only in the absence of ShowID.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`TvSeason` `TvEpisode`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string
Data Type	Localized string

Example:

<TvSeason>
  ...
  <ShowTitle locale="en-US">Depth of Field</ShowTitle>
  ...
</TvSeason>

SeasonInShow

The number of a season that a TVEpisode is a part of, when that season is not part of your catalog. SeasonInShow is simply a number for use in the UI and is not required to match anything. You have the option of using SeasonID or SeasonInShow to specify the season, but not both. Use SeasonInShow only in the absence of SeasonID, which should be a rare occurrance.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`TvEpisode`
Content Model	simpleType (no children)
Child Elements	None
Data Type	int

Example:

<TvEpisode>
  ...
  <SeasonInShow>2</SeasonInShow>
  ...
</TvEpisode>

ShowID

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`TvSeason` `TvEpisode`
Content Model	simpleType (no children)
Child Elements	None
Data Type	token

Example:

<TvShow>
  <ID>TV-2329880</ID>
  ...
</TvShow>
<TvSeason>
  ...
  <ShowID>TV-2329880</ShowID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <ShowID>TV-2329880</ShowID>
  ...
</TvEpisode>

ShowTitle

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`TvSeason` `TvEpisode`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string
Data Type	Localized string

Example:

<TvSeason>
  ...
  <ShowTitle locale="en-US">Depth of Field</ShowTitle>
  ...
</TvSeason>

SeasonID

The ID of the season of which a TvEpisode is a part. The TvSeason with this ID must be present in the same catalog as this TvEpisode. You have the option of using SeasonID or SeasonInShow to specify the season, but not both. SeasonID should always be used when the season is in your catalog. If is not in your catalog, consider creating a TvSeason entry.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`TvEpisode`
Content Model	simpleType (no children)
Child Elements	None
Data Type	token

Example:

<TvSeason>
  <ID>SEA-2329880</ID>
  ...
</TvSeason>
<TvEpisode>
  ...
  <SeasonID>SEA-2329880</SeasonID>
  ...
</TvEpisode>

SeasonInShow

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`TvEpisode`
Content Model	simpleType (no children)
Child Elements	None
Data Type	int

Example:

<TvEpisode>
  ...
  <SeasonInShow>2</SeasonInShow>
  ...
</TvEpisode>

SeasonTitle

A title for the season in which a TvEpisode appeared, such as "Season 2". Note that if the corresponding TvSeason element is included in your catalog, this value is not required to match its Title, though it should. Each TvEpisode can have only one SeasonTitle.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`TvEpisode`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`locale`: Required. The device or software's language setting under which to use this string. Data Type: language `pronunciation`: Optional. Used when the element's text is given in kanji. The expected sort order in Japanese is based on pronunciation (which cannot be determined from the kanji) rather than characters. The pronunciation attribute provides that information, typically using hiragana. Data Type: string
Data Type	Localized string

Example:

<TvEpisode>
  ...
  <SeasonInShow>2</SeasonInShow>
  <SeasonTitle locale="en-US">Season 2</SeasonTitle>
  ...
</TvEpisode>

EpisodeInSeason

A TV episode's sequence number within its season. Each TvEpisode can contain only one EpisodeInSeason element.

Property	Detail
Use	Required
How Many Allowed	One
Parent Elements	`TvEpisode`
Content Model	simpleType (no children)
Child Elements	None
Data Type	int

Example:

<TvEpisode>
  ...
  <EpisodeInSeason>6</EpisodeInSeason>
  ...
</TvEpisode>

OriginalAirDates

Set of Original Air Dates when the Episode or Specials was originally televised.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`TvEpisode`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`OriginalAirDate` (required, unlimited)
Attributes	None

Example:

<Movie>
  ...
  <OriginalAirDates>
    ...
  </OriginalAirDate>
</Movie>

OriginalAirDate

The date and time when a work was originally televised. The year portion of this value should match the ReleaseYear, if that optional element is present. This information is useful in matching this work to content in other catalogs. A match allows us to show a single listing for a work that shows all of its available sources rather than having multiple search results for same thing.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`OriginalAirDates`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.
Data Type	TerritoryDateTimeType - Same as dateTime with the addition of the `territories` attribute.

Example:

<Movie>
...
  <OriginalAirDates>
    <OriginalAirDate territories="US,CA">2014-01-01T11:30:00+08:00</OriginalAirDate>
  </OriginalAirDates>
</Movie>

ReleaseDates

Contains Release Dates of the content in various territories.

Property	Detail
Use	Optional
How Many Allowed	One
Parent Elements	`Movie` `TvShow`
Content Model	complexType – sequence. Must contain required child elements in specified order.
Child Elements	`ReleaseDate` (required, unlimited)
Attributes	None

Example:

<TvShow>
  ...
  <ReleaseDates>
  ...
  </ReleaseDates>
</TvShow>

ReleaseDate

The date and time when the work was originally released to the public, or the first air date in the case of television. The year portion of this value should match the ReleaseYear, if that optional element is present. This information is particularly useful in matching this work to content in other catalogs. A match allows us to show a single listing for a work that shows all of its available sources rather than having multiple search results for same thing.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`ReleaseDates`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`territories`: Optional. A comma separated list of countries and territories indicating locations affected by this element. Leave empty to indicate worldwide. Data Type: TerritoriesType - A string that represents a territory. Uses ISO 3166-1 alpha-2 country code values. For example US, PR, VI, GB, DE.
Data Type	TerritoryDateTimeType - Same as dateTime with the addition of the `territories` attribute.

Example:

<TvShow>
  ...
  <ReleaseDates>
    <ReleaseDate territories="US,CA">2012-05-13T00:00:00</ReleaseDate>
  </ReleaseDates>
</TvShow>

Type

Specifies an Extra as a clip. A clip can be a trailer or be as extensive as a making-of documentary about the associated Movie of the Extra. Each Extra can have only one Type.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Extra`
Content Model	simpleType (no children)
Child Elements	None
Data Type	Enum: `clip`

Example:

<Extra>
  ...
  <Type>clip</Type>
  ...
</Extra>

RelatesToID

Used to specify another work (such as a movie) with which an Extra (such as a trailer for that movie) is associated. The work with this ID must be present in the same catalog as this Extra. You have the option of using RelatesToID or RelatesToExternalID to specify the associated work, but not both. RelatesToID should always be used when the associated work is in your catalog.

Property	Detail
Use	Optional
How Many Allowed	Unlimited
Parent Elements	`Extra`
Content Model	simpleType (no children)
Child Elements	None
Data Type	token

Example:

<TvShow>
  <ID>TV123456</ID>
  ...
</TvShow>
<Extra>
  ...
  <Type>trailer</Type>
  <RelatesToID>TV123456</RelatesToID>
</Extra>

RelatesToExternalID

Used to specify another work (such as a movie) with which an Extra (such as a trailer for that movie) is associated. RelatesToExternalID specifies an identifier by which that other work (such as the movie) is known in an external classificiation such as IMDb. RelatesToExternalID is used when the associated work is not a part of your catalog. You have the option of using RelatesToID or RelatesToExternalID to specify the association, but not both. Use RelatesToExternalID only in the absence of RelatesToID.

Do not confuse RelatesToExternalID with ExternalID. ExternalID refers to the Extra itself, while RelatesToExternalID refers to the work that it's associated with.

Property	Detail
Use	Required
How Many Allowed	Unlimited
Parent Elements	`Extra`
Content Model	complexType – attributes only. No child elements, but element does allow attributes.
Child Elements	None
Attributes	`scheme`: Required. The external source that provided this ID. Data Type: Enum. Enum Values: `imdb`: The Internet Movie Database (IMDb). IDs can be found as part of the URL of a given page. `tms`: An OnTV domain — used to be Tribune Media Service, but it is essentially one of the older Gracenote ID spaces. `isan`: The International Standard Audiovisual Number (ISAN), an alphanumeric strings of 26 characters, usually presented broken by dashes. `ean`: The European Article Number (EAN) is a barcode standard, a 12- or 13-digit product identification code. Each EAN uniquely identifies the product, manufacturer, and its attributes. `upc`: Universal Product Code (UPC) is a 12-digit bar code used extensively for retail packaging in United States. `asin`: Amazon Standard Identification Numbers (ASINs) are unique blocks of 10 letters and/or numbers that identify items. `gvd`: Gracenote Video Data — the Gracenote ID provides "unique identifiers for TV programs and movies [to] enable linking to TV schedule data and on-demand catalogs". `region`: Optional. Region for which the `externalId` is relevant, such as marketplace for Amazon ASINS or country for a TMS ID. For example, `US` for a TMS scheme. Data Type: string
Data Type	token

Example:

<Extra>
  ...
  <Type>trailer</Type>
  <RelatesToExternalID scheme="imdb">tt0000000</RelatesToExternalID>
  <RelatesToExternalID scheme="tms">MV000000000000</RelatesToExternalID>
  <RelatesToExternalID scheme="isan">0000-0000-0F00-0000-X-0000-0000-Y</RelatesToExternalID>
  <RelatesToExternalID scheme="ean">0011559514120</RelatesToExternalID>
  <RelatesToExternalID scheme="upc">123456789990</RelatesToExternalID>
</Extra>

Last updated: Feb 23, 2024