Skip to content

Introduction

Welcome to the Wholechain API Version 2.0 documentation!

We’re excited to introduce this new and improved version of our API, designed to deliver:

  1. Better responses for streamlined and actionable data.
  2. Enhanced troubleshooting capabilities to simplify integration.
  3. Decreased payload weight for greater efficiency.
  4. Improved overall performance to ensure faster and more reliable interactions.

Why Version 2.0?

Version 2.0 reflects our ongoing commitment to creating an API that is lighter, faster, and easier to use. By optimizing how primary data elements and identifiers are managed, this version enhances both performance and clarity while reducing redundancy.

If you are upgrading from Version 1.0, you'll find familiar concepts streamlined for better usability. For those new to Wholechain, this API provides the tools you need to seamlessly integrate traceability operations into your supply chain.

How Primary Data Works

The Wholechain API Version 2.0 facilitates efficient and streamlined management of primary data elements critical to supply chain traceability. These elements are organized into three main categories: To learn more about locating these identifiers within the Wholechain application, please click the links below.

  1. Products Learn More
  2. Locations Learn More

Each object within these categories includes attributes, with certain attributes serving as primary identifiers. These identifiers are essential for referencing specific objects within the API and are clearly defined throughout this documentation. Any attributes not serving as primary identifiers are also specified, ensuring clarity and preventing confusion.

How Primary Identifiers Work

To use primary identifiers effectively:
1. The relevant data—products, locations, or trade partners—must first be created in your Wholechain account.
2. The API will reference this pre-existing data for operations involving these objects.

Example: Creating a New Event

Suppose you have a product in your Wholechain account with the following details:

  • Product Item Code: 123
  • Name: Hake
  • Unit of Measure: KGM

In this case, the API will only require the Product ID (123) as the primary identifier for your API calls. You do not need to include additional data like the product name or unit of measure when adding events through the API.

Why This Matters

This design ensures your API interactions are:

  • Lightweight: Focusing on essential data minimizes payload size.
  • Efficient: Reducing redundancy optimizes performance.
  • Accurate: Leveraging pre-created data reduces the risk of errors.

Throughout this documentation, you'll find clear guidelines on:

  • What constitutes a primary identifier.
  • How to use primary identifiers effectively.
  • How to create events using the primary identifiers

Understanding External, Inbound, and Internal Calls

The API documentation includes three types of data transfers—external API calls, inbound transfers, and internal transfers—each serving a distinct role in Wholechain's traceability platform.

External API Call

An external API call occurs when data is sent from your Wholechain account to an API outside of the Wholechain ecosystem. For example, exporting data to an external system or partner.

Inbound Transfer

An inbound transfer happens when an external traceability partner logs supply chain data directly into your Wholechain account. For instance, a supplier or logistics provider might input their data into your traceability platform, ensuring a collaborative and complete supply chain record.

Internal Transfer

An internal transfer refers to when your own company logs data into your Wholechain account. This allows you, as the account owner, to manage and maintain accurate, up-to-date supply chain records.

These data transfer types are essential for maintaining the integrity and transparency of the Wholechain traceability platform. By enabling seamless collaboration across the supply chain, the Wholechain API Version 2.0 ensures trust, accountability, and efficiency.

Welcome to a faster, better, and more efficient way to manage your traceability operations with Wholechain API Version 2.0! 🚀