Create a new collection

Creates a new item collection in the specified workspace

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
length between 36 and 36

Unique identifier for the workspace

Body Params

A CreateCollectionRequest body that includes details for the collection to be created.

The request body for creating a new collection. Provide a unique name and an optional display name.

string
required
length between 1 and 64

Unique identifier for portable references across environments

length between 0 and 1024

Optional detailed description of the collection's purpose and contents

length between 1 and 256

Human-readable name for the collection

item_types
array of objects
length between 1 and 50

List of item types supported in this collection

CollectionItemTypes

Defines an item type and its supported relationships within a collection

string
required
length ≤ 50

The name of the item type. Currently only 'product' is supported.

relationships
array of strings
length ≤ 1
Defaults to []

List of relationships this item type supports. Values must be unique and currently only 'variant' is supported.

Relationships
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© Bloomreach, Inc. All rights reserved.