Collections | Rarely Resources

GET

/api/integrations/v1/collections

List collections

Returns merchant collections, including native and connected collections.

POST

/api/integrations/v1/collections

Create collection

Creates a native collection.

PATCH

/api/integrations/v1/collections/:collectionId

Update collection

Updates a native collection. Connected collections are read-only.

GET

/api/integrations/v1/collections

Read collections

List collections

Use this endpoint to read collection details, product assignments, and tag ids.

Query Parameters

Supported inputs for this operation.

limit

integerOptional

Maximum rows per page.

Default: 50

cursor

stringOptional

Opaque cursor from a previous page.

Name	Type	Required	Description
limit	integer	No	Maximum rows per page. Default: 50
cursor	string	No	Opaque cursor from a previous page.

Examples

Switch between the sample request and example responses for this endpoint.

Sample cURL

curl -X GET "https://merchants.rarely.co/api/integrations/v1/collections" \
  -H "Authorization: Bearer YOUR_API_KEY"

POST

/api/integrations/v1/collections

Write collections

Create collection

Use this endpoint for native manual collections. Smart collection API writes are not supported yet.

Request Body

JSON payload fields accepted by this endpoint.

title

stringRequired

Collection title.

description

stringOptional

Collection description.

primary_image_asset_id

uuidOptional

Merchant media asset used as the collection image.

product_ids

uuid[]Optional

Products assigned to the collection.

tag_ids

uuid[]Optional

Merchant tag ids to assign.

submit

booleanOptional

Submit the collection for review immediately. Requires collections.submit.

Field	Type	Required	Description
title	string	Yes	Collection title.
description	string	No	Collection description.
primary_image_asset_id	uuid	No	Merchant media asset used as the collection image.
product_ids	uuid[]	No	Products assigned to the collection.
tag_ids	uuid[]	No	Merchant tag ids to assign.
submit	boolean	No	Submit the collection for review immediately. Requires collections.submit.

Examples

Switch between the sample request and example responses for this endpoint.

Sample cURL

curl -X POST "https://merchants.rarely.co/api/integrations/v1/collections" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Spring Edit",
  "product_ids": []
}'

PATCH

/api/integrations/v1/collections/:collectionId

Write collections

Update collection

Use this endpoint for partial updates to Rarely-native collections. Connected collections return a conflict instead of being changed.

Path Parameters

Supported inputs for this operation.

collectionId

uuidRequired

Collection id.

Example: 4a45b18d-9dd3-4133-a1ee-ec82e0c4a52d

Name	Type	Required	Description
collectionId	uuid	Yes	Collection id. Example: 4a45b18d-9dd3-4133-a1ee-ec82e0c4a52d

Request Body

JSON payload fields accepted by this endpoint.

title

stringOptional

New pending title.

description

stringOptional

New pending description.

product_ids

uuid[]Optional

Full product assignment set to keep.

tag_ids

uuid[]Optional

Full tag set to keep.

Field	Type	Required	Description
title	string	No	New pending title.
description	string	No	New pending description.
product_ids	uuid[]	No	Full product assignment set to keep.
tag_ids	uuid[]	No	Full tag set to keep.

Examples

Switch between the sample request and example responses for this endpoint.

Sample cURL

curl -X PATCH "https://merchants.rarely.co/api/integrations/v1/collections/:collectionId" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Spring Edit",
  "product_ids": []
}'

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.

Operation

Auth mode

API key

Query: limit

Query: cursor

Resolved request

https://merchants.rarely.co/api/integrations/v1/collections

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/collections" \
  -H "Authorization: Bearer YOUR_API_KEY"

Search docs