Skip to content

Public API Reference

Explore the complete, interactive OpenAPI 3.1 schema for all Developer Platform endpoints.


Manage shop inventory catalogue items, variants, barcodes, and pricing.

Method Endpoint Description Required Scope
GET /products List paginated products with variants and pricing. catalogue.view
POST /products Create a new product. catalogue.manage
GET /products/{uuid} Retrieve detailed single product record. catalogue.view
  • limit (integer, default: 20, max: 100): Number of results per page.
  • search (string): Filter by product title, SKU, or barcode.
  • category_uuid (string): Filter by category.

Check stock counts across branches and post manual adjustments.

Method Endpoint Description Required Scope
GET /inventory List stock on hand per variant and warehouse branch. inventory.view
POST /inventory/adjust Record a stock adjustment (count increase or decrease). inventory.transfer
{
"product_variant_uuid": "01J9X1234567890ABCDEF12345",
"branch_uuid": "01HZX99BRANCH00000000000",
"quantity_change": -5,
"reason": "Damage during transport"
}

Inspect orders placed online or via storefront and update fulfillment status.

Method Endpoint Description Required Scope
GET /orders List paginated merchant orders. sales.view
POST /orders Create an external order. sales.sell
GET /orders/{uuid} Retrieve order details and items line by line. sales.view

Search and manage customer directory records.

Method Endpoint Description Required Scope
GET /customers List customer directory with balances and contact info. customers.view
POST /customers Register a new customer profile. customers.manage
GET /customers/{uuid} Fetch single customer history and balance. customers.view

Merchant settings endpoints for managing outbound webhook subscriptions programmatically.

Method Endpoint Description
GET /settings/webhooks List all registered webhook endpoints and failure metrics.
GET /settings/webhooks/catalog List all subscribable event categories.
POST /settings/webhooks Register a new webhook endpoint (returns secret once).
PUT /settings/webhooks/{uuid} Update target URL, active status, or subscribed events.
DELETE /settings/webhooks/{uuid} Permanently delete a webhook endpoint.
POST /settings/webhooks/{uuid}/ping Dispatch an immediate test ping delivery.
POST /settings/webhooks/{uuid}/rotate-secret Regenerate the webhook’s HMAC signing secret.
GET /settings/webhooks/{uuid}/deliveries Retrieve recent delivery attempts and responses.