Getting started
Errors
Errors use real HTTP status codes and one JSON shape:
{ "status": "error", "code": "not_found", "message": "Order not found." }
Validation errors add the fields:
{ "message": "The status field is required.", "code": "validation_failed", "errors": { "status": ["The status field is required."] } }
| Status | code |
When |
|---|---|---|
| 400 | error |
The request can't be processed as sent. |
| 401 | unauthenticated |
Missing, wrong or revoked key. |
| 403 | insufficient_scope |
The key lacks the permission this endpoint needs. |
| 404 | not_found |
No such record in this store. |
| 409 | order_not_open … |
The record's state doesn't allow it. |
| 422 | validation_failed |
A field is missing or invalid — see errors. |
| 429 | rate_limited |
Over the limit — wait Retry-After seconds. |
| 5xx | — | Our side. Retry later with backoff. |