Skip to main content

List Purple Dot Pre-orders

GET 

/api/purple-dot/:instance/preorders

Paginated mirror of the connection's Purple Dot pre-orders, newest placed first, with lines, matched products, Waitlists, demand rows (status, warehouse, covering PO line and ETA) and the sales order an export was handed to.

Required scope: inventory:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Search: filter[search] with optional search_columns (id, reference, customer_email, customer_name) and search_strict_columns. filter[id] and filter[id.<operator>] filter on the pre-order id with the numeric operators.

A demand row of an exported line still waiting for its Shopify order reports status awaiting_handoff. Requires the integrations.show permission.

Request​

Responses​

OK

Response Headers
    Content-Type