API
Errors
Error envelope returned by the Developer API.
Failed requests return HTTP 4xx/5xx with:
{
"error": {
"code": "VALIDATION_ERROR",
"message": "Email is required.",
"doc_url": "/docs/api/errors",
"details": [{ "field": "email", "message": "Email is required." }]
}
}Common codes
| Code | Status | Meaning |
|---|---|---|
UNAUTHORIZED | 401 | Missing or invalid API key |
FORBIDDEN | 403 | Key is missing a scope |
NOT_FOUND | 404 | Resource does not exist |
VALIDATION_ERROR | 400 | Body or query failed validation |
RATE_LIMITED | 429 | Too many requests |
SHOP_UNAVAILABLE | 403 | Shop is closed or suspended |
doc_url always points at this page.