Skip to main content

List Purple Dot Waitlists

GET 

/api/purple-dot/:instance/waitlists

Purple Dot Waitlists mirrored into SKU.io, compared with SKU.io inbound. cap, committed and available sum the Waitlist's variants. sku_io_inbound is the open supply last sent as planned inventory for the Waitlist's products arriving by its latest ship date; is_over_committed is true when the cap is larger (pre-selling more than is coming). is_managed Waitlists carry the sku-io label and can be paused, resumed or closed; others link to the Purple Dot Merchant Portal (merchant_portal_url). state is OPEN, SCHEDULED, PAUSED, DRAFT or CLOSED.

Required scope: inventory:read

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

Filters: filter[search] (name, Purple Dot id, Shopify product id, product SKU or name; narrow with search_columns = id, sku, name, external_id, shopify_product_id and search_strict_columns), filter[id.<operator>] (numeric), filter[state] (comma list), filter[managed] (1|0), filter[mismatch]=1 (over-committed only). Advanced filters: filter_groups = base64 of a JSON tree {conjunction, children:[{type:'condition', condition:{column, operator, value}}]}. Columns: id (numeric), earliest_ship_date, latest_ship_date (date), launch_date (datetime), cap, committed (numeric).

Sorts: id, state, earliest_ship_date (default), cap, committed, available, is_managed.

Request​

Responses​

OK

Response Headers
    Content-Type