For the complete documentation index, see llms.txt. This page is also available as Markdown.

Private API

Overview

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

Authentication

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

Versioning

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

Response Format

All responses follow a common format:

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

Endpoints

/waitlists

/pre-orders

/pre-orders/count

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

/inventory

/fulfillment-orders

/fulfillment-orders/:id(uuid)

/fulfillment

/refund

Last updated