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-orders/:id(uuid)
      • /fulfillment
Powered by GitBook
On this page
  • Overview
  • Authentication
  • Versioning
  • Response Format
  • Endpoints
  1. Platform Integration References

Private API

Previous/pre-ordersNext/waitlists

Last updated 16 days ago

This reference documents the private API that can be used to access private data in Purple Dot.

Include your Purple Dot store's private access token as X-Purple-Dot-Access-Token header in all requests.

The API is versioned using a URL prefix. The current version is v1, and all endpoints use the /admin/api/v1/ namespace.

All responses follow a common format:

{
  "meta": {
    "success": true
  },
  "data": /* Response data */
}

/waitlists

/pre-orders

/pre-orders/count

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

/inventory

/fulfillment-orders

/fulfillment-orders/:id(uuid)

/fulfillment

Overview
Authentication
Versioning
Response Format
Endpoints