For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to page URLs; this page is available as Markdown.

/waitlists

GET /waitlists

Get all open Waitlists. Useful for determining which products have a Waitlist.

Request query parameters:

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

Response:

• data - An array containing all the open Waitlists
  • id - The Waitlist ID
  • state - one of:
    • SCHEDULED - to start selling pre-orders, stock levels and Operations settings inside Purple Dot permitting, from launch_date
    • OPEN - is now selling pre-orders, stock levels and Operations settings permitting
    • PAUSED - non terminal state, can be made OPEN in the future
    • CLOSED - terminal state, will not change again
  • display_dispatch_date - The Waitlist estimated shipping dates
  • payment_plan_descriptions - (platform integrations only, otherwise null) Shopper friendly description of your store's pre-order payment plan, if any
  • selling_plan_id - (Shopify app integrations only, otherwise null) The Shopify ID of the selling plan linked to this Waitlist
  • is_scheduled - If this Waitlist is yet to go live in your storefront
  • launch_date: The date this Waitlist goes live in your storefront
  • product - An object containing the Waitlisted product
    • id - The ID of the product used by the connected store, e.g. Shopify product.id
    • product_code - The product code used by the connected store, e.g. Shopify product.handle

Examples:

curl --request GET \
  --url 'https://www.purpledotprice.com/api/v1/waitlists?api_key=<...>

{% code overflow="wrap" %}

{
  "meta": {
    "result": "success"
  },
  "data": [
    {
      "id": "3bbc58c6-9a11-422f-9cf5-6a5ac8468eec",
      "state": "OPEN",
      "display_dispatch_date": "Shipping 10–15 Jun",
      "payment_plan_descriptions": null,
      "selling_plan_id": null,
      "product": {
        "id": "4697179062404",
        "product_code": "womens-white-sneakers"
      }
    }
  ]
}

{% endcode %}