Quickstart

The OrderPulse API is organized around predictable REST resources. All requests are made over HTTPS to sync.orderpulse.shop and authenticated with a bearer token.

Authentication

Pass your secret key in the Authorization header. Keys are environment-scoped (sk_test_ / sk_live_).

curl https://sync.orderpulse.shop/api/v2/inventory \
  -H "Authorization: Bearer sk_live_…"

Create an order

Stock is reserved atomically. Supply an Idempotency-Key so retries never create duplicates.

POST /api/v2/orders
{
  "channel": "marketplace_a",
  "sku": "AP-2290-BLK",
  "qty": 2
}

Delta sync

Keep large catalogs fresh by pulling only what changed since your last cursor.

GET /api/v2/inventory?cursor=eyJvZmZ…

Webhooks

Subscribe once and receive a single normalized event schema for every channel: order.created, order.updated, inventory.changed. Each delivery is signed with X-Sync-Token.

SDKs

Official clients for Node, Python and Go wrap auth, retries and pagination. npm i @orderpulse/node