Get the prep state of all items in an order

Summary

Returns the current preparation state of every active item in the order — i.e. for each item: whether it has been picked, how it was picked, the fulfilled quantity, and any amendment that has been applied. Use this to reconcile local picker state with Deliveroo (e.g. on app resume, or after submitting an amendment).

Usage scenario

After amendments have been submitted, or when the picking app restarts, fetch the order-level prep state to rebuild the picking session view.

Notes

  • Items archived by amendments (e.g. fully removed items) are filtered out and will not appear in the response.
  • If batch_context was set when start-picking was called, it is echoed back as a top-level field (only when batch-context persistence is enabled for the site).

Operational constraints

  • There's a rate limit of 1 request per order per second. If you get over the limit, you'll get a "Too many requests" error.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Related order id in format {market}:{order_uuid}.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json