You can learn how to implement an API client quickly here: Quickstart.
The Shipper API supports two environments:
api.staging.shipper.superdispatch.org. The environment for only test purposes that may be used during the implementation process. In this environment, API clients cannot interact with real carriers.
api.shipper.superdispatch.com. On the production enviroment all your changes are live and visible on Shipper TMS. You'll interact with real data, real carriers.
All the requests must be authenticated by the API client. We rely on the industry standard OAuth 2.0 protocol to grant access, due to its simplicity and ease of implementation.
Access Token that will be used with all requests later, the API client sends an authorization request by providing
password of basic access authentication.
Authentication request and response in the reference: Authenticate an API client.
Use bearer auth with your access token: send an
Authorization header with the value
Bearer <your access token>. Example:
ClientID and ClientSecret
ClientSecret are required to use this API. They can be obtained by sending a request to our Customer Success: [email protected]
We usually prefer to use GUIDs rather than primary keys stored in the database. Some old API endpoints and webhook payloads use
ids but they're deprecated now.
Date and time
All dates and times are formatted using ISO 8601. Examples:
All times in the UTC+0 timezone.