Solid Commerce Docs

ISV / Integrator quickstart

Value: Ship a multi-tenant Solid Commerce integration in days, not months — connect your application to thousands of merchants through a single OAuth-secured REST API and three official SDKs.

Choose this if: You sell software to Solid Commerce merchants and need each customer to install your app once, then keep working without sharing credentials.

What you will build

A working OAuth 2 application that:

  1. Registers as a Solid Commerce ISV.
  2. Drives the authorization-code flow for any merchant.
  3. Calls the Catalog, Orders, and Webhooks APIs on the merchant's behalf.

Prerequisites

1. Install an SDK

npm install @solidcommerce/sdk

2. Drive the OAuth flow

Redirect merchants to the authorize URL:

https://auth.solidcommerce.com/oauth/authorize
  ?response_type=code
  &client_id=YOUR_CLIENT_ID
  &redirect_uri=https://yourapp.example.com/oauth/callback
  &scope=catalog:products:read+orders:orders:read
  &state=<csrf-token>

Exchange the code for a token at /oauth/token (see the Authentication concept for the full sequence).

3. Call the API

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

const client = new SolidCommerceClient({ accessToken: token });
const { data } = await client.raw.GET('/v1/catalog/products', {
params: { query: { limit: 25 } },
});

4. Subscribe to webhooks

Webhooks let your app react to merchant changes without polling. See Webhooks for delivery guarantees and signature verification.

Next steps