Developer Docs
Orders
List merchant orders and fetch order detail with fulfillment-ready customer shipping fields.
GET
/api/integrations/v1/orders
List orders
Returns a merchant-scoped list of orders with fulfillment summary and line items.
GET
/api/integrations/v1/orders/:orderId
Get order
Returns a single merchant order by its merchant-scoped order id.
GETRead orders
/api/integrations/v1/orders
List orders
Use this endpoint to poll recently created or updated orders for downstream warehouse or operational syncs.
Query Parameters
Supported inputs for this operation.
status
stringOptionalFilter by merchant order status.
Example: open
created_after
ISO-8601 timestampOptionalReturn orders created after this timestamp.
Example: 2026-03-01T00:00:00.000Z
updated_after
ISO-8601 timestampOptionalReturn orders updated after this timestamp.
Example: 2026-03-12T18:15:00.000Z
limit
integerOptionalMaximum number of rows returned per page.
Example: 25
Default: 50
cursor
stringOptionalOpaque cursor from a previous response page.
| Name | Type | Required | Description |
|---|---|---|---|
| status | string | No | Filter by merchant order status. Example: open |
| created_after | ISO-8601 timestamp | No | Return orders created after this timestamp. Example: 2026-03-01T00:00:00.000Z |
| updated_after | ISO-8601 timestamp | No | Return orders updated after this timestamp. Example: 2026-03-12T18:15:00.000Z |
| limit | integer | No | Maximum number of rows returned per page. Example: 25 Default: 50 |
| cursor | string | No | Opaque cursor from a previous response page. |
Headers
Supported inputs for this operation.
Authorization
Bearer tokenOptionalPreferred API key header. Format: Bearer <secret>.
Example: Bearer rk_live_...
X-API-Key
stringOptionalFallback API key header if Bearer auth is not convenient.
Example: rk_live_...
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | Bearer token | No | Preferred API key header. Format: Bearer <secret>. Example: Bearer rk_live_... |
| X-API-Key | string | No | Fallback API key header if Bearer auth is not convenient. Example: rk_live_... |
Examples
Switch between the sample request and example responses for this endpoint.
Sample cURL
curl -X GET "https://merchants.rarely.co/api/integrations/v1/orders" \
-H "Authorization: Bearer YOUR_API_KEY"GETRead orders
/api/integrations/v1/orders/:orderId
Get order
Use this endpoint when a downstream system needs full order detail for a known order.
Path Parameters
Supported inputs for this operation.
orderId
uuidRequiredMerchant order id returned by the list endpoint.
Example: 9b9a41bc-2a15-46b9-b25b-79bb4d1a2221
| Name | Type | Required | Description |
|---|---|---|---|
| orderId | uuid | Yes | Merchant order id returned by the list endpoint. Example: 9b9a41bc-2a15-46b9-b25b-79bb4d1a2221 |
Headers
Supported inputs for this operation.
Authorization
Bearer tokenOptionalPreferred API key header.
X-API-Key
stringOptionalFallback API key header.
| Name | Type | Required | Description |
|---|---|---|---|
| Authorization | Bearer token | No | Preferred API key header. |
| X-API-Key | string | No | Fallback API key header. |
Examples
Switch between the sample request and example responses for this endpoint.
Sample cURL
curl -X GET "https://merchants.rarely.co/api/integrations/v1/orders/:orderId" \
-H "Authorization: Bearer YOUR_API_KEY"Live PlaygroundClient memory only
Test live requests against your merchant integration API.
The docs app proxies requests server-side to the merchant API. Your API key stays in local browser memory for the current docs session and is never stored by this UI.
Resolved request
https://merchants.rarely.co/api/integrations/v1/orders
Live Output
Switch between the generated request and the most recent live response.
Generated cURL
curl -X GET "https://merchants.rarely.co/api/integrations/v1/orders" \
-H "Authorization: Bearer YOUR_API_KEY"