/variants/preorder-state

GET /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:

• api_key - Your Purple Dot store's public API key

• variant_id- The Shopify handle of the product

Response:

• data

  • state - One of NO_OPEN_WAITLISTS, AVAILABLE_IN_STOCK, ON_PREORDER, SOLD_OUT

  • waitlist - The product's waitlist or null 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.