Template change log
The TitleLeaf ingestion templates change intermittently as the application itself evolves and improves. Before organizing data in a template and ingesting into TitleLeaf, please verify that you're using the most recent version of said template. Hover your cursor over the first column's header cell to identify the template version, as shown below.

For further information about template changes, see below:
- products
- product_formats
- series (previously termed collections)
- categories
- contributors
- editorial_reviews
- postal_codes
products
- Version 33 (June 22, 2025)
- Expand acceptable values for graphics column.
- Version 32 (February 10, 2023)
- Add themas column.
- Version 31 (November 10, 2023)
- Add city_of_publication column.
- Add country_of_publication column.
- Version 30 (January 23, 2023)
- Add
title_without_prefixcolumn. The field accepts a string which represents the product title without its prefix (aka, article, such as "The" or "An". It can be used for custom sorting, on request. - Version 29 (September 30, 2022)
- Add
series_numbercolumn. The field accepts a string which represents the distinctive enumeration of a product within a series (eg, "Volume 2"). - Version 28 (April 30, 2021)
- Rename from "products-default" to "products-with-one-format".
- Version 26 (July 15, 2018)
- Add
announce_oncolumn. The field accepts a date which represents when a new product may be announced to the general public. - Add
preorder_oncolumn. The field accepts a date which represents when a retail ‘preorder’ can be placed in the market, where this is distinct from the public announcement date mentioned above. - Rename
first_published_oncolumn tofirst_release_on. This date should equal the earliestrelease_onvalue of the associated product formats. The column is being renamed to reinforce the relationship to the associated product formats and to maintain consistency with the series column of the same name. - Version 25 (March 25, 2018)
- Add
brandcolumn. The field accepts a string which represents the marketing brand for the product format. - Add
recovery_levelcolumn. The field accepts an integer which represents the Reading Recovery Level for the product. - Add
sample_front_pagescolumn. The field accepts an integer which represents the number of front pages to extract from the PDF ebook in order to create a sample excerpt for the product. - Add
sample_back_pagescolumn. The field accepts an integer which represents the number of back pages to extract from the PDF ebook in order to create a sample excerpt for the product. - Version 24 (August 25, 2017)
- Add
detail_versioncolumn. The field accepts a string which represents the version number for the ebook format. It is not applicable to print formats. It is intended to store the EPUB version number of a given product format (eg, EPUB version 3.0). - Version 23 (February 26, 2017)
- Rename
available_oncolumn tofirst_published_onto avoid confusion. This date should equal the earliest release date of the associated product formats. - Version 22 (October 21, 2016)
- Change
graphicscolumn to accept multiple values if separated by a semi-colon. The acceptable values have changed to:1-color illustrations; 2-color photographs; Full-color illustrations; Full-color photographs; Historical photographs - Version 21 (October 13, 2016)
- Add
durationcolumn. The field accepts an integer which represents the runtime for the product format. - Version 20 (September 29, 2016)
- Rename
languagetolanguages. The field now accepts multiple values if separated by a semi-colon. - Rename
audiencetoaudiences. The field now accepts multiple values if separated by a semi-colon. - Version 19 (August 1, 2016)
- Rename
spotlight_descriptiontopromotional_descriptionto match ONIX terms - Rename
carton_quantitytopack_quantityto match ONIX terms - Version 18 (June 14, 2016)
- Add
price_list_alt_usercolumn. Now both alternate List pricing and alternate Library/Member pricing can be defined. Previously S/L pricing was inferred. - Version 17 (February 7, 2016)
- Designate
proprietary_idas mandatory - Version 16
- Replace
has_indexet al withfeatures - Version 15
- Add Hi-Lo Format, Narrative Format as acceptable options to
genrecolumns - Version 14
- Add
keywordscolumn - Version 13
- Add
srcpointsandsrcreadlevelcolumns
products-with-one-format
See "products" and "product_formats" for versioning. "products-with-one-format" is a combination of those two templates.
- April 30, 2021
- Rename from "products-default" to "products-with-one-format".
products-default-with-multiple-formats
- DEPRECATED (April 30, 2021)
- Use "products" template, then "products_formats" template instead.
- Version 26 (July 15, 2018)
- Add
announce_oncolumn. The field accepts a date which represents when a new product may be announced to the general public. - Add
preorder_oncolumn. The field accepts a date which represents when a retail ‘preorder’ can be placed in the market, where this is distinct from the public announcement date mentioned above. - Rename
first_published_oncolumn tofirst_release_on. This date should equal the earliestrelease_onvalue of the associated product formats. The column is being renamed to reinforce the relationship to the associated product formats and to maintain consistency with the series column of the same name. - Version 25 (March 25, 2018)
- Add
brandcolumn. The field accepts a string which represents the marketing brand for the product format. - Add
recovery_levelcolumn. The field accepts an integer which represents the Reading Recovery Level for the product. - Add
sample_front_pagescolumn. The field accepts an integer which represents the number of front pages to extract from the PDF ebook in order to create a sample excerpt for the product. - Add
sample_back_pagescolumn. The field accepts an integer which represents the number of back pages to extract from the PDF ebook in order to create a sample excerpt for the product. - Version 24 (August 25, 2017)
- Add
detail_versioncolumn. The field accepts a string which represents the version number for the ebook format. It is not applicable to print formats. It is intended to store the EPUB version number of a given product format (eg, EPUB version 3.0). - Version 23 (February 26, 2017)
- Rename
available_oncolumn tofirst_published_onto avoid confusion. This date should equal the earliest release date of the associated product formats. - Version 22 (October 21, 2016)
- Change
graphicscolumn to accept multiple values if separated by a semi-colon. The acceptable values have changed to:1-color illustrations; 2-color photographs; Full-color illustrations; Full-color photographs; Historical photographs - Version 21 (October 13, 2016)
- Add
durationcolumn. The field accepts an integer which represents the runtime for the product format. - Version 20 (September 29, 2016)
- Rename
languagetolanguages. The field now accepts multiple values if separated by a semi-colon. - Rename
audiencetoaudiences. The field now accepts multiple values if separated by a semi-colon. - Version 19 (August 1, 2016)
- Rename
spotlight_descriptiontopromotional_descriptionto match ONIX terms - Rename
carton_quantitytopack_quantityto match ONIX terms - Version 18 (June 14, 2016)
- Add
price_list_alt_usercolumn. Now both alternate List pricing and alternate Library/Member pricing can be defined. Previously S/L pricing was inferred. - Version 17 (February 7, 2016)
- Designate
proprietary_idas mandatory - Version 16
- Replace
has_indexet al withfeatures - Version 15
- Add Hi-Lo Format, Narrative Format as acceptable options to
genrecolumns - Version 14
- Add
keywordscolumn - Version 13
- Add
srcpointsandsrcreadlevelcolumns
products-only
- DEPRECATED (April 30, 2021)
- Use "products" template instead.
- Version 18 (March 25, 2018)
- Add
recovery_levelcolumn. The field accepts an integer which represents the Reading Recovery Level for the product. - Add
sample_front_pagescolumn. The field accepts an integer which represents the number of front pages to extract from the PDF ebook in order to create a sample excerpt for the product. - Add
sample_back_pagescolumn. The field accepts an integer which represents the number of back pages to extract from the PDF ebook in order to create a sample excerpt for the product. - Version 17 (February 26, 2017)
- Rename
available_oncolumn tofirst_published_onto avoid confusion. This date should equal the earliest release date of the associated product formats. - Version 16 (October 21, 2016)
- Change
graphicscolumn to accept multiple values if separated by a semi-colon. The acceptable values have changed to:1-color illustrations; 2-color photographs; Full-color illustrations; Full-color photographs; Historical photographs - Version 15 (September 29, 2016)
- Rename
languagetolanguages. The field now accepts multiple values if separated by a semi-colon. - Rename
audiencetoaudiences. The field now accepts multiple values if separated by a semi-colon. - Version 14 (August 1, 2016)
- Rename
spotlight_descriptiontopromotional_descriptionto match ONIX terms - Version 13 (February 7, 2016)
- Designate
proprietary_idas mandatory - Remove
seriesandsubseriescolumns (not supported by ingestion model) - Remove
publishercolumn (not supported by ingestion model) - Remove
authorandillustratorcolumns (not supported by ingestion model) - Version 12
- Replace
has_indexet al withfeatures - Version 11
- Add Hi-Lo Format, Narrative Format as acceptable options to
genrecolumns - Version 10
- Add
keywordscolumn - Version 9
- Add
srcpointsandsrcreadlevelcolumns
product_formats
- Version 22 (February 4, 2025)
- Add accessibility_codes column.
- Version 21 (October 19, 2024)
- Add expected_on column.
- Version 20 (November 1, 2023)
- Add country_of_manufacture column.
- Add harmonized_code column.
- Version 19 (July 13, 2022)
- Add price_list_cad column. A price_cad column already exists. In combination, TitleLeaf can now store a Canadian List price and a Canadian Member price.
- Version 18 (November 20, 2021)
- Rename
rights_countriestorights_includedto match TitleLeaf field label. - Rename
not_for_salestorights_excludedto match TitleLeaf field label. - Version 17 (October 4, 2021)
- Add word_count column. It was supported in the past but was mistakenly not present in the template.
- Version 16 (April 30, 2021)
- Rename from "product_formats-with-proprietary-product-id" to "product_formats".
- Rename from "product_formats" to "product_formats-with-associated-isbn".
- Version 15 (March 10, 2019)
- Add
skip_distributioncolumn. The field accepts a boolean which represents if a product format should be distributed or not. This attribute is applicable to subscribers of the TitleLeaf Distribution module. - Version 14 (July 15, 2018)
- Add
announce_oncolumn. The field accepts a date which represents when a new product may be announced to the general public. - Add
preorder_oncolumn. The field accepts a date which represents when a retail ‘preorder’ can be placed in the market, where this is distinct from the public announcement date mentioned above. - Version 13 (March 25, 2018)
- Add
brandcolumn. The field accepts a string which represents the marketing brand for the product format. - Version 12 (August 25, 2017)
- Add
detail_versioncolumn. The field accepts a string which represents the version number for the ebook format. It is not applicable to print formats. It is intended to store the EPUB version number of a given product format (eg, EPUB version 3.0). - Version 11 (October 13, 2016)
- Add
durationcolumn. The field accepts an integer which represents the runtime for the product format. - Version 10 (August 1, 2016)
- Rename
carton_quantitytopack_quantityto match ONIX terms - Version 9 (June 14, 2016)
- Add
price_list_alt_usercolumn. Now both alternate List pricing and alternate Library/Member pricing can be defined. Previously S/L pricing was inferred.
series
- Version 5 (July 15, 2018)
- Add
first_announce_oncolumn. The field accepts a date which represents when the given series may be announced to the general public. The value should equal the earliestannounce_onvalue of the associated product formats. - Rename
available_oncolumn tofirst_release_on. The field accepts a date which represents when a retail ‘order’ can be placed in the market. The value should equal the earliestrelease_onvalue of the associated product formats. - Version 4 (September 29, 2016)
- Renamed file from collections to series. The former is the internal term for the latter. We will be hiding the internal term if at all possible.
- Version 3 (February 7, 2016)
- Add
publishercolumn
categories
- Version 2 (April 6, 2018)
- Added proprietary_parent_id column.
- Version 1 (January 1, 2015)
- Initial version
contributors
- Version 4 (May 10, 2024)
- Renamed column from default_role to fallback_role.
- Version 3 (April 6, 2018)
- Removed website column name.
- Added website1_url column name. The column can be repeated to associate multiple website URLs to the given contributor. Maximum number of 20 websites.
- Added website1_role column name. Other accepted columns are website1_title, website1_description, and website1_proprietary_id.
- Version 2 (March 15, 2018)
- Added proprietary_id column.
- Version 1 (January 1, 2015)
- Initial version
editorial_reviews
- Version 3 (June 14, 2024)
- Added snippet column.
postal_codes
- Version 3 (October 29, 2022)
- Added tax_shipping column. A boolean determining if shipping is taxed or not for the given postal code.
- Version 2 (August 10, 2019)
- Added tax_rate column. A decimal number from 0 to 1 representing the tax rate for the given postal code.
- Version 1 (January 1, 2015)
- Initial version