/variants/preorder-state
Get the pre-order state of a variant. Useful for determining whether a particular variant is on pre-order, for example when displaying a call to action on the PDP.
Request query parameters:
api_key
- Your Purple Dot store's public API keyvariant_id
- The Shopify variant id of the product variant
Response:
data
state
- One ofNO_OPEN_WAITLISTS
,AVAILABLE_IN_STOCK
,ON_PREORDER
,SOLD_OUT
waitlist
- The product's waitlist ornull
if there isn't an open waitlist.display_dispatch_date
- The string that should be shown as the estimated dispatch date for the product.
product
- The product that the variant belongs to.handle
- The product's Shopify handle.
Examples:
curl --request GET \
--url 'https://www.purpledotprice.com/api/v1/variants/preorder-state?api_key=<...>&variant_id=55391387124086'
{
"meta": {
"result": "success"
},
"data": {
"state": "ON_PREORDER",
"waitlist": {
"id": "00fe49ba-8e43-4b10-9588-dccaa30f19ac",
"is_scheduled": false,
"launch_date": null,
"selling_plan_id": null,
"display_dispatch_date": "Estimated ship date 1–8 Jul",
"payment_plan_descriptions": null,
"use_extended_delivery_language": false,
"units_left": 1
},
"product": {
"id": "15121333223798",
"handle": "the-complete-snowboard"
}
}
}
Last updated