Docs
  • Purple Dot Overview
  • Getting Started
  • Shopify app integration
    • Installing our Shopify App
  • Platform Integration with Shopify
    • Connect to Shopify
    • Integrate Purple Dot with your Storefront
      • Integrate into Shopify Themes built with Liquid
        • Minimum Theme Requirements
      • Integrate into Shopify Headless Storefronts
        • Integrate into Shopify Hydrogen Storefronts
    • Configure Shipping Rates
    • Test the Platform Integration
    • Pre-order Tracking
    • Migrating from our Shopify App
  • Platform Integration with Salesforce
    • Integrate Purple Dot with Salesforce
      • Upgrading to 2024-08-29
  • Platform Integration With Other Platforms
    • Integrate into Another Platform
  • Platform Integration References
    • Public API
      • /waitlists
      • /availability
      • /products/preorder-state
      • /variants/preorder-state
      • /pre-orders
    • Private API
      • /waitlists
      • /pre-orders
      • /pre-orders/count
      • /pre-orders/count-units/sku/:sku
      • /inventory
      • /fulfillment-orders
      • /fulfillment
Powered by GitBook
On this page
  1. Platform Integration References
  2. Public API

/waitlists

PreviousPublic APINext/availability

Last updated 1 month ago

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:

curl --request GET \
  --url 'https://www.purpledotprice.com/api/v1/waitlists?api_key=<...>
{
  "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"
      }
    }
  ]
}
GET /waitlists