Create a new collection

post

https://api.bloomreach.com/api/cde/v1/workspaces/{workspace_id}/item-collections

Creates a new item collection in the specified workspace

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

workspace_id

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.

name

string

required

length between 1 and 64

Unique identifier for portable references across environments

description

length between 0 and 1024

Optional detailed description of the collection's purpose and contents

display_name

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

type

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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The newly created collection response with system-generated fields

400Standard error response format for normal application-level failures. In rare edge cases, such as malformed HTTP requests rejected before normal request handling completes, the API may return a more generic fallback error payload.

401Standard error response format for normal application-level failures. In rare edge cases, such as malformed HTTP requests rejected before normal request handling completes, the API may return a more generic fallback error payload.

429Response format for rate limiting errors (429)

500Standard error response format for normal application-level failures. In rare edge cases, such as malformed HTTP requests rejected before normal request handling completes, the API may return a more generic fallback error payload.