Solid Commerce Docs

Customer admin quickstart

Value: Replace manual point-and-click busywork with a few lines of code — bulk-update listings, automate order workflows, and run reports on schedule, all from your own scripts or back office.

Choose this if: You are a Solid Commerce merchant with technical staff and you want first-party access to your own data without depending on a third-party ISV.

What you will build

Scripts and back-office automations that:

  1. Authenticate with a long-lived API key scoped to your company.
  2. Read and write your own catalog, listings, orders, and reports.
  3. Subscribe to webhooks for asynchronous events.

Prerequisites

1. Issue an API key

In your Solid Commerce workspace go to Developer → API keys → New (the /developer/keys page). Copy the key once — it is not stored after issue. Pick the smallest scope set that makes the script work.

2. Install the CLI (optional)

The solidcommerce CLI is the fastest way to verify connectivity and run ad-hoc reports:

npm install -g @solidcommerce/cli
solidcommerce auth login --api-key $SOLIDCOMMERCE_API_KEY
solidcommerce catalog products list --limit 10

3. Call the API from a script

import { SolidCommerceClient } from '@solidcommerce/sdk';

const client = new SolidCommerceClient({
apiKey: process.env.SOLIDCOMMERCE_API_KEY!,
});

for await (const product of client.catalog.products.iter({ limit: 100 })) {
console.log(product.id, product.title);
}

4. Bulk operations

Use the bulk endpoints rather than looping on single resources — see Bulk operations.

Next steps