Skip to main content
POST
Python

Authorizations

x-api-key
string
header
required

Body

application/json
name
string | null

Display name. Defaults to 'Collection {n}' for this account or user.

description
string | null

Optional vendor-facing notes for this collection.

Maximum string length: 1000
user_id
string | null

Optional partner user id. Scopes the collection to one end user and serves as the default x-user-id on collection-scoped search, browse, and conversation requests when the caller omits that header.

clauses
CollectionClauseInput · object[]

OR across clauses. Within a clause, brand_ids, website_ids, and category_ids are ORed inside each list and ANDed across lists. Empty is allowed so a collection can be created before any items are added.

Response

Successful Response

collection_id
string
required
name
string
required
clauses
CollectionClause · object[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
user_id
string | null