Getting Started

Errors

Errors use HTTP status codes and a JSON body with a message written for developers.

Status codes

Status	Meaning
`200` `201` `202`	Success; 201 when a resource was created, 202 when work was queued.
`207`	Partly done: a bulk request where some lines failed (see the body).
`401`	Missing or invalid API key.
`403`	Not allowed: a suspended store, or a store that does not take new orders. Its `code` says why: `no_agent` (no agent past the grace period) or `monthly_orders` (the month's order cap reached).
`404`	No such endpoint, or no such resource in this store.
`405`	The endpoint exists with another method.
`422`	Validation failed, or the action does not fit the resource's state.
`429`	Rate limit reached.
`5xx`	Rassmi's side. Retry later with a backoff.

Validation errors

A 422 lists every invalid field with its messages.

{
    "message": "The customer phone field is required. (and 1 more error)",
    "errors": {
        "customer_phone": [
            "The customer phone field is required."
        ],
        "total_amount": [
            "The total amount field must be a number."
        ]
    }
}

Other errors

{
    "error": "Forbidden",
    "code": "monthly_orders",
    "message": "This store has reached its limit of 3,000 orders this month. New orders resume on the 1st."
}

{
    "message": "The requested endpoint or resource was not found.",
    "error": "Not Found"
}

{
    "error": "Too many requests.",
    "message": "Rate limit exceeded. Maximum 60 requests per minute."
}