Status and error codes

Status	Meaning	What to do
`200 OK`	Request succeeded	—
`201 Created`	Resource created	—
`400 Bad Request`	Validation failed	Fix the fields named in `message`
`401 Unauthorized`	Missing, invalid, or expired token	Mint a new token
`403 Forbidden`	Token lacks the required scope, its organization doesn’t match the partner subdomain, or the feature isn’t enabled for the requested country	Check scopes; call the workspace the token belongs to
`404 Not Found`	Resource doesn’t exist in this workspace	Check the ID — IDs from another partner always 404
`422 Unprocessable`	The request was valid but couldn’t be fulfilled (unclassifiable input, a validation-rule rejection on create)	Read `message` / `errors`
`429 Too Many Requests`	Rate limited	Back off and retry with the `Retry-After` header
`5xx`	Something went wrong on our side	Retry with exponential backoff

Error body

Errors are the mirror image of the success envelope — success: false with a human-readable message:

401

{ "success": false, "message": "Missing bearer token" }

403

{ "success": false, "message": "Missing scope: classify:read" }

403

{ "success": false, "message": "Duty calculation is not enabled for XX" }

404

{ "success": false, "message": "Not found" }

Schema validation failures respond 400 with the failing messages joined into message:

400

{
  "success": false,
  "message": "country must be a 2-letter code"
}

One exception: when a calculate request is rejected by your workspace’s country validation rules, the 400 body is an errors array naming each failed rule:

400

{
  "errors": [
    { "code": "US_MAX_VALUE", "description": "Line value exceeds the configured limit" }
  ]
}

404 is also the answer for resources that exist but belong to another partner — the API never reveals whether an ID exists outside your organization.

Authentication

List consignments

⌘I

Overview

Consignments

Classify

Calculate

Restrict

Screen

Request archive

Error body

​Error body

Error body