Skip to content
Business API

Business API Overview

Run the whole store programmatically. The /business surface powers the admin portal — anything you can click, you can call.

Authentication

Organization JWT — login at /business/identity/login, refresh via token endpoints

Scoped by Organization

Every route enforces organization context and role permissions

Consistent Naming

Routes follow /business/{topic}/... — predictable across all 43 modules

Authentication flow

Organization members log in to receive an access token scoped to their org and role.

# Organization login → accessToken
POST /business/identity/login
# Authenticated requests
Authorization: Bearer <accessToken>
# Example: list orders, upload media, manage pricing
GET /business/orders
POST /business/media/upload
POST /business/pricing/price-lists

What it covers

  • ✓Catalog — products, variants, categories, media
  • ✓Inventory — stock, warehouses, reservations
  • ✓Orders — processing, notes, fulfillment, refunds
  • ✓Pricing — price lists, currencies, regions
  • ✓Promotions — coupons, campaigns, gift cards
  • ✓B2B — companies, quotes, terms, approvals
  • ✓Shipping — carriers, rates, labels, tracking
  • ✓Analytics — dashboards, reports, cohorts
  • ✓Automation — rules, triggers, workflows
  • ✓Webhooks — endpoints, subscriptions, deliveries
  • ✓Migration — import jobs from other platforms
  • ✓Admin — orgs, users, feature flags, audit log

Full endpoint reference

Every business operation — parameters, payloads, and responses — is generated from the OpenAPI spec in the repo.

Browse the API Reference