Create Collection

Create a new product collection.

Method

POST /v1/collections

Body Parameters

base · object · required

Base properties

Hide properties

key · string · required

Unique key within workspace

name · string · required

Display name

type · string · required

manual | smart

status · string

active | draft | archived (default active)

sortStrategy · string

manual | newest | price_asc | price_desc | random | custom (alias: sort_strategy)

slug · string

Optional slug

definition · object

Initial rules/definition (alias: rules)

translation · object

Localized fields (optional)

Hide properties

locale · string · required

Locale code, e.g. en

name · string · required

Localized name

slug · string

Localized slug

description · string

Localized description (plain text or HTML)

Headers

Authorization · string · required

Bearer token (e.g. Authorization: Bearer YOUR_API_KEY)

content-type · string

application/json

cURL

curl -X POST https://api.voyantcloud.com/v1/collections \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{
    "base": {
      "key": "summer",
      "name": "Summer Picks",
      "type": "smart",
      "status": "active",
      "sort_strategy": "manual",
      "definition": { "include": [{ "tag": "summer" }] }
    },
    "translation": { "locale": "en", "name": "Summer Picks", "slug": "summer" }
  }'

201 Created

{
  "id": "col_123",
  "key": "summer",
  "status": "active"
}