Adi Shipping API error model

RFC 9457 problem document

Failures return a non-2xx status and application/problem+json. Standard fields are type, title, status, detail, and instance. Adi Shipping adds code and resolution for deterministic recovery.

{
  "type": "https://adi-shipping.com/developers/errors/#invalid_reference",
  "title": "Enter a valid shipment reference.",
  "status": 400,
  "detail": "Enter a valid shipment reference.",
  "instance": "/api/v1/tracking.php",
  "code": "invalid_reference",
  "resolution": "Use a known ZIM reference and try again."
}

Stable codes

• invalid_reference — correct the required reference.
• shipment_not_found — verify it or contact support.
• api_not_found — use an OpenAPI path.
• method_not_allowed — use the allowed method.
• rate_limit_exceeded — wait for the advertised reset.
• carrier_unavailable, carrier_response_error, or tracking_not_configured — retry or contact Adi Shipping.

Rate-limit recovery

Read RateLimit-Policy and RateLimit. Compatibility fields are also returned. A 429 includes Retry-After.