/products/preorder-state
Returns the pre-order state of a whole product. Useful for showing a product's status in a collection grid.
Authorizations
api_keystringRequired
Your store's public API key, from the Integration page of the Purple Dot merchant portal.
Query parameters
handlestringRequiredExample:
The product's Shopify handle.
womens-white-sneakerscountrystringOptionalExample:
The shopper’s country, as an ISO 3166 code.
GBResponses
200
The product state.
application/json
400
Missing or unknown api_key.
application/json
404
No product has that handle.
get/products/preorder-state
GET /api/v1/products/preorder-state?handle=womens-white-sneakers HTTP/1.1
Host: www.purpledotprice.com
Accept: */*
{
"meta": {
"result": "success"
},
"data": {
"state": "ON_PREORDER",
"waitlist": {
"id": "3bbc58c6-9a11-422f-9cf5-6a5ac8468eec",
"state": "OPEN",
"is_scheduled": false,
"launch_date": "2025-05-01T00:00:00.000Z",
"scheduled_pause_date": "2025-06-01T00:00:00.000Z",
"display_dispatch_date": "Shipping 10–15 Jun",
"payment_plan_descriptions": {
"long": "Pay in full now, or pay a deposit now and the rest when it ships",
"short": "Pay a deposit now"
},
"use_extended_delivery_language": false,
"use_partnership_branding": false,
"selling_plan_id": "689468694",
"inventory_location_id": "7a4d2c1e-5b8f-4e36-9a0c-3d1f6b2e8c47",
"product": {
"id": "4697179062404",
"product_code": "womens-white-sneakers"
},
"compatible_checkouts": [
"purple_dot",
"native"
],
"shipping_dates": {
"earliest": "2025-06-10T00:00:00.000Z",
"latest": "2025-06-15T00:00:00.000Z"
},
"cancellation_policy": {
"cancellable_until": "SCHEDULED_PAUSE"
}
}
}
}Last updated