Public API

Overview

This reference documents the public API that can be used to get information about Waitlists and product availability, both server- and client-side.

Authentication

Include your store's public API key as an api_key query parameter in all requests.

Versioning

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

Response Format

All responses follow a common format:

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

Endpoints

/waitlists

/availability

/products/preorder-state

/variants/preorder-state

/pre-orders