/waitlists

GET /waitlists

List all waitlists

Request:

• limit (number) - The number of waitlists to retrieve. By default, it's set to 10 but can be set upto 100

• created_at_min (ISO8610 timestamp) - List waitlists created since the given time

• updated_at_min (ISO8610 timestamp) - List waitlists updated since the given time

• starting_after (UUID) - Paginate pre-orders after the given waitlist ID

Headers:

• Link - An IETF RFC 8288 compliant header with links to previous and next page of results for the preorder query.

Body:

• waitlists - An array containing waitlists

  • id - ID used to identify the waitlist inside Purple Dot

  • created_at - The time at which the waitlist was created

  • earliest_ship_date - The earliest date the waitlisted product can ship

  • latest_ship_date - The latest date the waitlisted product can ship

  • state - The state of the waitlist. This can be one of the following:

    • LIVE - Shoppers can start placing preorders for this product if there is no stock in Shopify

    • PAUSED - Shoppers cannot place preorders for this product until the waitlist is unpaused

    • CLOSED - Waitlist is now closed

    • SCHEDULED - Waitlist will be live on the launch date

  • launch_date - Date when the waitlist will be live

  • labels - Labels associated with the waitlist

  • availability - A map of the product & variant-wise sales data

    • product - Sales data for the product

      • product_id - Shopify ID for the product

      • buy_size - Total number of units allocated for preorder

      • committed - Total number of preorder units sold

      • available - Total number of preorder units available for sale

    • variants - An array of the sales data for all the product variants

      • variant_id - Shopify ID of the product variant

      • sku - SKU code of the product variant

      • buy_size - Total number of units of the product variant allocated for preorder (this will be null in the case of a per-product waitlist)

      • committed - Total number of preorder units of the product variant sold

      • available - Total number of preorder units available of the product variant for sale (this will be null in the case of a per-product waitlist)

• starting_after: The ID of the last waitlist in the list which can then be used in the next request

• has_more - Indicates whether there are more orders available to page through

Examples:

curl --request GET \
     --url 'https://www.purpledotprice.com/admin/api/v1/waitlists?limit=1&created_at_min=2023-08-17T00:00:00.000Z' \
     --header 'X-Purple-Dot-Access-Token: <access_token>'

This is how a per-variant waitlist response would look like:

{
  "meta":{
    "result":"success"
  },
  "data":{
    "waitlists":[
      {
        "id":"a2aecc56-ce64-49da-8ce6-099e664d85fd",
        "created_at":"2023-10-27T14:44:09.726Z",
        "earliest_ship_date":"2023-11-25T05:00:00.000Z",
        "latest_ship_date":"2023-12-10T04:59:59.999Z",
        "state":"CLOSED",
        "launch_date":"2023-12-10T00:00:00.000Z",
        "labels":[
          
        ],
        "availability":{
          "product":{
            "product_id":"7257265143861",
            "buy_size":10,
            "committed":3,
            "available":10
          },
          "variants":[
            {
              "variant_id":"42662551519285",
              "sku":"ZTEST",
              "buy_size":10,
              "committed":3,
              "available":10
            }
          ]
        }
      }
    ],
    "has_more":true,
    "starting_after":"a2aecc56-ce64-49da-8ce6-099e664d85fd",
    "previous_cursor":"0c34fc59-8a99-427f-a340-857e1eb9b6d2"
  }
}

This is how a per-product waitlist response would look like:

{
  "meta":{
    "result":"success"
  },
  "data":{
    "waitlists":[
      {
        "id":"c657585b-bfe0-4aca-867d-e2c3399969a3",
        "created_at":"2023-09-20T16:57:55.928Z",
        "earliest_ship_date":"2024-04-08T04:00:00.000Z",
        "latest_ship_date":"2024-04-19T04:00:00.000Z",
        "state":"CLOSED",
        "launch_date":null,
        "labels":[
          
        ],
        "availability":{
          "product":{
            "product_id":"7233472626741",
            "buy_size":10,
            "committed":4,
            "available":10
          },
          "variants":[
            {
              "variant_id":"42591503876149",
              "sku":"TEST-S",
              "buy_size":null,
              "committed":2,
              "available":null
            },
            {
              "variant_id":"42591503843381",
              "sku":"TEST-M",
              "buy_size":null,
              "committed":1,
              "available":null
            },
            {
              "variant_id":"42591503777845",
              "sku":"TEST-L",
              "buy_size":null,
              "committed":1,
              "available":null
            }
          ]
        }
      }
    ],
    "has_more":true,
    "starting_after":"c657585b-bfe0-4aca-867d-e2c3399969a3",
    "previous_cursor":null
  }
}