Errors

Tracksuite uses conventional HTTP response codes to indicate the success or failure of an API request. In general:

• Codes in the 2xx range indicate success. On create, summary, and batch query, also read errors: each tracking is accepted or rejected on its own.
• Codes in the 4xx range indicate the request failed given the information provided. For example, a missing required parameter, an invalid API key, or insufficient units.
• These responses include message. A failed tracking inside a 200 also includes code, which briefly explains that tracking.
• Codes in the 5xx range indicate an error on Tracksuite servers. These are rare.

Attributes

messagestring

Human-readable reason. Present on HTTP errors.

codestring | null

On summary and batch query items. Create errors and HTTP errors do not include it.

referIdstring | null

Business ID of the failed item, when the request used referId.

trackingNumberstring | null

Tracking number of the failed item, when the request used a tracking number.

HTTP status

200	OK	The call ran. On create, summary, and batch query, failed trackings are in errors.
400	Bad Request	Validation failed, a referId is duplicated, an identifier is missing, or units are insufficient.
401	Unauthorized	The API key is missing, invalid, or expired.
403	Forbidden	The user is disabled.
404	Not Found	The tracking or its timeline was not found.
423	Locked	Those referIds are already being enqueued.
500	Server Error	The request could not be completed.

Error codes

• NOT_FOUND

  No tracking exists for this referId or tracking number.

• DETAIL_NOT_FOUND

  The router exists, but the timeline is not available.

• PROCESSING

  An async create has not finished binding a router.

• CREATE_FAILED

  Async create could not bind a router.

• UPDATE_FAILED

  The tracking could not be updated.