REST API

Authenticate with API keys and push orders from your webstore.

The REST API gives programmatic read and write access to products, inventory, BOMs, work orders, sales and purchase orders, customers, suppliers, tasks, shipping and more. It is JSON over HTTPS at /api, authenticated with Bearer API keys.

API keys

1. An admin creates a key in Settings → Integrations → API keys, choosing read-only or read-write.
2. Copy the secret when it is shown — it is displayed only once and stored only as a hash.
3. Send it as Authorization: Bearer <key>. Keys act within your company only.

curl https://<your-workspace>/api/products \
  -H "Authorization: Bearer pp_live_xxxxxxxxxxxxxxxx"

Pushing webstore orders

POST /api/sales-orders accepts items, discounts, shipping, tax lines and the checkout currency. Amounts must reconcile exactly:

subtotal    = sum(item.quantity * item.unitPrice)
totalAmount = subtotal - discountTotal + shippingCost + taxTotal

Include externalOrder with your store's source and order id. Posting the same source order again updates the existing order instead of duplicating it, and keeps its fulfillment status.