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. Private API

/pre-orders/count

Previous/pre-ordersNext/pre-orders/count-units/sku/:sku

Last updated 9 months ago

Count all pre-orders.

Request:

  • created_at_min (ISO8610 timestamp) - Count pre-orders created since the given time

  • updated_at_min (ISO8610 timestamp) - Count pre-orders updated since the given time

  • skus (string) - Comma separated list of product variant SKUs

  • all_line_items (string) - Count pre-orders where every line item is any of these comma separated states. Currently supported are cancelled and exported

  • some_line_item (string) - Count pre-orders where at least 1 line item is any of these comma separated states. Currently supported are cancelled and exported. Cannot be used in conjunction with all_line_items

Body:

  • count - The number of pre-orders that meet the requested criteria

Examples:

curl --request GET \
     --url 'https://www.purpledotprice.com/admin/api/v1/pre-orders/count?created_at_min=2023-08-17T00:00:00.000Z&all_line_items=cancelled&skus=TEST1&limit=1' \
     --header 'X-Purple-Dot-Access-Token: <access_token>'
{
  "meta": {
    "result": "success"
  },
  "data": {
    "count": 1
  }
}
GET /pre-orders/count