Skip to main content
POST
Create a new collection
OAuth scope: offer_writeAPI keys have full access to this endpoint.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Request to create a new collection

name
string
required
Example:

"My collection"

description
string
required
Example:

"My collection description"

offerIds
string<uuid>[]
required

List of product IDs to include in the collection

Response

OK

id
string
required
Example:

"col_b1EVARkUTcCTSfspQaXr1Q"

shopId
string
required
Example:

"sh_c689d374-22ca-43d3-8d29-9ef0805cc4cb"

name
string
required
Example:

"My collection"

slug
string
required
Example:

"my-collection"

description
string
required
Example:

"My collection description"

available
boolean
required
state
Archived · object
required

Archived collection state

offerIds
string<uuid>[]
required