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.
inventory:readGrant 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
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.