跳到主要内容
Version: 1.0.0

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:

codeMeaning
0Success
1000Invalid parameters
1001Unknown merchant / missing organization context
1002Invalid signature
1003Waybill already exists
1004Origin could not be matched
1005Destination could not be matched
1006Waybill not found
1007No carrier assigned
1008Package already exists
-1System error

Authentication​

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