API

The API section in the SAPIENT GUI is dedicated to the tools, resources, and functionalities for developers to integrate and interact with the shipping system programmatically.

This section allows external applications to communicate with the shipping software, providing access to the features like webhooks, centralised repository of countries, currencies and time zones, and detailed API documentation. It is a crucial component for businesses looking to automate their shipping processes and enhance interoperability with other systems.

API components

In this section, you can find information on the following components:

Credentials

Authentication details required to create and access the shipping API, including API keys, tokens, or OAuth credentials. Ensures only authorised users or applications can make requests to the API.

Documentation

Detailed reference materials on how to use the shipping API, including endpoints, request/response formats, error handling, and example use cases.

Reference Data

Standardised read-only reference data for shipping attributes, including lists of countries, supported currencies, and time zone information. Essential for correct address formatting, currency conversions, and scheduling.

Webhooks

Set up tracking webhooks, tracking accounts, and manifest webhooks. Enables asynchronous communication between SAPIENT and external applications.

Accessing reference data

How to Access Reference Data

To access the reference data, perform the following steps:

In the left navigation panel, select API > Reference Data
In the dropdown menu that opens, choose any of the following options:
- Countries
- Currencies
- Time Zones

Updated 17 days ago