Inbound API Documentation

This guide will explain how to use the Inbound API.

November GDSN Release 2023

Sample pallet/case/each with item adds, item links, and publication.

Sample JSON containing a single item add transaction, link transaction, then publication transaction of that same item to a single recipient.

Examples

To see how to call the Inbound API, explore the Swagger Pages in the side bar under Inbound API Postman Examples, or try the code examples below.

PHP code example

Java code example

Previous Releases

This is a sample xml containing a pallet, case, and each item add transaction. Additionally it contains 2 link transactions to link the pallet to the case, and the case to the each. Finally the pallet level is published to a series of recipients. This is referred to as a “gold” item because it contains all possible attributes on the item add transactions. The second link is the same file, however all fields are not padded out to their maximum lengths, making the file somewhat much smaller.

This is a sample JSON containing a single item add transaction followed by a publication transaction of that same item to a single recipient. This also contains all possible attributes for an item. The second link is the same file, however all fields are not padded out to their maximum lengths, making the file somewhat much smaller.