# 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
[
{
"Uid": "2045eee7-a647-4dba-a6c3-fa1731212d96",
"Alias": "Red and blue products released in DK",
"FolderUid": "b70b1ba4-8959-49b1-b950-e18f89544ea1",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
},
{
"Uid": "12520ab3-abc9-4317-ae77-8bdbfbaa5b87",
"Alias": "Red products",
"FolderUid": "5d7a6143-13c8-4196-a246-e48a40e34e84",
"QuerySetup": {
"EntityType": 0,
"Query": {
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
}
}
]Response status OK (200)
| 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 |
| 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 |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| 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
{
"Uid": "78a02d22-7947-4a54-aa5e-1cf76fddf8a0",
"Alias": "Red and blue products released in DK",
"FolderUid": "4243c6f4-5edc-40bd-b8ed-6745f37e7baf",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| collection | body | object : Collection |
Collection to update |
| 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 |
| 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 |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| 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)
POST /collections Create a new collection
#Available from v.3.2.0
{
"Uid": "1f38cd28-420f-4e97-af86-721c40703a32",
"Alias": "Red and blue products released in DK",
"FolderUid": "4e617b96-62f4-4d0d-bebf-d11d4cb046c0",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| collection | body | object : Collection |
Collection to create |
| 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 |
| 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 |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| 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)
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)
GET /collections/{uid} Get a specific collection
#Available from v.3.2.0
{
"Uid": "50235164-4e82-4ed7-a5be-3aa9ed4b51fd",
"Alias": "Red and blue products released in DK",
"FolderUid": "618b9643-5def-42f1-a875-edc68ce29752",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unqiue id of collection |
Response status OK (200)
| 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 |
| 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 |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| 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
{
"EntityType": 0,
"EntityIds": [
1001,
2011,
20234,
402324,
5405,
4044,
60547,
34504
]
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unqiue id of collection |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| EntityType | string | |
| EntityIds | array |
GET /collections/{uid}/references Get references to a collection
#Available from v.3.5.0
{
"CollectionUid": "fcb4744b-4106-43aa-bb46-5235bd3131c7",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "7608edfe-862c-417b-bab1-7cd20ff9ecaa"
},
{
"EntityId": 101,
"AttributeUid": "7608edfe-862c-417b-bab1-7cd20ff9ecaa"
}
],
"ReferencingProducts": [
{
"EntityId": 100010,
"AttributeUid": "3fb0dfa4-ed0f-4012-8c68-8b23048261f2"
},
{
"EntityId": 100011,
"AttributeUid": "3fb0dfa4-ed0f-4012-8c68-8b23048261f2"
},
{
"EntityId": 102354,
"AttributeUid": "d994d1d0-f2ab-47c4-a8cb-27001d4dacf5"
}
],
"ReferencingVariants": [
{
"EntityId": 100,
"AttributeUid": "3fb0dfa4-ed0f-4012-8c68-8b23048261f2"
}
],
"ReferencingGlobalListValues": [
"68606ab6-bf38-41a3-aedc-221226fd4aaf",
"d0af31ad-29ac-404a-82ad-ca30c28a98dc"
]
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Uid of collection |
Response status OK (200)
| 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 |
| 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
[
{
"Uid": "b3ba9192-5e42-4496-81fa-97e6edf3145f",
"Alias": "Red and blue products released in DK",
"FolderUid": "800bd54c-6ea8-4343-8644-73a7d026055f",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
},
{
"Uid": "13513c8a-1d30-44de-9ad3-3d927ee6c852",
"Alias": "Red products",
"FolderUid": "5375f4f6-b4a1-4c29-9337-92aca86c8c7b",
"QuerySetup": {
"EntityType": 0,
"Query": {
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
}
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uids | body | array : string |
Response status OK (200)
| 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 |
| 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 |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| 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
{
"a975eb62-cdf5-4260-aa00-ed8b42703ab9": {
"EntityType": 0,
"EntityIds": [
1001,
2011,
20234,
402324,
5405,
4044,
60547,
34504
]
},
"5ebd7477-604f-43f6-bb5d-c8ddad959887": {
"EntityType": 1,
"EntityIds": [
22333,
22566,
56998
]
}
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uids | body | array : string |
Unqiue ids of collections |
Response status OK (200)
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.
[
{
"CollectionUid": "7909af2a-d333-47c6-95d2-fcbc7a2dea69",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "fa4ba5f8-400e-4c1f-b7c8-13aab89dbc1c"
},
{
"EntityId": 101,
"AttributeUid": "fa4ba5f8-400e-4c1f-b7c8-13aab89dbc1c"
}
],
"ReferencingProducts": [
{
"EntityId": 100010,
"AttributeUid": "d4fc21b7-7e17-4426-baf7-3dbffa851b50"
},
{
"EntityId": 100011,
"AttributeUid": "d4fc21b7-7e17-4426-baf7-3dbffa851b50"
},
{
"EntityId": 102354,
"AttributeUid": "8e715970-62f4-4998-9c30-dd6bf0adde8e"
}
],
"ReferencingVariants": [
{
"EntityId": 100,
"AttributeUid": "d4fc21b7-7e17-4426-baf7-3dbffa851b50"
}
],
"ReferencingGlobalListValues": [
"6f422611-ad40-4578-a9e3-61b264ec79b9",
"8fea8f7e-5815-424c-a902-7add19ae3f76"
]
},
{
"CollectionUid": "045a7b47-cefc-4d82-8b8f-b52e052b7880",
"ReferencingCategories": [
{
"EntityId": 100,
"AttributeUid": "fa4ba5f8-400e-4c1f-b7c8-13aab89dbc1c"
}
],
"ReferencingProducts": [
{
"EntityId": 23553,
"AttributeUid": "d4fc21b7-7e17-4426-baf7-3dbffa851b50"
},
{
"EntityId": 5656,
"AttributeUid": "d4fc21b7-7e17-4426-baf7-3dbffa851b50"
}
],
"ReferencingVariants": [
{
"EntityId": 568323,
"AttributeUid": "8e715970-62f4-4998-9c30-dd6bf0adde8e"
}
],
"ReferencingGlobalListValues": [
"50096984-54e5-4e4d-92e4-b99cda571436",
"45617d68-8052-4df0-8143-749d46b5e075"
]
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uids | body | array : string |
Uids of collections |
Response status OK (200)
| 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 |
| 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
[
{
"ParentUid": "540eaff5-05f9-4f0f-b9bb-ba63427590b2",
"Uid": "c8ed430a-6bb9-4e3b-83a0-ebde63bbe213",
"Name": "Collection folder 1"
},
{
"ParentUid": "c01f3fea-8e3f-4bcf-8235-4060fc0775c4",
"Uid": "d0800f06-a6fb-4432-be5a-d2db36e8c97a",
"Name": "Collection folder 2"
}
]Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |
PUT /collections/folders Update a collection folder
#Available from v.3.2.0
{
"ParentUid": "70a2ca06-72fb-4283-870c-f29a000e94ae",
"Uid": "91757544-bd6f-4b7c-8acc-d55817a9481b",
"Name": "Collection folder 1"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| folder | body | object : CollectionFolder |
Collection folder to update |
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |
Response status OK (200)
POST /collections/folders Create a new collection folder
#Available from v.3.2.0
{
"ParentUid": "c1e304d9-68e0-4776-ae26-6531cf333820",
"Uid": "480bbad3-c725-4544-aa75-7d31115f2995",
"Name": "Collection folder 1"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| folder | body | object : CollectionFolder |
Collection folder to create |
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |
Response status OK (200)
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)
GET /collections/folders/{uid} Get a specific collection folder
#Available from v.3.2.0
{
"ParentUid": "4b51d060-92d3-4259-919d-5ef092bb6f52",
"Uid": "e2d9fa9e-eb7f-4e0f-87d9-86951e21fe04",
"Name": "Collection folder 1"
}Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unique id of folder |
Response status OK (200)
| 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
[
{
"Uid": "4909465a-a452-4808-bc83-0004096e69af",
"Alias": "Red and blue products released in DK",
"FolderUid": "6e8361ae-b58e-4c9e-8f7e-48dd939e7a93",
"QuerySetup": {
"EntityType": 0,
"Query": {
"SubQueries": [
{
"Filters": [
{
"FieldUid": "ReleasedInCountries_NA_NA",
"QueryOperator": 0,
"FilterValue": "DK"
}
],
"BooleanOperator": 0,
"QueryModelType": "SimpleQueryModel"
},
{
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
},
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "blue"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
],
"BooleanOperator": 0,
"QueryModelType": "BooleanQueryModel"
}
}
},
{
"Uid": "bcd01012-9959-4172-b453-b4c13cb529ac",
"Alias": "Red products",
"FolderUid": "da3bbcc0-af8c-4d01-aa11-9c117f1818d8",
"QuerySetup": {
"EntityType": 0,
"Query": {
"Filters": [
{
"FieldUid": "Color.BaseColor.Name_en-GB_NA",
"QueryOperator": 0,
"FilterValue": "red"
}
],
"BooleanOperator": 1,
"QueryModelType": "SimpleQueryModel"
}
}
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Response status OK (200)
| 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 |
| 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 |
| Property name | Data type | Description |
|---|---|---|
| Filters | array : FieldFilterModel |
List of filter conditions |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| SubQueries | array : QueryModel |
Sub queries to execute |
| BooleanOperator | string |
The operator of the query. Can be any of:
|
| QueryModelType | string |
The type of query model. Name matches exact name of concrete model implementation |
| Property name | Data type | Description |
|---|---|---|
| FieldUid | string |
Uid of field to query |
| QueryOperator | string |
Operator to use for query. Can be any of:
|
| 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
[
{
"ParentUid": "3c8b476e-68fe-451b-a912-24d5345455d3",
"Uid": "d9d0d293-82b6-4801-b955-82e642918677",
"Name": "Collection folder 1"
},
{
"ParentUid": "70eae9da-60ca-4d8c-b640-61dac6c8b6b6",
"Uid": "6c68da8a-c56a-4647-b9cf-df51066a62cf",
"Name": "Collection folder 2"
}
]Request parameters
| Property name | Parameter type | Data type | Description |
|---|---|---|---|
| uid | path | string |
Unqieu id of folder |
Response status OK (200)
| Property name | Data type | Description |
|---|---|---|
| ParentUid | string | |
| Uid | string | |
| Name | string |