Get the prep state of a single item

Summary

Returns the current preparation state of a single item in the order.

Usage scenario

Spot-check the state of a specific item during a picking session — e.g. after a barcode scan to confirm the upsert succeeded.

Notes

  • Returns 404 ITEM_PREP_STATE_NOT_FOUND when the item exists on the order but no prep state has been written for it yet (prep state is not implicitly initialised).
  • 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 item per second (independent of the PUT bucket below). 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}.

string
required

Item identifier (DRN) for the order item. Use the id returned in the order's items[].

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