Rarely Developer Platform
Merchant-scoped API docs, examples, and live testing.
Integration API v1Public docs

Merchant-scoped API access for warehouses, ops tools, and custom systems.

Rarely merchants create API keys in their portal, choose the scopes they want, and hand those credentials to external systems like 3PLs, ERPs, and analytics tools. The API stays merchant-scoped and versioned, giving external systems a stable integration surface.

Reference Surface

Everything in the current integration API is documented here.

The public docs cover the current merchant integration API surface: merchant-managed keys, authentication, standard error envelopes, and the versioned endpoints for orders, products, inventory, and fulfillments.

Security Model

Keys are scoped to the merchant and the actions they allow.

API keys are merchant-scoped, revocable, and bound to explicit capabilities like orders.read or inventory.write. External systems only get access to the endpoints and operations the merchant approves.

Scoped access
Every request is resolved to one merchant and a fixed set of scopes.
Secret-once keys
Merchants see the secret only when a key is created. Rarely stores only a hash.
Operational writes
Write endpoints support idempotency so retried requests stay safe.
Start Testing

Use the live playground on each reference page.

The playground runs through a server-side docs proxy so you can test real requests without CORS setup in the browser. Your API key stays in local browser memory only for the current docs session.

Fastest flow
  1. 1. Create a scoped key in the merchant portal.
  2. 2. Open the reference page for the endpoint family you want to test.
  3. 3. Paste the key into the playground and send a request.

Search developer docs

Search guides, endpoints, scopes, and parameters.