Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added to ProductAvailability: Announcements, effective from 1 Dec 2022

...

Document revision history

Date

Version


 

v 3.5Added to ProductAvailability: Announcements, effective from 1 Dec 2022

 

v 3.4Cancel an order is no longer supported

 

v3.3Added to 5.3.7:  RelatedProduct

 

v3.2

Timezone: CET/CEST (= UTC+2) added at 4.2 Catalogue metadaata in ONIX 3 format - modifiedfrom

 

v3.1
  • Major revision, chapters renumbered
  • ONIX explanation added
  • Reset download links explained
  • New feature: order cancelation (in 7-day window)
  • Reseller client dashboard updated
  • References to Luisterhuis ProductID changed to EAN13
  • App API removed

 

v3.0 

Draft

  • App API renamed
  • Support for Ecosystem clients removed, now in separate document

 

v2.8
  • New v3 endpoints to replace v2
  • endpoints Changes in default LIMIT and OFFSET values

 

v2.7
  • Updated ONIX examples (chapter 4, chapter 12).
  • Improved explanation Inventory API (chapter 4.3).
  • Wrong chapter number references corrected.

 

v2.6Facetted search (chapter 4) deprecated and phased out. Removed from documentation.

 

v2.5
  • New stub endpoints (stub-www replaces stub.www; stub-rest replaces stub.rest).
  • New ONIX 3.0 /v2/feed endpoints added (Chapter 4). Please note: old endpoints will be phased out. Textual changes: settlement renamed to monthly settlement; extra explanation about different usage modes and business models.
  • Usage API added (chapter 8)

 

v2.4
  • Settlement API added (chapter 7) Textual changes
  • Wrong URL in earlier documentation: all restful end points changed to rest.luisterhuis.nl

 

v2.3Textual changes

 

v2.2
  • Support for retrieving metadata for all products in a single inventory call (chapter 4.4)
  • Extra value 'CustomerID' in API call submitOrder (chapter 5.4)
  • New features Luisterhuis portal for resellers (reactivate download link, csv download) Support for apps Support for Ecosystem clients
  • Support for private content
  • feeds Updated ONIX and XML examples

 

v2.1
  • Support for NSTC (Dutch equivalent for ISTC) in ONIX 3 metadata
  • Additional audiobook metadata (square images, update date/time images, mp3 files)

 

v2.0
  • Rewritten documentation, now including description of 2 interface scenarios
  • New API function: update by date
  • Deprecated API function: send downloadlink by email removed from documentation

 

v1.4New API function: orders accepted by product ID or EAN13

 

v1.3New API function: send download link by email

 

v1.2Bug fixes

 

v1.1Stub (testing) environment added

 

v1.0 First release

...

Note

The audiobook may be enabled for sale only when <ProductAvailability> is 20 As soon as the <ProductAvailability> value changes to 40, the title needs to be disabled for sale in the web shop.

Behaviour of Announcements:

  1. For audiobooks where the CB Online life cycle is set to ‘Aangekondigd’ (Announced), the ONIX element <ProductAvailability> will contain 10 and <PublishingStatus> will contain 02.
  2. The expected delivery date of the complete audiobook (Expected availability date) is passed through <SupplyDate> and the <SupplyDateRole> with the value 08.
  3. The formal publication date is specified in <PublishingDate> with a <PublishingDateRole> 01.
  4. As soon as the life cycle in CB Online is set to 'Verschenen’ (Available), the element <ProductAvailability> will contain 20 and <PublishingStatus> will contain 04. <SupplyDate> with a <SupplyDateRole> 08 will then contain the delivery date of the complete audiobook (Expected availability date).
Code Block
languagexml
titleExample ONIX elements for an announcement
<ProductSupply>
<SupplyDetail>
  <ProductAvailability>10</ProductAvailability>
  <SupplyDate>
   <SupplyDateRole>08</SupplyDateRole>
   <Date dateformat="00">20221005</Date>
  </SupplyDate>
</SupplyDetail>
</ProductSupply>

<PublishingDetail>
<PublishingStatus>02</PublishingStatus>
<PublishingDate>
  <PublishingDateRole>01</PublishingDateRole>
  <Date dateformat="00">20221103</Date>
</PublishingDate>
</PublishingDetail>

Comments:

  • The publication date in the ONIX (<PublishingDate> with <PublishingDateRole> 01) may differ from the actual publication date, because of the following: if Bureau ISBN has not yet carried out the editorial check, the publisher can modify the publication date and updates will be specified in the ONIX for resellers. After Bureau ISBN has carried out the editorial check, the publication date is fixed. If in doubt, contact the publisher.
  • Announced audiobooks will not always have an audio sample, cover image, and/or sales price. The description and subject classification may also still be incomplete. As soon as the title has been published (<ProductAvailability> 20) there is always an audio fragment and cover image available, and the metadata has been checked and complete.
  • Orders for announced audiobooks will not be processed. These orders give an error. The web shop must therefore make its own provision for the possible registration of pre-orders. Orders will only be processed for audiobooks with a <ProductAvailability> 20.


API for order placement

When to place an order

...