🚀 Quickstart

Four steps. At the end you will have read your catalogue, created something, and received an event about it.

Get API access

API access is included in the Pro plan. On another plan, ask NUMU to enable it for your store — we switch it on per merchant, no plan change needed.

Check where you stand:

{ "data": { "allowed": true, "source": "plan", "plan": "pro" } }

Mint a token

In the dashboard: Settings → API & webhooks → Create key. Pick the narrowest scopes that do your job — you can always mint a second token.

The secret is shown once. Put it in your deployment's secret store now.

Confirm it works:

Read something

Every list endpoint pages the same way and wraps its payload in data.

cURL

JavaScript

Python

PHP

Needs catalog:read. A 403 here means the token lacks it — mint one that has it.

Write something, safely

Send an Idempotency-Key on every write. If the response never reaches you, retry with the same key: you get the original result back instead of a duplicate.

cURL

JavaScript

Python

Reuse the key per logical operation, not per HTTP attempt: one key for "create this order", reused by every retry of it.

Hear about what happens next

Polling for changes burns your rate limit and still learns late. Subscribe instead:

Save the secret it returns, then send yourself a test delivery:

Verifying the signature is the only part you must not skip.

Where to go next

Authentication

Scopes, expiry, rotation, and keeping a token safe.

Webhooks

Events, signatures, retries and delivery logs.

Endpoints

All 460, with snippets in four languages.

Errors

What each status means and what to retry.

Where to go next#

Where to go next