Poll the checkout queue

Requests to the REST Admin API's Checkout resource that exceed the throttle limit return a 429 too many requests status code and an empty JSON body with the following:

  • Response header X-Checkout-Queue set to true
  • Response header X-Checkout-Queue-Token set to the queue token value
  • _checkout_queue_token cookie set to the queue token value

When a client receives this response, it needs to send requests to the polling endpoint to move ahead in the queue. Typically, a shop's polling endpoint is <shop_domain>/queue/poll.

Polling is typically performed using client-side JavaScript, but could also be implemented in a custom application.

On this page