Guides
Request headers
Request headers
All merchant API operations use POST to {docsEnv.apiBaseUrl}/{FUNCTION_NAME} with JSON bodies.
Authentication (required)
| Header | Example | Notes |
|---|---|---|
Authorization | Bearer clwy_test_… | Recommended |
x-clearway-api-key | clwy_test_… | Alternative to Bearer |
See Authentication.
Correlation
| Header | Required | Purpose |
|---|---|---|
x-cid | No | Correlation id for support trails — echo in logs and audit |
Pass a stable id per logical user action (checkout session creation, webhook handler run, etc.).
Multi-brand
| Header | Required | Purpose |
|---|---|---|
x-brand-id | When multi-brand | Platform brand slug for order/list filters and brand-scoped reads |
Required for some operations (for example GET_ORDER) when your account sells under multiple platform brands.
Idempotency (writes)
| Header | Required | Purpose |
|---|---|---|
Idempotency-Key | Recommended on money-moving ops | Safe retries — see Idempotency |
Content type
| Header | Value |
|---|---|
Content-Type | application/json |
Next steps
- Orders and revenue —
x-brand-idwith orders - Errors — gateway and handler error codes
- API Reference
Last modified on