/waitlists
Last updated
Last updated
Get all open Waitlists. Useful for determining which products have a Waitlist.
Request query parameters:
api_key
- Your Purple Dot store's public API key
Response:
data
- An array containing all the open Waitlists
id
- The Waitlist ID
state
- The Waitlist state
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: