Alpha Cargo TMS API
The Alpha Cargo TMS API for integrators.
Every server-side request is signed with your organization's API key; see Authentication.
Errors
A failed request answers with a non-2xx status and { "error": "<message>" }.
The message is localized per Accept-Language (en, th, zh).
Organizations set up for the legacy format, and requests sending
X-Legacy-Response: true, get every response in the legacy
envelope instead: HTTP 200 with { code, message, data, extra, success }.
Its code is one of:
| code | Meaning |
|---|---|
0 | Success |
1000 | Invalid parameters |
1001 | Unknown merchant / missing organization context |
1002 | Invalid signature |
1003 | Waybill already exists |
1004 | Origin could not be matched |
1005 | Destination could not be matched |
1006 | Waybill not found |
1007 | No carrier assigned |
1008 | Package already exists |
-1 | System error |
Authentication
- API Key: signature
- HTTP: Bearer Auth
Organization API key + HMAC-SHA256 signature. api_key, nonceStr and sign travel beside the business fields: in the JSON body for POST/PATCH/DELETE, in the query string for GET. See https://docs.alphacargo.io/tms/authentication.
Security Scheme Type: | apiKey |
|---|---|
Query parameter name: | api_key |
Session token of a user signed in to the TMS web app.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |