The public API & SDK for building plugins.
A curated, versioned REST surface at /v1, a rooted OAuth handshake at /oauth, and a typed scope catalogue enforced on every endpoint.
import { OrbitClient } from '@orbitcommerce/sdk';
// Embedded in a merchant's dashboard: the SDK receives that store's
// token + storeId over postMessage, so nothing is hard-coded per store.
const orbit = new OrbitClient();
await orbit.ready();
// Read the catalogue the merchant granted you access to
const { items } = await orbit.products.list({ limit: 20 });From zero to your first API call.
The SDK wraps authentication, the x-store-id header and pagination, so a plugin can read the catalogue in a few lines.
Register as a partner
Create a partner account and your plugin in the Partner Dashboard to obtain credentials.
Complete the OAuth handshake
A merchant installs your plugin and consents to scopes; you exchange the grant at /oauth for a plugin access token.
Call /v1 with your token
Send the Bearer token plus the x-store-id header (or let the SDK do it) and you're reading live data.
Explore the docs.
- API reference
Live OpenAPI viewer. Browse every
/v1endpoint with its request shape and response, driven by the platform's published spec.- GET/v1/products
- POST/v1/orders/{orderId}/fulfillments
- PATCH/v1/customers/{id}
- GET/v1/taxonomies
- POST/v1/webhooks
- OAuth scope catalogue
Every scope string a plugin can request, the naming convention, what each scope grants, and what is intentionally not in the catalogue.
- product:list
- product:read
- order:fulfill
- customer:read
- webhook:create
- blog-post:publish
- cart:adjust
- email:send
- SDK@orbitcommerce/sdk
TypeScript SDK with OrbitClient, products / orders / customers / settings clients, billing helpers and the full OAuth token lifecycle.
(opens in a new tab)npm install @orbitcommerce/sdk
const orbit = new OrbitClient();
- Plugin guides
Build-and-publish walkthroughs: getting started, the OAuth flow, scopes, the SDK, webhooks, and shipping to the marketplace.
- Getting started
- Authentication & tokens
- Store API keys
- OAuth scopes
- Supplier API
For businesses that supply Orbit stores: pull purchase orders, ship parcels, push tracking and stock from your ERP or WMS, and receive signed webhooks.
Authorization: Bearer sup_sk_…
supplier_api:orders:read
- Constellation by Orbit Commerce
The design system and React components the Orbit Commerce dashboard is built with: foundations, components and patterns for plugins that look at home in it.
- Button
- Textarea
- Popover
- and 33 more
The shape of the platform.
Base URL
https://api.myorbitcommerce.net/v1/*- Data APIversioned, rooted
/oauth/*- Token handshakeunversioned, stable across data-API versions
Auth
Bearer token + x-store-id
scoped per merchant install
Authorization: Bearer <token> x-store-id: <storeId>
Ready to build?
Spin up a partner account, install the SDK, and ship your first integration against the live API.