GraphQL API
Organization API
Organization guide
Errors
Distinguish transport errors, GraphQL errors, and mutation user errors.
GraphQL errors
Syntax, validation, execution, pagination, and query-cost errors normally return HTTP 200 with an errors array. Data may be partial, so handle both keys independently.
{
"data": { "orders": null },
"errors": [
{ "message": "...", "path": ["orders"] }
]
}Mutation user errors
Business and input failures are generally returned inside the mutation payload. Always requestuserErrors { message field } when it is available.
mutation CreateOrder($input: OrderCreateInput!) {
orderCreate(input: $input) {
order { id }
userErrors { message field }
}
}HTTP status codes
400Invalid body, JSON shape, or content type401Missing or invalid access token402Warehouse subscription is inactive or suspended403Insufficient rights or access restriction404Organization, warehouse, or bound resource is unavailable429HTTP request limit exceeded500Unexpected server error