BloomCommerceOS Documentation

Quick start

Jump straight in — pick a starting point. Everything is API-first, so any frontend, channel or AI agent can call the platform.

Getting started

Install the SDK and configure your sandbox key — you'll make your first call in under a minute.

# 1. Install
npm install @bloomcommerceos/sdk

# 2. Set your sandbox key
export BLOOM_KEY=sk_test_••••••••

# 3. List orders
node -e "import('@bloomcommerceos/sdk').then(async ({BloomCommerce}) => {
  const c = new BloomCommerce({ token: process.env.BLOOM_KEY });
  console.log(await c.orders.list({ limit: 2 }));
})"

Authentication

BloomCommerceOS supports OAuth2, JWT and API keys, with scoped tokens and RBAC. Pass a bearer token on every request.

Authorization: Bearer sk_live_••••••••
# Scopes: orders:read orders:write catalog:read marketplace:*

API reference

Every endpoint follows the same shape — description, parameters, multi-language samples, a sample response and error codes. Here's the Orders endpoint.

curl https://api.bloomcommerceos.com/api/v1/orders?limit=2 \
  -H "Authorization: Bearer sk_live_••••••••"

200 OK
{
  "content": [
    { "id": "ord_55120", "status": "PAID",
      "total": { "amount": 4897, "currency": "INR" },
      "customer_id": "cus_3391", "channel": "web" },
    { "id": "ord_55121", "status": "FULFILLED",
      "total": { "amount": 1299, "currency": "INR" },
      "customer_id": "cus_3318", "channel": "mobile-app" }
  ],
  "page": { "limit": 2, "total": 12480, "next": "cursor_eyJvIjoyfQ" }
}

SDKs & libraries

Typed SDKs for every major stack — each with installation, configuration, examples, error handling and best practices.

Built for developers