What is the Read API 2.0?

The Read API 2.0 allows suppliers (reading their own item data) or recipients (reading items published to them) to retrieve item data from the Item Management platform via an M2M API. This is essentially a READ API for the Item Management platform.

The Read API 2.0 supports the following output formats.

  • JSON

The following are supported via the Read API 2.0

  • Searching can be done by
    • GLN (Information Provider)
    • GTIN
    • Last Changed Date
    • Target Market

The Read API 2.0 is a new implementation of the 1WorldSync’s Read API (previously know as the Marketplace API). The new API was released in April 2023 to existing and new users of the Read API in Beta. Please note the API is production ready, but will remain in Beta status until the previous version is sunset in early 2024 (final sunset date has not been set yet). This API will allow developers to read item data existing in the Item Management platform (and the 1WorldSync data pool) for their supplier or recipient GLNs.

What are the differences between the original API and the new API? The original API had some limitations which the new API aims to address.

Original API

  • Roughly based on the existing GDSN standard, but did not strictly follow this standard
  • Include some, but not all GSDN attributes
  • Did not include 1WorldSync Top Off attributes
  • Large databases could take some time to read due to the Search then Fetch architecture
  • Supported a recipient model – suppliers had limited support to read their item data

New API

  • Based on the 1WorldSync data model to more closely match attribute names and structure as it appears in Item Management
  • Includes all GDSN attributes
  • Includes all 1WorldSync attributes
  • Larger databases can be read much more quickly (10x throughput increases)
  • Natively supports Suppliers as well as Recipients and Distributors
  • The existing HMAC based key and secret mechanism will be used for now. This could change in the future to include a bearer token mechanism. For the time being, to simplify migration for existing users, we will continue to support this method.

At some point in the future all existing users of the current Content1 API will be required to migrate to the new Content1 2.0 API. Dates for this have not been finalized yet. This will be dependent on and in collaboration with feedback from current users.

If you are an existing Read API customer you may request access by clicking here .