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.
You will get a result that looks like the following:
access_token value and use it as a bearer token with
Authorization header. 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. The date-time values are in millisecond precision and include time offset. For example,
When sending date-time field you can use any offset (e.g.
-05:00). However, the server stores and returns all date-time fields at UTC+0 offset. For example, if you created an order with pickup scheduled date
2019-10-31T10:00:00.000-0500 then when you fetch this order the pickup date will be
2019-10-31T15:00:00.000Z. If you don't get used to work with different timezones then you may be surprised by results for dates around midnight. For example,
2019-11-01T03:00:00.000Z. Pay attention that the 31st of October became the 1st of November.