Skip to main content

ONIX Field Requirements

This document lists every ONIX 3.0 element that Publica.la validates when processing an intake. Use it as a checklist before sending files to ensure fast, error-free ingestion.

It complements the high-level ONIX Intake overview and the step-by-step guide for creating a new intake.

Scope
Focus on mandatory or strongly recommended data for marketplace ingestion. Optional ONIX data (e.g. reviews, awards) is out of scope.


Core Metadata

Author

ONIX pathAllowed ContributorRoleNotes
DescriptiveDetail.ContributorA01Multiple authors allowed. Names are concatenated in the order received.

Narrator (Audiobooks)

ONIX pathAllowed ContributorRole
DescriptiveDetail.ContributorE03, E07

Title

ONIX pathRequired TitleTypeMax length
DescriptiveDetail.TitleDetail01255 characters

Description / Synopsis

ONIX pathValidation rules
CollateralDetail.TextContentContentAudience 00 or 03; TextType 02 or 03; no Territory; textformat 02 or 06

External ID (ISBN / GTIN)

ONIX pathAllowed ProductIDType
ProductIdentifier15 (ISBN-13) or 03 (GTIN)

Identifiers & Classification

Language

We accept the following ONIX LanguageCode values. The platform converts them to the ISO 639-1 codes shown in the right column.

ONIXPLA
engen
itait
porpt
spaes
fre / frafr
chi / zhozh
jpnja
gerde
catca
gswde
polpl
glggl
otherundefined (file will ingest but appear with an "Undefined" language flag)

BISAC

ONIX pathRequired SubjectSchemeIdentifier
DescriptiveDetail.Subject10
Up to four BISAC codes are stored. The first code flagged as MainSubject gets top priority.

Keywords

ONIX pathRequired SubjectSchemeIdentifier
DescriptiveDetail.Subject20
Keywords are split on , or ;.

Pricing & Availability

Prices

ONIX pathRequired PriceTypeAccepted currencies
ProductSupply.SupplyDetail.Price01 (RRP excl. tax)USD, BRL, ARS, CLP, PEN, UYU, COP, MXN, BOB, EUR, ALL, AMD, AZN, BYN, BAM, BGN, CZK, DKK, GEL, HUF, ISK, MDL, MKD, NOK, PLN, RON, RUB, RSD, SEK, CHF, TRY, UAH, GBP
  • Minimum amounts are validated per currency. A PriceAmount of 0 makes the product free.
  • Only prices scoped to the WORLD territory are considered.

Publishing Status

The latest ONIX value fully overrides previous ones.

ONIX codeInternal status
00unspecified
01cancelled
02forthcoming
03postponed-indefinitely
04active (on sale)
05 – 06withdrawn-from-sale
07out-of-print
08inactive
09unknown
10remaindered
11withdrawn-from-sale
12recalled
13active-but-not-on-sale
15recalled
16 – 17withdrawn-from-sale

Code 04 enables sales only when:

  • The SalesOutlet field contains "Marketplace" (case-insensitive) OR the "Force Show marketplace" flag is enabled in the intake configuration

Codes in the withdrawn group remove products from sale.

Sales Rights

PublishingDetail.SalesRights must include:

  • SalesRightsType 01 or 02
  • Territory.RegionsIncluded = WORLD
    If WORLD is not included, list explicit CountriesIncluded.

File Type

ProductForm values are mapped as follows: EPUBepub, MP3audio, PDFpdf.


Dates & Time

FieldONIX roleFormat
Publication datePublishingDateRole 01YYYY-MM-DD (derived from YYYYMMDD)

Distribution & Sharing

SalesOutlet Identifiers

The parser expects two types of values in SalesOutletIdentifier.IDValue:

  • When the value is marketplace (case-insensitive), the product becomes available in the Publica.la marketplace.
  • When the value is a number, it is treated as a Tenant ID and the product becomes available to that specific tenant.

The accompanying fields IDTypeName (commonly SHOP_ID), SalesOutletIDType, and SalesOutletName are ignored.


X

Graph View