# Collections

#Available from v.3.2.0 Collections are dynamic groupings of either products or variants. Collections contain a range of products or variants that match a certain query specified on the collection.

GET /collections Get all collections

#Available from v.3.2.0

Response status OK (200)

array : Collection
Collection
Property name Data type Description
Uid string

Unique id of collection

Alias string

Unique human readable alias of collection

FolderUid string

Folder in which collection is places (null of collection is placed at root level)

QuerySetup object : QueryContainer

Query defining the products or variants that are part of this collection

QueryContainer
Property name Data type Description
EntityType string

The entity type to query for

Query object : QueryModel

Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel

QueryModel
This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type
SimpleQueryModel
Simple query model used for querying specific fields
Property name Data type Description
Filters array : FieldFilterModel

List of filter conditions

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel
Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries
Property name Data type Description
SubQueries array : QueryModel

Sub queries to execute

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel
Property name Data type Description
FieldUid string

Uid of field to query

QueryOperator string

Operator to use for query. Can be any of:

  • Equals / 0 (Value must start with FilterValue)
  • WildcardEquals / 1 (Value must be smaller than FilterValue)
  • SmallerThan / 2 (Value must be smaller than FilterValue)
  • LargerThan / 3 (Value must be larger than FilterValue)
  • IsEmpty / 4 (Value must be empty)
  • IsNotEmpty / 5 (Value must not be empty)
  • Contains / 6 (Value must contain FilterValue)
  • NotContains / 7 (Value must not contain FilterValue)
  • NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
  • NotWildcardEquals / 9 (Value must not start with FilterValue)
  • InList / 10 (Item field value must match any of the in provided values in FilterList)
FilterValue object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for


PUT /collections Update a collection

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
collection body object : Collection

Collection to update

Collection
Property name Data type Description
Uid string

Unique id of collection

Alias string

Unique human readable alias of collection

FolderUid string

Folder in which collection is places (null of collection is placed at root level)

QuerySetup object : QueryContainer

Query defining the products or variants that are part of this collection

QueryContainer
Property name Data type Description
EntityType string

The entity type to query for

Query object : QueryModel

Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel

QueryModel
This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type
SimpleQueryModel
Simple query model used for querying specific fields
Property name Data type Description
Filters array : FieldFilterModel

List of filter conditions

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel
Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries
Property name Data type Description
SubQueries array : QueryModel

Sub queries to execute

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel
Property name Data type Description
FieldUid string

Uid of field to query

QueryOperator string

Operator to use for query. Can be any of:

  • Equals / 0 (Value must start with FilterValue)
  • WildcardEquals / 1 (Value must be smaller than FilterValue)
  • SmallerThan / 2 (Value must be smaller than FilterValue)
  • LargerThan / 3 (Value must be larger than FilterValue)
  • IsEmpty / 4 (Value must be empty)
  • IsNotEmpty / 5 (Value must not be empty)
  • Contains / 6 (Value must contain FilterValue)
  • NotContains / 7 (Value must not contain FilterValue)
  • NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
  • NotWildcardEquals / 9 (Value must not start with FilterValue)
  • InList / 10 (Item field value must match any of the in provided values in FilterList)
FilterValue object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for

Response status OK (200)

No body message is returned

POST /collections Create a new collection

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
collection body object : Collection

Collection to create

Collection
Property name Data type Description
Uid string

Unique id of collection

Alias string

Unique human readable alias of collection

FolderUid string

Folder in which collection is places (null of collection is placed at root level)

QuerySetup object : QueryContainer

Query defining the products or variants that are part of this collection

QueryContainer
Property name Data type Description
EntityType string

The entity type to query for

Query object : QueryModel

Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel

QueryModel
This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type
SimpleQueryModel
Simple query model used for querying specific fields
Property name Data type Description
Filters array : FieldFilterModel

List of filter conditions

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel
Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries
Property name Data type Description
SubQueries array : QueryModel

Sub queries to execute

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel
Property name Data type Description
FieldUid string

Uid of field to query

QueryOperator string

Operator to use for query. Can be any of:

  • Equals / 0 (Value must start with FilterValue)
  • WildcardEquals / 1 (Value must be smaller than FilterValue)
  • SmallerThan / 2 (Value must be smaller than FilterValue)
  • LargerThan / 3 (Value must be larger than FilterValue)
  • IsEmpty / 4 (Value must be empty)
  • IsNotEmpty / 5 (Value must not be empty)
  • Contains / 6 (Value must contain FilterValue)
  • NotContains / 7 (Value must not contain FilterValue)
  • NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
  • NotWildcardEquals / 9 (Value must not start with FilterValue)
  • InList / 10 (Item field value must match any of the in provided values in FilterList)
FilterValue object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for

Response status OK (200)

No body message is returned

DELETE /collections Delete a collection

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
uid query string

Uid of collection to delete

Response status OK (200)

No body message is returned

GET /collections/{uid} Get a specific collection

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
uid path string

Unqiue id of collection

Response status OK (200)

object : Collection
Collection
Property name Data type Description
Uid string

Unique id of collection

Alias string

Unique human readable alias of collection

FolderUid string

Folder in which collection is places (null of collection is placed at root level)

QuerySetup object : QueryContainer

Query defining the products or variants that are part of this collection

QueryContainer
Property name Data type Description
EntityType string

The entity type to query for

Query object : QueryModel

Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel

QueryModel
This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type
SimpleQueryModel
Simple query model used for querying specific fields
Property name Data type Description
Filters array : FieldFilterModel

List of filter conditions

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel
Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries
Property name Data type Description
SubQueries array : QueryModel

Sub queries to execute

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel
Property name Data type Description
FieldUid string

Uid of field to query

QueryOperator string

Operator to use for query. Can be any of:

  • Equals / 0 (Value must start with FilterValue)
  • WildcardEquals / 1 (Value must be smaller than FilterValue)
  • SmallerThan / 2 (Value must be smaller than FilterValue)
  • LargerThan / 3 (Value must be larger than FilterValue)
  • IsEmpty / 4 (Value must be empty)
  • IsNotEmpty / 5 (Value must not be empty)
  • Contains / 6 (Value must contain FilterValue)
  • NotContains / 7 (Value must not contain FilterValue)
  • NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
  • NotWildcardEquals / 9 (Value must not start with FilterValue)
  • InList / 10 (Item field value must match any of the in provided values in FilterList)
FilterValue object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for


GET /collections/{uid}/entities Get entities in a specific collection

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
uid path string

Unqiue id of collection

Response status OK (200)

object : CollectionResultset
CollectionResultset
Property name Data type Description
EntityType string
EntityIds array

GET /collections/{uid}/references Get references to a collection

#Available from v.3.5.0

Request parameters

Property name Parameter type Data type Description
uid path string

Uid of collection

Response status OK (200)

object : CollectionReferences
CollectionReferences
Property name Data type Description
CollectionUid string

Uid of the referenced collection

ReferencingCategories array : EntityReferenceDetail

List of categories referencing this collection

ReferencingProducts array : EntityReferenceDetail

List of products referencing this collection

ReferencingVariants array : EntityReferenceDetail

List of variants referencing this collection

ReferencingGlobalListValues array

List of global list values referencing this collection

EntityReferenceDetail
Property name Data type Description
EntityId integer

The id of the referencing entity

AttributeUid string

The attribute on the referencing entity that holds the reference


POST /collections/batch Get a batch of collections

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
uids body array : string

Response status OK (200)

array : Collection
Collection
Property name Data type Description
Uid string

Unique id of collection

Alias string

Unique human readable alias of collection

FolderUid string

Folder in which collection is places (null of collection is placed at root level)

QuerySetup object : QueryContainer

Query defining the products or variants that are part of this collection

QueryContainer
Property name Data type Description
EntityType string

The entity type to query for

Query object : QueryModel

Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel

QueryModel
This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type
SimpleQueryModel
Simple query model used for querying specific fields
Property name Data type Description
Filters array : FieldFilterModel

List of filter conditions

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel
Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries
Property name Data type Description
SubQueries array : QueryModel

Sub queries to execute

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel
Property name Data type Description
FieldUid string

Uid of field to query

QueryOperator string

Operator to use for query. Can be any of:

  • Equals / 0 (Value must start with FilterValue)
  • WildcardEquals / 1 (Value must be smaller than FilterValue)
  • SmallerThan / 2 (Value must be smaller than FilterValue)
  • LargerThan / 3 (Value must be larger than FilterValue)
  • IsEmpty / 4 (Value must be empty)
  • IsNotEmpty / 5 (Value must not be empty)
  • Contains / 6 (Value must contain FilterValue)
  • NotContains / 7 (Value must not contain FilterValue)
  • NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
  • NotWildcardEquals / 9 (Value must not start with FilterValue)
  • InList / 10 (Item field value must match any of the in provided values in FilterList)
FilterValue object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for


POST /collections/batch/entities Get entities in a batch of collections

#Available from v.3.14.0

Request parameters

Property name Parameter type Data type Description
uids body array : string

Unqiue ids of collections

Response status OK (200)

object

POST /collections/batch/references Get references to a batch of collections

#Available from v.3.5.0 No more than 5000 values can be requested at a time.

Request parameters

Property name Parameter type Data type Description
uids body array : string

Uids of collections

Response status OK (200)

array : CollectionReferences
CollectionReferences
Property name Data type Description
CollectionUid string

Uid of the referenced collection

ReferencingCategories array : EntityReferenceDetail

List of categories referencing this collection

ReferencingProducts array : EntityReferenceDetail

List of products referencing this collection

ReferencingVariants array : EntityReferenceDetail

List of variants referencing this collection

ReferencingGlobalListValues array

List of global list values referencing this collection

EntityReferenceDetail
Property name Data type Description
EntityId integer

The id of the referencing entity

AttributeUid string

The attribute on the referencing entity that holds the reference


GET /collections/folders Get all collection folders

#Available from v.3.2.0

Response status OK (200)

array : CollectionFolder
CollectionFolder
Property name Data type Description
ParentUid string
Uid string
Name string

PUT /collections/folders Update a collection folder

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
folder body object : CollectionFolder

Collection folder to update

CollectionFolder
Property name Data type Description
ParentUid string
Uid string
Name string

Response status OK (200)

No body message is returned

POST /collections/folders Create a new collection folder

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
folder body object : CollectionFolder

Collection folder to create

CollectionFolder
Property name Data type Description
ParentUid string
Uid string
Name string

Response status OK (200)

No body message is returned

DELETE /collections/folders Delete a collection folder

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
uid query string

Uid of collection folder to delete

Response status OK (200)

No body message is returned

GET /collections/folders/{uid} Get a specific collection folder

#Available from v.3.2.0

Request parameters

Property name Parameter type Data type Description
uid path string

Unique id of folder

Response status OK (200)

object : CollectionFolder
CollectionFolder
Property name Data type Description
ParentUid string
Uid string
Name string

GET /collections/folders/{uid}/collections Get collections in folder

#Available from v.3.2.0 Use empty Guid (00000000-0000-0000-0000-000000000000) to get collections at root

Request parameters

Property name Parameter type Data type Description
uid path string

Response status OK (200)

array : Collection
Collection
Property name Data type Description
Uid string

Unique id of collection

Alias string

Unique human readable alias of collection

FolderUid string

Folder in which collection is places (null of collection is placed at root level)

QuerySetup object : QueryContainer

Query defining the products or variants that are part of this collection

QueryContainer
Property name Data type Description
EntityType string

The entity type to query for

Query object : QueryModel

Definition of the entity query, which can be BooleanQueryModel or SimpleQueryModel

QueryModel
This model is an abstract type and can attain any of the below concrete models. The QueryModelType property is used to define the actual model type
SimpleQueryModel
Simple query model used for querying specific fields
Property name Data type Description
Filters array : FieldFilterModel

List of filter conditions

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

BooleanQueryModel
Query wrapper for sub queries where the BooleanOperator operates between the sub queries. Allows for nested queries
Property name Data type Description
SubQueries array : QueryModel

Sub queries to execute

BooleanOperator string

The operator of the query. Can be any of:

  • And / 0 (All conditions must match)
  • Or / 1 (At least one of the provided conditions must match)
QueryModelType string

The type of query model. Name matches exact name of concrete model implementation

FieldFilterModel
Property name Data type Description
FieldUid string

Uid of field to query

QueryOperator string

Operator to use for query. Can be any of:

  • Equals / 0 (Value must start with FilterValue)
  • WildcardEquals / 1 (Value must be smaller than FilterValue)
  • SmallerThan / 2 (Value must be smaller than FilterValue)
  • LargerThan / 3 (Value must be larger than FilterValue)
  • IsEmpty / 4 (Value must be empty)
  • IsNotEmpty / 5 (Value must not be empty)
  • Contains / 6 (Value must contain FilterValue)
  • NotContains / 7 (Value must not contain FilterValue)
  • NotEquals / 8 (Value must not be exactly equal to FilterValue (not considering casing))
  • NotWildcardEquals / 9 (Value must not start with FilterValue)
  • InList / 10 (Item field value must match any of the in provided values in FilterList)
FilterValue object

Value to filter for using the QueryOperator. When QueryOperator is "InList", FilterValue must be an array of values to query for


GET /collections/folders/{uid}/subfolders Get subfolders for collection folder

#Available from v.3.2.0 Use empty Guid (00000000-0000-0000-0000-000000000000) to get root folders

Request parameters

Property name Parameter type Data type Description
uid path string

Unqieu id of folder

Response status OK (200)

array : CollectionFolder
CollectionFolder
Property name Data type Description
ParentUid string
Uid string
Name string