Skip to content

Connect your warehouse to the vendors you supply.

A REST surface for suppliers on Orbit Commerce. Pull the purchase orders vendors send you, ship them parcel by parcel, push carrier tracking and stock levels from your ERP or WMS, and get a signed webhook the moment a new order lands.

Get startedAPI reference
curl "https://api.myorbitcommerce.net/api/supplier-api/v1/orders?status=sent&limit=20" \
  -H "Authorization: Bearer $ORBIT_SUPPLIER_API_KEY"

The shape of the Supplier API.

Base URL
https://api.myorbitcommerce.net/api/supplier-api/v1
Credential
Bearer sup_sk_…
a supplier API key, minted in the supplier dashboard
Scopes
supplier_api:orders:read · orders:write · stock:write · webhooks:manage
granted per key at creation
Push
Signed webhooks
HMAC-SHA256 over the raw body, per-subscription secret

From a key to a shipped order.

  1. Mint a key

    In the supplier dashboard, open Settings, then API Keys, and create an API key with the scopes your system needs. The key is shown once.

  2. Pull purchase orders

    List orders in the sent state, or subscribe to the purchase order webhook and let Orbit tell you when one arrives.

  3. Ship and track

    Record each parcel against the order lines it carries and send the tracking number. The vendor's order is fulfilled for you.

Walkthroughs, in the order you will need them.

  1. Getting startedWho the Supplier API is for, minting a key in the supplier dashboard, and your first authenticated call.
  2. Purchase orders and shipmentsPull incoming purchase orders, acknowledge them, ship parcels line by line, and push carrier tracking.
  3. Stock updatesPush stock levels for your listings in bulk by SKU from a warehouse system, and how unknown SKUs are handled.
  4. WebhooksGet told the moment a vendor sends or cancels a purchase order: subscribing, verifying signatures, retries and redelivery.
  5. Idempotency, rate limits and errorsRetry writes safely with an Idempotency-Key, stay inside the per-key rate limits, and read every error shape.
  6. API referenceEvery Supplier API endpoint with its request and response shapes, rendered live from the published OpenAPI document.

Building for a store instead of a supplier?

The Supplier API is for businesses that receive purchase orders from Orbit stores. If you are connecting a store's own systems, or building a plugin many stores install, you want the public API instead: start with Store API keys or Getting started with plugins.