Reference

Errors and limits

The response format, status codes and rate limit.

Response format

Every response is JSON with a status of success or error and a message. Successful responses put their result in data; errors put field errors in errors. Send Accept: application/json so errors also come back as JSON.

Validation error

{
  "status": "error",
  "message": "The customer name field is required.",
  "errors": {
    "customer_name": ["The customer name field is required."]
  }
}

Status codes

Code	Meaning
`200`	Success. Also returned for an order whose `external_id` was already received.
`201`	The order or contact was created.
`401`	The key is missing, unknown or revoked.
`404`	A `product_id` or `variant_id` does not exist in this workspace.
`422`	A field failed validation - see `errors`.
`423`	The workspace is suspended.
`429`	Too many requests - see Rate limit.

Rate limit

Up to 120 requests a minute. Past that, requests get 429 until the minute is over, so space out bulk imports.

Questions about building an integration? Open a ticket from the Support Center or contact us.