Comparing ONIX 3.0 and 2.1 Codelists / Deprecated 2.1 Elements

ONIX 2.1 became static as of ONIX CodeList Issue 36 – see more information here.  There are 2 types of code lists relevant to that change. 

  • Code lists that are unique to ONIX 2.1 that are replaced or made redundant by a separate code list or change unique to ONIX 3.0.  These code lists are already static with no change since 2014 or eariler.
  • Code lists that are shared by ONIX 3.0 and ONIX 2.1.  These code lists are expected to end for ONIX 2.1 with Issue 36 and remain static thereafter.  Any development on these code lists for Issue 37 or beyond will only apply to ONIX 3.0.

The balance of the code lists are unique to ONIX 3.0 and not listed here.

A big caveat:  If EDItEUR set up a new code list it's because the "design" of ONIX data exchange has almost certainly changed.   This should NOT be used for mapping to ONIX 3.0 but can be used as a starting point to help you understand where the data stored in ONIX 2.1 has shifted to in 3.0.   You'll even find there are changes in code lists shared between 2.1 and 3.0 that predate those forced by ONIX 2.1 becoming static with Issue 36. 

Code lists in each version are distinct and should be treated as distinct.

ONIX 3.0 is a new standard with improved data handling and accuracy.  All (useful) data stored to support ONIX 2.1 will have a place in ONIX 3.0 but it might not be presented identically.  The mapping from your data set to ONIX 2.1 should be different than your mapping to ONIX 3.0 in many (but not all) cases.

ONIX 2.1 only code lists and their 3.0 only equivalent, including code lists that are withdrawn or redundant in ONIX 2.1

ONIX 2.1 only
Code List
ONIX 2.1 NameONIX 3.0 equivalent
2Reason for deletion code This code list was never defined and no codes were established for that purpose. The code list number was defined for a separate purpose in ONIX 3.0.Reason for deletion is a free text field in ONIX 3.0
Code List 2 is used for  the ONIX 3.0 only list "Product Composition"
6Barcode indicator

141 Barcode indicator
142 Position on product

7Product form150 Product form
8

Book form detail. Long deprecated and replaced in 2.1 by 78 Product Form Detail 

175 Product form detail 
10Epublication type code175 Product form detail 
11Epublication format code175 Product form detail 
20Conference role This list had no role codes defined for it in ONIX 2.1 and therefore was never used. In ONIX 3.0 Conference has been deprecated and and replaced by the Event composite. This unused list number has become a 3.0 only list. Now used for ONIX 3.0's Code List 20 as "Event role."
26Main subject scheme identifier code

ONIX 3.0 uses a single subject schema and identifies a
main subject using the <MainSubject/> reference tag
or <x425/> short tag

27 Subject scheme identifier

33Other text type code153 Text type
35Text link type codeno requirement in 3.0 – included as URL specific elements
38Image/audio/video file type code178 Supporting resource file format
39Image/audio/video file format code178 Supporting resource file format
40Image/audio/video file link codeno requirement in 3.0 – included as URL specific elements
47Rights region Long deprecated and replaced in 2.1 by 49 Region code49 Region Code
52Supply-to-region Long deprecated and replaced in 2.1 by 91 & 49 based "Supply-to-" elements in Supply Detail.

ONIX 3.0 uses the Territory composite within Market to define the equivalent area for the Supply Detail.

91 Country Code / 49 Region Code

54Availability code Used in ONIX 2.1 but long replaced by 65 Product availability which is designed to work with 64 Publishing Status.

65 Product availability
64 Publishing status 

56Audience restriction flag Seldom used in NAm 2.1 files where 59 Price type qualifier is common. 59 Price type qualifier
63Intermediary supplier availability No 2.1 use is possible as the code list was never developed.63 Intermediary availability code is deprecated in ONIX 3.0 and will be removed in a future release.
67Market date role163 Market date role code
75Person date role177 Person / organization date role
78Product Form Detail175 Product Form Detail
94Default linear unitno requirement in 3.0 – cannot provide default unit
95Default unit of weightno requirement in 3.0 – cannot provide default unit
101Person name identifier type44 Name code type All name identifier versions (sender, contributor, publisher, etc.) use List 44 in ONIX 3.0.
138Transliteration scheme code use to support transliteration attribute 121 Text script used for attribute textscript only
140Withdrawn CPSIA choking hazard warning code used in Product Form feature. Replaced in 2.1 and 3.0 by List 143143 US CPSIA hazard warning code

 

ONIX 3.0 code lists that are shared with ONIX 2.1. 
Note that ONIX 2.1 is "locked" at Issue 36 and codes added for Issue 37 and beyond are for ONIX 3.0 use only.

List numberONIX 3.0
Use current issue
ONIX 2.1
Use Issue 36
1Notification or update type codeNotification or update type code
3Record source type codeRecord source type code
5Product identifier type codeProduct identifier type code
9Product classification type codeProduct classification type code
12Trade category codeTrade category code
13Series identifier type codeSeries identifier type code
14Text case flag
used with attribute textcase
Text case flag elements using this are deprecated / used with attribute textcase
15Title type codeTitle type code
16Work identifier type codeWork identifier type code
17Contributor role codeContributor role code
18Person / organization name typePerson / organization name type
19Unnamed person(s)Unnamed person(s)
21Edition type codeEdition type code
22Language role codeLanguage role code
23Extent type codeExtent type code
24Extent unit codeExtent unit code
25Illustration and other content type codeIllustration and other content type code
27Subject scheme identifier codeSubject scheme identifier code
28Audience code type value Audience codeAudience code also used as Audience code type value
29Audience code typeAudience code type
30Audience range qualifierAudience range qualifier
31Audience range precisionAudience range precision
32Complexity scheme identifier codeComplexity scheme identifier code
34Text format code
used with attribute textformat
Text format code use with the attribute textformat is recommended
41Prize or award achievement codePrize or award achievement code
42Text item type codeText item type code
43Text item identifier type codeText item identifier type code
44Name code typeName code type
45Publishing role codePublishing role code
46Sales rights type codeSales rights type code
48Measure type codeMeasure type code
49Region codeRegion code formerly Rights territory code
50Measure unit codeMeasure unit code
51Product relation codeRelation code
53Returns conditions code typeReturns conditions code type
55Date format use as the attribute dateformat is recommendedDate format use as the attribute dateformat is recommended
57Unpriced item type codeUnpriced item type code
58Price type codePrice type code
59Price type qualifierPrice type qualifier
60Unit of pricing codeUnit of pricing code
61Price status codePrice status code
62Tax rate, codedTax rate, coded
64Publishing statusPublishing status
65Product availabilityProduct availability
66BISAC returnable indicatorBISAC returnable indicator
68Market publishing statusMarket publishing status
69Agent roleAgent role
70Stock quantity code typeStock quantity code type
71Sales restriction type codeSales restriction type code
72Thesis type codeThesis type code
73Website roleWebsite role
74Language code – ISO 639-2/BLanguage code – ISO 639-2/B
76Product form feature value – DVD region codesProduct form feature value – DVD region codes
77US and Canada (excluding Québec) school or college gradeUS and Canada (excluding Québec) school or college grade
79Product form feature typeProduct form feature type
80Product packaging typeProduct packaging type
81Product content typeProduct content type
82Bible contentsBible contents
83Bible versionBible version
84Study Bible typeStudy Bible type
85Bible purposeBible purpose
86Bible text organizationBible text organization
87Bible reference locationBible reference location
88Religious text identifierReligious text identifier
89Religious text feature typeReligious text feature type
90Religious text feature codeReligious text feature code
91Country code – ISO 3166-1Country code – ISO 3166-1
92Supplier identifier typeSupplier identifier type
93Supplier roleSupplier role
96Currency code – ISO 4217Currency code – ISO 4217
97Bible text featureBible text feature
98Product form feature value – binding or page edge colorProduct form feature value – binding or page edge color
99Product form feature value – special cover materialProduct form feature value – special cover material
100Discount code typeDiscount code type
102Sales outlet identifier typeSales outlet identifier type
121Text script used for attribute textscript onlyText script used for attribute textscript only (added in revision 04)
139ONIX retail sales outlet IDsONIX retail sales outlet IDs
143US CPSIA hazard warning codeUS CPSIA hazard warning code
176Product form feature value – operating systemProduct form feature value – operating system
184Product form feature value – EU Toy Safety Directive hazard warningProduct form feature value – EU Toy Safety Directive hazard warning
196Product form feature value – E-publication Accessibility DetailsProduct form feature value – E-publication Accessibility Details
203Audience code type value – ONIX Adult Audience ratingAudience code type value ONIX Adult Audience rating
204Returns conditions code value -- ONIX Returns conditions codeReturns conditions code value -- ONIX Returns conditions code
227Audience range qualifier – Chinese School Grade CodeAudience range qualifier Chinese School Grade Code

Graham Bell of EDItEUR answered a similar question (a request for a list of deprecated ONIX 2.1 elements) this way:

The simple answer is that none of the deprecated elements of ONIX 2.1 are present in 3.0. Deprecation is an indication that a particular field can be done a better way, even within 2.1, and most of the fields deprecated in 2.1 have preferred alternatives in 2.1. In almost all cases, it is these preferred alternatives that were then carried forward into ONIX 3.0. Thus, if your 2.1 has been updated to avoid the deprecated elements, the transition to using 3.0 is that much simpler – your system is half way there already.

There are nearly 50 deprecated elements in 2.1. I’ve listed them below, with their nearest equivalent in ONIX 3.0:

Deprecated element in 2.1 – equivalent field or composite in 3.0

AlternativeFormatEAN13 - use RelatedProduct composite
AlternativeFormatISBN - use RelatedProduct composite
AlternativeProductEAN13 - use RelatedProduct composite
AlternativeProductISBN - use RelatedProduct composite
Annotation - use TextContent composite
BookFormDetail - use ProductFormDetail
ConferenceDescription - no real equivalent in 3.0 (use TextContent to describe nature of product)
CopublisherName - use Publisher composite
CoverImageFormatCode - use ResourceVersionFeatureType
CoverImageLink - use ResourceLink
CoverImageLinkTypeCode - no equivalent, use URI in ResourceLink
DefaultLinearUnit - no default equivalent, use Measure composite
DefaultWeightUnit - no default equivalent, use Measure composite
Dimensions - use Measure composite
DistinctiveTitle - use TitleDetail composite
DOI - use ProductIdentifier composite
EAN13 - use ProductIdentifier composite
EAN13OfSet - use CollectionIdentifier composite
FormerTitle - use TitleDetail composite
Height - use Measure composite
InterestAge - use Audience composite
IntermediaryAvailabilityCode - use ProductAvailability
ISBN - use ProductIdentifier composite
ISBNOfSet - use CollectionIdentifier composite
ISMN - use ProductIdentifier composite
LanguageOfText - use Language composite
MainDescription - use TextContent composite
OriginalLanguage - use Language composite
OriginalPublisher - use Publisher composite
PrizesDescription - use PrizeStatement
PublisherProductNo - use ProductIdentifier composite
PublisherSeriesCode - use CollectionIdentifier composite
ReplacedByEAN13 - use RelatedProduct composite
ReplacedByISBN - use RelatedProduct composite
ReplacesEAN13 - use RelatedProduct composite
ReplacesISBN - use RelatedProduct composite
ReviewQuote - use TextContent composite
RightsRegion - use Territory within SalesRights composite with list of countries and regions
SeriesISSN - use CollectionIdentifier composite
SponsorName - use CorporateName within Sponsor composite
SupplyToRegion - use Territory with Market or SalesRights composite with list of countries and regions
TextCaseFlag - use textcase attributor
Thickness - use Measure composite
TranslationOfTitle - use TitleDetail composite
UPC - use ProductIdentifier composite
USSchoolsGrade - use AudienceRange composite
Weight - use Measure composite
Width - use Measure composite
AvailabilityCode (not actually deprecated, but *strongly* advised to update) - use PublishingStatus and ProductAvailability

Note that in almost all cases, the ’new’ field or composite is present in 2.1 as well as 3.0, and if you are still using 2.1, you really should be using the new alternative instead of the deprecated field. All of these have been deprecated for at least a decade, and most for 15 years. And of course in 3.0, you must use the new field or composite because the deprecated field is not present in 3.0.

One more note. There are a few fields in 2.1 that are used in two different ‘places’ in the data structure. They may be deprecated in one place, and not in the other. In this case, they do NOT appear in the list above. As an example, the ConferenceRole field is deprecated outside the Conference composite (PR.9.2), but is still mandatory and not in any way deprecated inside the Conference composite (PR.9.7).

Graham

Graham Bell

EDItEUR