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 Name | ONIX 3.0 equivalent |
|---|---|---|
| 2 | Reason 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" |
| 6 | Barcode indicator | 141 Barcode indicator |
| 7 | Product form | 150 Product form |
| 8 | Book form detail. Long deprecated and replaced in 2.1 by 78 Product Form Detail | 175 Product form detail |
| 10 | Epublication type code | 175 Product form detail |
| 11 | Epublication format code | 175 Product form detail |
| 20 | Conference 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." |
| 26 | Main subject scheme identifier code | ONIX 3.0 uses a single subject schema and identifies a 27 Subject scheme identifier |
| 33 | Other text type code | 153 Text type |
| 35 | Text link type code | no requirement in 3.0 – included as URL specific elements |
| 38 | Image/audio/video file type code | 178 Supporting resource file format |
| 39 | Image/audio/video file format code | 178 Supporting resource file format |
| 40 | Image/audio/video file link code | no requirement in 3.0 – included as URL specific elements |
| 47 | Rights region Long deprecated and replaced in 2.1 by 49 Region code | 49 Region Code |
| 52 | Supply-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 |
| 54 | Availability 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 |
| 56 | Audience restriction flag Seldom used in NAm 2.1 files where 59 Price type qualifier is common. | 59 Price type qualifier |
| 63 | Intermediary 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. |
| 67 | Market date role | 163 Market date role code |
| 75 | Person date role | 177 Person / organization date role |
| 78 | Product Form Detail | 175 Product Form Detail |
| 94 | Default linear unit | no requirement in 3.0 – cannot provide default unit |
| 95 | Default unit of weight | no requirement in 3.0 – cannot provide default unit |
| 101 | Person name identifier type | 44 Name code type All name identifier versions (sender, contributor, publisher, etc.) use List 44 in ONIX 3.0. |
| 138 | Transliteration scheme code use to support transliteration attribute | 121 Text script used for attribute textscript only |
| 140 | Withdrawn CPSIA choking hazard warning code used in Product Form feature. Replaced in 2.1 and 3.0 by List 143 | 143 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 number | ONIX 3.0 Use current issue | ONIX 2.1 Use Issue 36 |
|---|---|---|
| 1 | Notification or update type code | Notification or update type code |
| 3 | Record source type code | Record source type code |
| 5 | Product identifier type code | Product identifier type code |
| 9 | Product classification type code | Product classification type code |
| 12 | Trade category code | Trade category code |
| 13 | Series identifier type code | Series identifier type code |
| 14 | Text case flag used with attribute textcase | Text case flag elements using this are deprecated / used with attribute textcase |
| 15 | Title type code | Title type code |
| 16 | Work identifier type code | Work identifier type code |
| 17 | Contributor role code | Contributor role code |
| 18 | Person / organization name type | Person / organization name type |
| 19 | Unnamed person(s) | Unnamed person(s) |
| 21 | Edition type code | Edition type code |
| 22 | Language role code | Language role code |
| 23 | Extent type code | Extent type code |
| 24 | Extent unit code | Extent unit code |
| 25 | Illustration and other content type code | Illustration and other content type code |
| 27 | Subject scheme identifier code | Subject scheme identifier code |
| 28 | Audience code type value – Audience code | Audience code also used as Audience code type value |
| 29 | Audience code type | Audience code type |
| 30 | Audience range qualifier | Audience range qualifier |
| 31 | Audience range precision | Audience range precision |
| 32 | Complexity scheme identifier code | Complexity scheme identifier code |
| 34 | Text format code used with attribute textformat | Text format code use with the attribute textformat is recommended |
| 41 | Prize or award achievement code | Prize or award achievement code |
| 42 | Text item type code | Text item type code |
| 43 | Text item identifier type code | Text item identifier type code |
| 44 | Name code type | Name code type |
| 45 | Publishing role code | Publishing role code |
| 46 | Sales rights type code | Sales rights type code |
| 48 | Measure type code | Measure type code |
| 49 | Region code | Region code formerly Rights territory code |
| 50 | Measure unit code | Measure unit code |
| 51 | Product relation code | Relation code |
| 53 | Returns conditions code type | Returns conditions code type |
| 55 | Date format use as the attribute dateformat is recommended | Date format use as the attribute dateformat is recommended |
| 57 | Unpriced item type code | Unpriced item type code |
| 58 | Price type code | Price type code |
| 59 | Price type qualifier | Price type qualifier |
| 60 | Unit of pricing code | Unit of pricing code |
| 61 | Price status code | Price status code |
| 62 | Tax rate, coded | Tax rate, coded |
| 64 | Publishing status | Publishing status |
| 65 | Product availability | Product availability |
| 66 | BISAC returnable indicator | BISAC returnable indicator |
| 68 | Market publishing status | Market publishing status |
| 69 | Agent role | Agent role |
| 70 | Stock quantity code type | Stock quantity code type |
| 71 | Sales restriction type code | Sales restriction type code |
| 72 | Thesis type code | Thesis type code |
| 73 | Website role | Website role |
| 74 | Language code – ISO 639-2/B | Language code – ISO 639-2/B |
| 76 | Product form feature value – DVD region codes | Product form feature value – DVD region codes |
| 77 | US and Canada (excluding Québec) school or college grade | US and Canada (excluding Québec) school or college grade |
| 79 | Product form feature type | Product form feature type |
| 80 | Product packaging type | Product packaging type |
| 81 | Product content type | Product content type |
| 82 | Bible contents | Bible contents |
| 83 | Bible version | Bible version |
| 84 | Study Bible type | Study Bible type |
| 85 | Bible purpose | Bible purpose |
| 86 | Bible text organization | Bible text organization |
| 87 | Bible reference location | Bible reference location |
| 88 | Religious text identifier | Religious text identifier |
| 89 | Religious text feature type | Religious text feature type |
| 90 | Religious text feature code | Religious text feature code |
| 91 | Country code – ISO 3166-1 | Country code – ISO 3166-1 |
| 92 | Supplier identifier type | Supplier identifier type |
| 93 | Supplier role | Supplier role |
| 96 | Currency code – ISO 4217 | Currency code – ISO 4217 |
| 97 | Bible text feature | Bible text feature |
| 98 | Product form feature value – binding or page edge color | Product form feature value – binding or page edge color |
| 99 | Product form feature value – special cover material | Product form feature value – special cover material |
| 100 | Discount code type | Discount code type |
| 102 | Sales outlet identifier type | Sales outlet identifier type |
| 121 | Text script used for attribute textscript only | Text script used for attribute textscript only (added in revision 04) |
| 139 | ONIX retail sales outlet IDs | ONIX retail sales outlet IDs |
| 143 | US CPSIA hazard warning code | US CPSIA hazard warning code |
| 176 | Product form feature value – operating system | Product form feature value – operating system |
| 184 | Product form feature value – EU Toy Safety Directive hazard warning | Product form feature value – EU Toy Safety Directive hazard warning |
| 196 | Product form feature value – E-publication Accessibility Details | Product form feature value – E-publication Accessibility Details |
| 203 | Audience code type value – ONIX Adult Audience rating | Audience code type value – ONIX Adult Audience rating |
| 204 | Returns conditions code value -- ONIX Returns conditions code | Returns conditions code value -- ONIX Returns conditions code |
| 227 | Audience range qualifier – Chinese School Grade Code | Audience 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.0AlternativeFormatEAN13 - use RelatedProduct compositeAlternativeFormatISBN - use RelatedProduct compositeAlternativeProductEAN13 - use RelatedProduct compositeAlternativeProductISBN - use RelatedProduct compositeAnnotation - use TextContent compositeBookFormDetail - use ProductFormDetailConferenceDescription - no real equivalent in 3.0 (use TextContent to describe nature of product)CopublisherName - use Publisher compositeCoverImageFormatCode - use ResourceVersionFeatureTypeCoverImageLink - use ResourceLinkCoverImageLinkTypeCode - no equivalent, use URI in ResourceLinkDefaultLinearUnit - no default equivalent, use Measure compositeDefaultWeightUnit - no default equivalent, use Measure compositeDimensions - use Measure compositeDistinctiveTitle - use TitleDetail compositeDOI - use ProductIdentifier compositeEAN13 - use ProductIdentifier compositeEAN13OfSet - use CollectionIdentifier compositeFormerTitle - use TitleDetail compositeHeight - use Measure compositeInterestAge - use Audience compositeIntermediaryAvailabilityCode - use ProductAvailabilityISBN - use ProductIdentifier compositeISBNOfSet - use CollectionIdentifier compositeISMN - use ProductIdentifier compositeLanguageOfText - use Language compositeMainDescription - use TextContent compositeOriginalLanguage - use Language compositeOriginalPublisher - use Publisher compositePrizesDescription - use PrizeStatementPublisherProductNo - use ProductIdentifier compositePublisherSeriesCode - use CollectionIdentifier compositeReplacedByEAN13 - use RelatedProduct compositeReplacedByISBN - use RelatedProduct compositeReplacesEAN13 - use RelatedProduct compositeReplacesISBN - use RelatedProduct compositeReviewQuote - use TextContent compositeRightsRegion - use Territory within SalesRights composite with list of countries and regionsSeriesISSN - use CollectionIdentifier compositeSponsorName - use CorporateName within Sponsor compositeSupplyToRegion - use Territory with Market or SalesRights composite with list of countries and regionsTextCaseFlag - use textcase attributorThickness - use Measure compositeTranslationOfTitle - use TitleDetail compositeUPC - use ProductIdentifier compositeUSSchoolsGrade - use AudienceRange compositeWeight - use Measure compositeWidth - use Measure compositeAvailabilityCode (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