API v1Resources
Integration API
Merchant-scoped API access for warehouses, ops tools, and custom systems. Create keys in the merchant portal, choose scopes, and connect external systems like 3PLs and ERPs.
API reference
Guides, authentication, errors, and versioned endpoints for orders, products, inventory, and fulfillments.
Orders
List merchant orders and fetch order detail with fulfillment-ready customer shipping fields.
Open
Products
Read products and manage native products, variants, SKUs, media links, and catalog data.
Open
Collections
Read collections and manage native collection details, product assignments, and tags.
Open
Social Videos
Read social videos and manage native video metadata and product or collection links.
Open
Inventory
Read inventory by fulfillment location and submit idempotent inventory adjustments.
Open
Fulfillments
Read fulfillment state, create fulfillments, and attach tracking updates.
Open
Keys are scoped to the merchant and the actions they allow.
API keys are merchant-scoped, revocable, and bound to explicit capabilities like orders.read, inventory.adjust, or fulfillments.tracking.write. External systems only get access to the endpoints and operations the merchant approves.
Scoped access
Every request is resolved to one merchant and a fixed set of scopes.
Secret-once keys
Merchants see the secret only when a key is created. Rarely stores only a hash.
Operational writes
Write endpoints support idempotency so retried requests stay safe.
Live playground
Each reference page includes a playground that proxies requests server-side. Your API key stays in browser memory for the session only.
Fastest flow
- Create a scoped key in the merchant portal.
- Open the reference page for the endpoint family you want to test.
- Paste the key into the playground and send a request.