Skip to content

Build and ship plugins on Orbit Commerce.

Task-based walkthroughs for building a plugin end to end, from your first embedded page to a listing on the marketplace. For the exact endpoints and shapes, pair these with the API reference.

Connecting a warehouse or ERP as a supplier? Start with the Supplier API.

  1. Getting startedWhat an Orbit plugin is, and how to build, embed, and authenticate your first one.
  2. Authentication & tokensSession vs access tokens, the install handshake, and where per-store context comes from.
  3. Store API keysConnect a store's own systems to the API with a merchant-minted key. No partner account, no plugin.
  4. OAuth scopesRequest, consent to, and enforce scopes, plus the singular naming convention.
  5. The SDKOrbitClient: typed REST resources, GraphQL, billing, and iframe helpers.
  6. WebhooksSubscribe to events, verify signatures, and handle deliveries reliably.
  7. B2B / ERP integrationSync companies, buyers, and invoices with an ERP: idempotent upserts, silent user provisioning, incremental polling, and two-way webhook sync.
  8. CSV imports and exportsEvery column of the company, company user, location, cost centre, order, product and customer files, the key each import matches on, and the round-trip rule.
  9. Customer catalogue and pricesWhat one signed-in customer may see and what they pay, B2B catalogues included, for quotes, price lists and product sheets.
  10. Background jobsWork that runs outside the browser: keeping a credential alive, syncing on a schedule, and handling many stores at once.
  11. Storing your own dataYour plugin's own database: what belongs there, why everything is per store, and the query filter that keeps merchants apart.
  12. Customer timelineA customer's history in one list: orders, returns, emails, abandoned checkouts, conversations and what plugins recorded, and how to record your own events on it.
  13. Publishing downloadable filesPut a CSV or ZIP into the store's Files at a link that never changes, and replace it on a schedule.
  14. Testing your pluginInstall your plugin on one of your own development stores and exercise it end to end, served from your machine over a tunnel, before it is reviewed or seen by any merchant.
  15. Development storesFree stores of your own for building and testing plugins: create one from the partner dashboard, open it, add sample data and place test orders that mark themselves paid.
  16. Publishing your pluginSubmit through the partner dashboard and get listed on the marketplace.
  17. MCPAI assistants and the Model Context Protocol at Orbit: the developer, merchant, affiliate and partner surfaces, and where each one stands.