Developer Docs
Products
Read merchant products, variants, SKUs, media, and inventory-linked catalog data.
GET
/api/integrations/v1/products
List products
Returns merchant products with variants, media, and inventory-linked data.
GET
/api/integrations/v1/products/:productId
Get product
Returns a single merchant product with variants and inventory-linked data.
GETRead products
/api/integrations/v1/products
List products
Use this endpoint to sync the merchant catalog into a warehouse or operational system.
Query Parameters
Supported inputs for this operation.
limit
integerOptionalMaximum number of rows returned per page.
Example: 50
Default: 50
cursor
stringOptionalOpaque cursor from a previous response page.
| Name | Type | Required | Description |
|---|---|---|---|
| limit | integer | No | Maximum number of rows returned per page. Example: 50 Default: 50 |
| cursor | string | No | Opaque cursor from a previous response page. |
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/products" \
-H "Authorization: Bearer YOUR_API_KEY"GETRead products
/api/integrations/v1/products/:productId
Get product
Use this endpoint when a downstream system needs the full canonical product object.
Path Parameters
Supported inputs for this operation.
productId
uuidRequiredMerchant-owned product id.
Example: 91dcd85d-8b1d-4f9f-90f0-694f9a604c74
| Name | Type | Required | Description |
|---|---|---|---|
| productId | uuid | Yes | Merchant-owned product id. Example: 91dcd85d-8b1d-4f9f-90f0-694f9a604c74 |
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/products/:productId" \
-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/products
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/products" \
-H "Authorization: Bearer YOUR_API_KEY"