You can easily import a batch of new publications, or modify the metadata of existing publications, using a file formatted according to the ONIX 3.0 standard.

Note that importing audiobook metadata with ONIX presents special options.

Formatting the ONIX 3.0 file

Structure of the ONIX 3.0 file

Below is a description of each of the available ONIX 3.0 tags.


ONIX 3.0 tag

Mandatory Optional
Repeat

ONIX code list

Values or Format

Description

<ONIXMessage release="3.0">



<Header>



<Sender>



<SenderIdentifier>



<SenderIDType>Optional44606: GLN
<IDTypeName>Optional


GLN"GLN"
<IDValue>Optional




</SenderIdentifier>



<SenderName>Optional




<ContactName>



<EmailAddress>



</Sender>



<MessageNumber>Optional
1
<SentDateTime>Optional
Datee.g. 20110309T022935Z
<DefaultLanguageOfText>Optional
fre
<DefaultCurrencyCode>Optional

963 letter code
ISO 4217 currency codes
</Header>



<Product>



<RecordReference>Mandatory1TextRecord identifier. Format: Platform prefix + publication's internal identifier – format nature. E.g.: "EDGT5513-epub"
<NotificationType>Mandatory103; 04; 0503: Notification confirmed from book-in-hand
04: Update
05: Delete
<ProductIdentifier>Repeat


<ProductIDType>Mandatory501; 02; 03; 15

01: Custom
02: ISBN 10
03: EAN
15: ISBN 13

<IDValue>Mandatory
NumberIdentifier's value (ISBN)
</ProductIdentifier>



<DescriptiveDetail>Mandatory


<ProductComposition>Mandatory2000: Single-item retail product
<ProductForm>Mandatory150EAEA: Digital (delivered electronically)
<ProductFormDetail>Optional
(only if ProductForm=EA)		175E101; E107; E127E101: EPUB
E107: PDF
E127: MOBI
E200 (with E101) - Reflowable
E201 (with E101) - Fixed Layout
<ProductFormFeature>



<ProductFormFeatureType>Optional7909; 12; 15
<ProductFormFeatureValue>Optional

143 (Hazards)

196 (Accessibility)

220 (EPUB version)

All possible values from each listSee Accessibility level - possible values
<ProductFormFeatureDescription>Optional


</ProductFormFeature>



<EpubTechnicalProtection>Optional
(only if ProductForm=EA)		14400; 02; 03; 0600: None
02: Watermark
03: Adobe DRM
06: Readium LCP
<EpubUsageConstraint>Repeat


<EpubUsageType>Mandatory

14502; 03; 0402: Print
03: Copy / Paste
04: Share
<EpubUsageStatus>Mandatory14601; 02; 0301: Permitted unlimited
02: Permitted subject to limit
03: Prohibited
<EpubUsageLimit>Repeat


<Quantity>Optional
NumberMaximum permitted quantity, eg.: 6
<EpubUsageUnit>Optional
(only if EpubUsageType=04)		14706; 0906: Devices (Maximum number of devices in ‘share group’.)
09: days
</EpubUsageLimit>



</EpubUsageConstraint>





 Collection



* See also CollateralDetail / TextContent / TextType 17 and WebSite / Web
 <Collection> * Optional


 <CollectionType> Mandatory if collection 1481111: Publisher collection
 <TitleDetail> Mandatory if collection


 <TitleType> Mandatory if collection 15 0101: Title on item
 <TitleElement> Mandatory if collection


 <TitleElementLevel> Mandatory if collection 149 0201: Collection level
 <TitleText> Mandatory if collection
 TextCollection's title, text format
 </TitleElement>



 </TitleDetail>



 </Collection>



 Series



* See also CollateralDetail / TextContent / TextType 17 and WebSite / Web
 <Collection> * Optional


 <CollectionType> Mandatory if series 1481010: Publisher collection
 <CollectionIdentifier> Optional


 <CollectionIDType>
 13 0101: Proprietary
 <IDValue>


User internal identifier for the series
 </CollectionIdentifier>



 <TitleDetail> Mandatory if series


 <TitleType> Mandatory if series 15 0101: Title on item
 <TitleElement> Mandatory if series


 <TitleElementLevel> Mandatory if series 149 0202: Collection level
 <TitleText>


The title of the series
 </TitleElement> Optional


 <TitleElement>
 149 0101: Name of an individual product in the series 
 <TitleElementLevel>



 <PartNumber>


Sequential part, as it should be display on stores sites: e.g. "Volume 2", "Vol. 23, No. 2"
 </TitleElement>



 </TitleDetail>



 </Collection>



 Collection AND Series




 <Collection> Optional

* See also CollateralDetail / TextContent / TextType 17 and WebSite / Web
 <CollectionType>
 148 1010: Publisher collection
 <CollectionIdentifier>



 <CollectionIDType>
 1490202: Collection level
 <IDValue>

 TextIdentifier of the series, for example, an ISSN in the case of a periodical.
 <CollectionSequence>



 <CollectionSequenceType>
 1970303: Series title if there's a Collection AND Series
 <CollectionSequenceNumber>

 NumberPublication order. Numeric part only, example "2", "12", etc.
 </CollectionSequence>



 </CollectionIdentifier>



 <TitleDetail>



 <TitleType>
 150101: Title on item
 <TitleElement>



 <TitleElementLevel>
 1490202: Collection level
 <TitleText>

 TextTitle of the collection, text format
 </TitleElement>



 <TitleElementLevel>
 1490101: Product
 <TitleText>

 TextSequential part, as it should be display on stores sites: e.g. "Volume 2", "Vol. 23, No. 2"
 </TitleElement>



 </TitleDetail>



 </Collection>



</Collection>



<TitleType>Mandatory15101: Distinctive title (book); Cover title (serial); Title on item (serial content item or reviewed resource)
<TitleElement>



<TitleElementLevel>Mandatory149101: Product
<TitleText>Mandatory
TextTitle of the publication
<TitlePrefix>Optional
TextTitle's prefix
<TitleWithoutPrefix>Optional
TextTitle without prefix – Title for sorting
<Subtitle>



</TitleElement>



</TitleDetail>



<Contributor>Repeat


<SequenceNumber>Mandatory
NumberThe sequence number increments while the contributor's importance decreases
<ContributorRole>Mandatory17
Contributor's role.
A01: "author"
A02: "with"
A03: "screenplay_writer"
A04: "libretto_writer"
A05: "lyrics_author"
A06: "composer"
A07: "artist"
A08: "photographer"
A09: "created_by"
A10: "from_an_idea_by"
A11: "designed_by"
A12: "illustrated_by"
A13: "photographs_by"
A14: "text_author"
A15: "preface_author"
A16: "prologue_author"
A17: "summary_author"
A18: "supplement_author"
A19: "afterword_author"
A20: "notes_author"
A21: "commentaries_author"
A22: "epilogue_author"
A23: "foreword_author"
A24: "introduction_author"
A25: "footnotes_author"
A26: "memoir_author"
A27: "experiments_author"
A29: "introduction_and_notes_author"
A30: "software_writer"
A31: "book_and_lyrics_author"
A32: "contributions_author"
A33: "appendix_author"
A34: "index_compiler"
A35: "drawings_by"
A36: "cover_design_or_artwork_by"
A37: "preliminary_work_by"
A38: "original_author"
A39: "maps_by"
A40: "inked_or_colored_by"
A41: "pop_ups_by"
A42: "continued_by"
A43: "interviewer"
A44: "interviewee"
A99: "other_primary_creator"
B01: "edited_by"
B02: "revised_by"
B03: "retold_by"
B04: "abridged_by"
B05: "adapted_by"
B06: "translated_by"
B07: "as_told_by"
B08: "translated_with_commentary_by" B09: "series_edited_by"
B10: "edited_and_translated_by"
B11: "editor_in_chief"
B12: "guest_editor"
B13: "volume_editor"
B14: "editorial_board_member"
B15: "editorial_coordination_by"
B16: "managing_editor"
B17: "founded_by"
B18: "prepared_for_publication_by"
B19: "associate_editor"
B20: "consultant_editor"
B21: "general_editor"
B22: "dramatized_by"
B23: "general_rapporteur"
B24: "literary_editor"
B25: "music_arranged_by"
B26: "technical_editor"
B99: "other_adaptation_by"
C01: "compiled_by"
C02: "selected_by"
C99: "other_compilation_by"
D01: "producer"
D02: "director"
D03: "conductor"
D99: "other_direction_by"
E01: "actor"
E02: "dancer"
E03: "narrator"
E04: "commentator"
E05: "vocal_soloist"
E06: "instrumental_soloist"
E07: "read_by"
E08: "performed_by_orchestra_band_ensemble"
E09: "speaker"
E99: "performed_by"
F01: "filmed_photographed_by"
F99: "other_recording_by"
Z01: "assisted_by"
Z98: "various_roles"
Z99: "other"
<PersonName>Mandatory
TextContributor's full name, e.g.: René J. Blanchet
<PersonNameInverted>Optional
TextContributor's full name, inverted, e.g.: Blanchet, René J.
<NamesBeforeKey>Mandatory
TextPerson name part 2. First name and initials. E.g.: René J.
<KeyNames>Mandatory
TextPerson name part 4. Last name. E.g.: Blanchet
<BiographicalNote>

TextA biographical note about a contributor to the product.
<Website>



<WebsiteRole>Optional7301;01: Contributor's corporate website
02: Publisher’s website for a specified work
14: Publisher’s website relating to series of works
<WebsiteLink>Optional
URLURL
<Website>



<ContributorPlace>



<ContributorPlaceRelator>
151
04: Currently resides in
08: Citizen of Or nationality. For use with country codes only.
<CountryCode>


2-letter country code (format ISO 3166-1: "fr", "us", "ca")
</ContributorPlace>



</Contributor>



<NoEdition/>Optional

If the text is an original
<Language>Repeat


<LanguageRole>Optional2201; 0201: Language of text
02: Original language of a translated text
<LanguageCode>Optional74Code de langue ISO 639-2/B.

E.g.: fre; ita; eng

</Language>



<Extent>Repeat


<ExtentType>Mandatory2300; 03; 08; 2200, 08: Page count
03: Front matter page count (Roman-numbered) pages
22: File size
<ExtentValue>Mandatory
NumberValue
<ExtentUnit>Optional
(only for ExtentType=22)		241903: Pages
19: Megabytes (if ExtentType = 22);
</Extent>



<Subject>Repeat

Classifications
<MainSubject/>Repeat
for primary classification

To be used only when classification is primary.
<SubjectSchemeIdentifier>Mandatory

2701; 10; 12; 24; 28; 29; 9301: Dewey
10: BISAC
12: BIC
20: Keywords
24: Custom
28: Electre
29: CLIL
93: Thema
<SubjectSchemeName>



<SubjectCode>Optional

Code value
<SubjectHeadingText>Optional

Subject heading text - according to SubjectSchemeIdentifier
</Subject>



<Audience>Optional
Repeat


<AudienceCodeType>Optional2901;02;06;01: ONIX codes
02: Proprietary
06: BTLF audience Code Proprietary when apple-interest-age-years Match with AudienceCodeTypeName
<AudienceCodeValue>Optional

acceptable ranges are
01: General/Trade
0002: 0 to 2 years old
0305: 3 to 5 years old
0608: 6 to 8 years old
0912: 9 to 12 years old
1399: 13+

</Audience>





 <AudienceRange> Optional


 <AudienceRangeQualifier> Optional
 17 Qualifier 17: Ages
 <AudienceRangePrecision> Optional
 0303: From (can be used alone)
 <AudienceRangeValue> Optional

 Minimum recommended age
 <AudienceRangePrecision> Optional
 04 04: To
 <AudienceRangeValue> Optional

Maximum recommended age
 </Audience>



<Prize>



<PrizeName>Optional
TextName of the literary award
<PrizeYear>Optional
YearExample: 2014
<PrizeCountry>Optional

Country code, in ISO 3166-1 format
<PrizeCode>Optional
01; 02; 03; 04; 05; 06;01: Winner
02: Runner-up
03: Commended
04: Short-listed
05: Long-listed
06: Joint winner
</Prize>



</DescriptiveDetail>



<CollateralDetail>



<TextContent>Repeat


<TextType>Mandatory15302; 03; 04; 05; 06; 09; 10; 12; 14; 17;Text type.
02: Comments
03: Summary
04: Table of contents
05: Presentation
06: Review quote
09: Endorsement
10: Promotional headline
12: Biographical note
14: Excerpt
17: Serie Description (see Collection)
<ContentAudience>Mandatory1540Audience.
00: Unrestricted
<Text>Mandatory
TextText value
</TextContent>



<SupportingResource>Repeat


<ResourceContentType>Mandatory15801; 02; 03; 04; 11; 15; 16; 17; 20; 21; 24; 2601: Front cover
02: Back cover
03: Cover other
04: Contributor picture
11: Contributor interview
15: Sample content
16: Flipbook URL
17: Review
20: Teacher guide
21: Feature Article
24: Press release
26: Trailer 
<ContentAudience>Repeat1540Audience
00: Unrestricted
<ResourceMode>Mandatory15901; 02; 03; 04; 05; 0601: Application
02: Audio
03: Image
04: Text
05: Video
06: Multi-mode Supported file extensions:
02: 'mp3', 'wav', 'wma', 'mp4'
03: 'png', 'bmp', 'jpg', 'jpeg', 'gif', 'tif'
04: 'doc', 'docx', 'xls', 'xlsx', 'odp', 'ods', 'odt', 'epub', 'pdf', 'txt', 'rtf'
05: 'flv', 'mpeg', 'mpg', 'avi', 'mov'
<ResourceFeature>Optional


<ResourceFeatureTypeMandatory1602Explanatory caption that may accompany a resource (e.g. use to identify an author in a photograph) Important: To link an author's photograph, you must use 02 here with the exact name of the contributor.
<FeatureValue>Optional
TextMedia title
<FeatureNote>Optional
TextMedia description
</ResourceFeature>



<ResourceVersion>



<ResourceForm>Mandatory16101; 0201: Linkable ressource
02: Downloadable file
<ResourceVersionFeature>



<ResourceVersionFeatureType>
16201; 02; 03; 0401: File format
02: Image height in pixels
03: Image width in pixels
04: Filename
<FeatureValue>Optional
(only for 02, 03)
NumberValue
</ResourceVersionFeature>



<ResourceLink>Mandatory
URLRessource URL or
http://.../large.jpg
http://.../small.jpg
<ContentDate>Optional


<ContentDateRole>Mandatory
17Last update date of the front cover media
<DateFormat>Mandatory
00;00: YYYYMMDD Most ONIX's date formats are supported. This is a suggestion on a simple date format.
<Date>Mandatory
DateEg.: 20120501
</ContentDate>Mandatory


</ResourceVersion>



</SupportingResource>



</CollateralDetail>



<PublishingDetail>



 <Imprint>



 <ImprintName>Optional
TextImprint
 </Imprint>



<Publisher>



<PublishingRole>Mandatory4501;01: Publisher
<PublisherIdentifier>



<PublisherIDType>Mandatory4406;06: GLN
<IDTypeName>Mandatory
GLN"GLN"
<IDValue>Mandatory
NumberPublisher's internal ID
</PublisherIdentifier>Mandatory


<PublisherName>

TextPublisher name
<Website>Repeat


<WebSiteRole>Mandatory7301; 02; 1401: Publisher's corporate website
02: Publisher's website for a specified work.
14: Collection's web site (see Collection
<WebSiteLink>Mandatory
URLURL
</Website>



</Publisher>



<PublishingStatus>Mandatory6404; 08;04: Active
08: Inactive (Paper format is always Inactive)
<PublishingDate>



<PublishingDateRole>Optional
01; 09; 1901: Nominal date of publication
09: Public announcement date - Date when a new product may be announced to the general public.
13: Date when a product was (or will be) declared out-of-print or deleted
19: Publication date of print counterpart
<DateFormat>

00; 1400: YYYYMMDD
14: YYYYMMDDThhmmss. Alternatively, the time may be suffixed with an optional ‘Z’ for UTC times, or with ‘+’ or ‘-’ and an hhmm timezone offset from UTC. (e.g.: 20120530T131243-0400)
<Date>



</PublishingDate>



<SalesRights>Mandatory


<SalesRightsType>Mandatory4601; 03;01: For sale with exclusive rights in the specified country/ies
03: Not for sale in the specified country/ies.
<Territory>



<CountriesIncluded>

Mandatory91Codes de pays ISO 3166-1 Alpha-2Countries included in the territory. E.g.: CA FR
<RegionsIncluded>

WORLDWORLD: All available countries on the platform.
</Territory>



</SalesRights>



<SalesRestriction>



<SalesRestrictionType>Optional7100; 06; 07; 09;

00 : Library offer internal id (see SalesRestrictionNote)
06 : Library-market product (see PriceQualifier)
07 : School-library product (see PriceQualifier)
09 or empty : Consumer-market product

<SalesRestrictionNote>Optional
offer_id={id}

offer_id={id}
{id} : Library offer internal id

</SalesRestriction>



</PublishingDetail>



<RelatedMaterial>



<RelatedProduct>Repeat


<ProductRelationCode>Mandatory

51

00
01
02
03
05
06
07
08
09
10
11
12
13
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35		00: Unspecified
01: Includes
02: Is part of
03: Replaces
05: Is replaced by
06: Alternative format
07: Has ancillary product
08: Is ancillary to
09: Is remaindered as
10: Is remainder of
11: Is other-language version of
12: Publisher’s suggested alternative
13: Epublication based on (print product)
16: POD replacement for
17: Replaced by POD
18: Is special edition of
19: Has special edition
20: Is prebound edition of
21: Is original of prebound edition
22: Product by same author
23: Similar product
24: Is facsimile of
25: Is original of facsimile
26: Is license for
27: Electronic version available as
28: Enhanced version available as
29: Basic version available as
30: Product in same collection
31: Has alternative in a different market sector
32: Has equivalent intended for a different market
33: Has alternative intended for different market
34: Cites
35: Is cited by
<ProductIdentifier>



<ProductIDType>Mandatory501; 02; 03; 1501: Custom
02: ISBN 10
03: EAN
15: ISBN 13
<IDValue>Mandatory
NumberIdentifier's value
</ProductIdentifier>



</RelatedProduct>



</RelatedMaterial>



<ProductSupply>





<Market>



<Territory>



<CountriesIncluded>

Codes de pays ISO 3166-1 Alpha-2Countries included in the territory. E.g.: CA FR
 </Territory>



 </Market>



<SupplyDetail>



<Supplier>



<SupplierRole
9301; 0601: Publisher to retailers
06: Publisher's distributor to retailers
<SupplierIdentifier>



<SupplierIDType>MandatorySupplierIDType06;06: GLN
<IDValue>MandatoryIDValueNumberPublisher / distributor internal id
</SupplierIdentifier>



<SupplierName>

TextPublisher name
<Website>



<WebSiteRole>Mandatory73
01: Publisher’s corporate website
<WebSiteLink>Mandatory

URL
</Website>



</Supplier>



<ProductAvailability>Mandatory6520; 4020: Available
40: Not available
<SupplyDate>



<SupplyDateRole>
166808: Expected availability date (Available at date)
<DateFormat>
55000: YYYYMMDD
<Date>

Date. ISO 8601Date
</SupplyDate>



<Price>Repeat


<PriceType>Mandatory5803; 0403: Fixed retail price excluding tax
04: Fixed retail price including tax
<PriceQualifier>Mandatory5905; 10; 11; 14; 16

05: Price for consumer sales (note : this value is used in some cases by Cantook Hub for library products intended for public, academic or corporate libraries, for sake of backward-compatibility with external integrations)
10: Price for public and school libraries. With SalesRestrictionType 06.
11: Price for classroom usage. With SalesRestrictionType 07.
14: Price for school libraries (primary and high school). With SalesRestrictionType 07.
16: Price for public libraries. With SalesRestrictionType 06.

<PriceStatus>Mandatory6102;02: Firm
<PriceAmount>Mandatory
AmountE.g.: 20,85
<CurrencyCode>Mandatory96Currency code. ISO 4217E.g.: EUR
<Territory>



<CountriesIncluded>Mandatory
Country code with 2 characters ISO 3166-1 Alpha-2
or
WORLD		Country where the price is available. Could list many countries separated by a space e.g.: CountriesIncludedUS CA/CountriesIncluded
For a price that applies to all the countries, the keyword WORLD can be use.
</Territory>



<PriceDate>



<PriceDateRole>Mandatory
1414: From date
<DateFormat>Mandatory
000: YYYYMMDD
<Date>Mandatory
Date. ISO 8601Date is provided in ISO 8601 Basic format. Although the DateFormat is not in this particular format, it is the closest to this standard. E.g.: "2010-05-27T11:44:24+01:00"
</PriceDate>



</Price>



</SupplyDetail>



</ProductSupply>



</Product>



</ONIXMessage>