Skip to main content
Use code in your program. message is for people and may change.

Idempotency

Send Idempotency-Key (any unique string) on every POST, PUT and PATCH. A repeat within 24 hours returns the first answer (Idempotent-Replayed: true).
  • The same key on a different call: 422 idempotency_key_reused.
  • A repeat while the first is still running: 409 idempotency_in_progress.
  • With an integrator key, a key also belongs to the store it was used for: the same key for another store is 422 idempotency_key_reused.

Rate limits

60 requests per minute per key (300 for an integrator key). Every reply carries X-RateLimit-Limit and X-RateLimit-Remaining. Bulk updates go through the batch (100 changes per call) or Import the menu (1000 lines per call).

Versioning

The version is in the path (/v1). New fields, events and endpoints are not breaking, so ignore fields you don’t know. Breaking changes come as /v2, with /v1 kept for at least 6 months.