> For the complete documentation index, see [llms.txt](https://docs.getpurpledot.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.getpurpledot.com/docs/purple-dot-apis/public-api/variants-preorder-state.md).

# /variants/preorder-state

## Get the pre-order state of a variant

> Returns the pre-order state of a variant. Use it to decide whether to show a pre-order call to action on the product detail page.

```json
{"openapi":"3.1.0","info":{"title":"Purple Dot Public API","version":"v1"},"tags":[{"name":"/variants/preorder-state"}],"servers":[{"url":"https://www.purpledotprice.com/api/v1","description":"Production"}],"security":[{"apiKey":[]}],"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"query","name":"api_key","description":"Your store's public API key, from the Integration page of the Purple Dot merchant portal."}},"schemas":{"Waitlist":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The Waitlist ID."},"state":{"type":"string","description":"On the waitlist endpoints, one of `SCHEDULED` (will start taking pre-orders on `launch_date`), `OPEN` (currently taking pre-orders), `PAUSED` (not terminal, can return to `OPEN`) or `CLOSED` (terminal). On `/products/preorder-state` and `/variants/preorder-state`, the pre-order state of the product or variant, for example `ON_PREORDER`."},"is_scheduled":{"type":"boolean","description":"Whether the Waitlist is not yet live."},"launch_date":{"type":["string","null"],"description":"The date the Waitlist goes live in the storefront."},"scheduled_pause_date":{"type":["string","null"]},"display_dispatch_date":{"type":["string","null"],"description":"The estimated shipping dates shown to shoppers."},"payment_plan_descriptions":{"type":["object","null"],"properties":{"long":{"type":"string"},"short":{"type":"string"}},"required":["long","short"],"description":"Shopper-friendly description of any pre-order payment plan. Platform integrations only; otherwise `null`."},"use_extended_delivery_language":{"type":"boolean"},"use_partnership_branding":{"type":"boolean"},"selling_plan_id":{"type":["string","null"],"description":"The Shopify ID of the linked selling plan. Shopify app integrations only; otherwise `null`."},"inventory_location_id":{"type":["string","null"]},"product":{"type":"object","properties":{"id":{"type":["string","null"],"description":"The product ID in the connected store. On `/products/preorder-state` and `/variants/preorder-state`, the Purple Dot product ID instead."},"product_code":{"type":["string","null"],"description":"The product code in the connected store (for example, Shopify `product.handle`)."}}},"compatible_checkouts":{"type":"array","items":{"type":"string","enum":["purple_dot","native"]}},"shipping_dates":{"type":"object","properties":{"earliest":{"type":"string"},"latest":{"type":"string"}},"required":["earliest","latest"]},"cancellation_policy":{"type":["object","null"],"properties":{"cancellable_until":{"type":["string","null"],"enum":["SCHEDULED_PAUSE",null]}},"required":["cancellable_until"],"description":"The date-based cancellation window. `null` means the pre-order is not cancellable from the shopper’s point of view."}},"required":["id","state","is_scheduled","launch_date","scheduled_pause_date","display_dispatch_date","payment_plan_descriptions","use_extended_delivery_language","use_partnership_branding","selling_plan_id","inventory_location_id","product","shipping_dates","cancellation_policy"]},"AuthErrorResponse":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]},"ErrorResponse":{"type":"object","properties":{"meta":{"type":"object","properties":{"error":{"type":"string","description":"Human-readable message."},"errorData":{"type":"object","additionalProperties":{},"description":"Structured detail about the error."}},"required":["error","errorData"]},"data":{"type":"object","properties":{}}},"required":["meta","data"]}}},"paths":{"/variants/preorder-state":{"get":{"tags":["/variants/preorder-state"],"summary":"Get the pre-order state of a variant","description":"Returns the pre-order state of a variant. Use it to decide whether to show a pre-order call to action on the product detail page.","parameters":[{"schema":{"type":"string","description":"The Shopify variant ID."},"required":true,"description":"The Shopify variant ID.","name":"variant_id","in":"query"},{"schema":{"type":"string","description":"The shopper’s country, as an ISO 3166 code."},"required":false,"description":"The shopper’s country, as an ISO 3166 code.","name":"country","in":"query"},{"schema":{"type":"string","description":"The shopper’s language, as a BCP 47 tag such as `de-DE`. For stores that translate their Waitlists, Waitlist text such as ship dates and payment plans is shown in it when it differs from the store’s own language."},"required":false,"description":"The shopper’s language, as a BCP 47 tag such as `de-DE`. For stores that translate their Waitlists, Waitlist text such as ship dates and payment plans is shown in it when it differs from the store’s own language.","name":"locale","in":"query"}],"responses":{"200":{"description":"The variant state.","content":{"application/json":{"schema":{"type":"object","properties":{"meta":{"type":"object","properties":{"result":{"type":"string","enum":["success"]}},"required":["result"]},"data":{"type":"object","properties":{"state":{"type":"string","enum":["NO_OPEN_WAITLISTS","AVAILABLE_IN_STOCK","ON_PREORDER","SOLD_OUT"],"description":"`NO_OPEN_WAITLISTS`: no live or scheduled Waitlist exists for the variant. `AVAILABLE_IN_STOCK`: a Waitlist exists, but stock in your store sells first, per your Operations settings. `ON_PREORDER`: selling as a pre-order. `SOLD_OUT`: no stock remains in your store or on any Waitlist."},"waitlist":{"allOf":[{"$ref":"#/components/schemas/Waitlist"},{"type":["object","null"],"properties":{"units_left":{"type":"number","description":"Waitlist units still available."}},"required":["units_left"]}],"description":"The open Waitlist, or `null` if none is open."},"product":{"type":"object","properties":{"id":{"type":["string","null"]},"handle":{"type":["string","null"],"description":"The product's Shopify handle."}},"required":["id","handle"]},"requires_components":{"type":"boolean","description":"Whether the variant is a bundle whose components are listed in `components`."},"components":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","enum":["NO_OPEN_WAITLISTS","AVAILABLE_IN_STOCK","ON_PREORDER","SOLD_OUT"]},"waitlist":{"allOf":[{"$ref":"#/components/schemas/Waitlist"},{"type":["object","null"],"properties":{"units_left":{"type":"number","description":"Waitlist units still available."}},"required":["units_left"]}]},"product":{"type":"object","properties":{"id":{"type":["string","null"]},"handle":{"type":["string","null"],"description":"The product's Shopify handle."}},"required":["id","handle"]},"isInStock":{"type":"boolean"}},"required":["state","waitlist","product","isInStock"]}}},"required":["state","waitlist","product","requires_components","components"]}},"required":["meta","data"]}}}},"400":{"description":"Missing or unknown `api_key`. Invalid request.","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/AuthErrorResponse"},{"$ref":"#/components/schemas/ErrorResponse"}]}}}},"404":{"description":"No variant has that ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```
