/products/preorder-state

GET /products/preorder-state

Get the pre-order state of a whole product. Useful for determining whether a particular product as a whole is on pre-order, for example when displaying a product in a collection grid.

Request query parameters:

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

• handle- 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

    • handle - The product's handle.

Examples:

curl --request GET \
  --url 'https://www.purpledotprice.com/api/v1/products/preorder-state?api_key=<...>&handle=womens-white-sneakers'

{
  "meta": {
    "result": "success"
  },
  "data": [
    {
      "state": "ON_PREORDER",
      "waitlist": {
        "id": "00fe49ba-8e43-4b10-9588-dccaa30f19ac",
        "display_dispatch_date": "Estimated ship date 10–15 Jun",
        "payment_plan_descriptions": null,
        "selling_plan_id": null,
      },
      "product": {
        "id": "4697179062404",
        "product_code": "womens-white-sneakers"
      }
    }
  ]
}