# Collections
GET /GetCollectionByUid
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "String",
"LastItemUpdate": "2019-12-10T13:40:15.6501554+01:00",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"ItemType": "ProductItemType"
}Request
Query parameters:
| Property name | Type | Description |
|---|---|---|
| collectionUid | guid | Unique identifier for collection |
Response status OK (200)
Return value: Collection
| Collection | ||
|---|---|---|
| Property name | Type | Description |
| Uid | guid | Unique identifier for collection |
| Alias | string | Alias for collection |
| LastItemUpdate | DateTimeOffset | Datetime value for last item updated in collection with timezone offset |
| FolderUid | guid | Unique identifier of the folder containing collection |
| ItemType | string | Item type of the items in the collection |
GET /GetCollectionByAlias
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "String",
"LastItemUpdate": "2019-12-10T13:40:15.6501554+01:00",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"ItemType": "ProductItemType"
}Request
Query parameters:
| Property name | Type | Description |
|---|---|---|
| alias | string | alias of collection |
Response status OK (200)
Return value: Collection
| Collection | ||
|---|---|---|
| Property name | Type | Description |
| Uid | guid | Unique identifier for collection |
| Alias | string | Alias for collection |
| LastItemUpdate | DateTimeOffset | Datetime value for last item updated in collection with timezone offset |
| FolderUid | guid | Unique identifier of the folder containing collection |
| ItemType | string | Item type of the items in the collection |
GET /GetCollections
[
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "String",
"LastItemUpdate": "2019-12-10T13:40:15.6501554+01:00",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"ItemType": "ProductItemType"
},
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "String",
"LastItemUpdate": "2019-12-10T13:40:15.6501554+01:00",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"ItemType": "ProductItemType"
}
]Request
Parameters: none
Response status OK (200)
Return value: Collection[]
| Collection | ||
|---|---|---|
| Property name | Type | Description |
| Uid | guid | Unique identifier for collection |
| Alias | string | Alias for collection |
| LastItemUpdate | DateTimeOffset | Datetime value for last item updated in collection with timezone offset |
| FolderUid | guid | Unique identifier of the folder containing collection |
| ItemType | string | Item type of the items in the collection |
POST /GetCollectionsByUids
[
"3a04ec29-05ce-46ef-b3fb-e23f05efb2c4'"
"06f95c4f-a90e-45c8-9efd-63566b928aaa",
"61d668ea-ba7a-4c80-9803-7fabb792c197",
"1074185f-666f-45f8-a87f-b5960bb8e59b"
][
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "String",
"LastItemUpdate": "2019-12-10T13:40:15.6501554+01:00",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"ItemType": "ProductItemType"
},
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "String",
"LastItemUpdate": "2019-12-10T13:40:15.6501554+01:00",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"ItemType": "ProductItemType"
}
]Request
Body parameters:
| Property name | Type | Description |
|---|---|---|
| CollectionUids | string[] | Array of collection uids as strings |
Response status OK (200)
Return value: Collection[]
| Collection | ||
|---|---|---|
| Property name | Type | Description |
| Uid | guid | Unique identifier for collection |
| Alias | string | Alias for collection |
| LastItemUpdate | DateTimeOffset | Datetime value for last item updated in collection with timezone offset |
| FolderUid | guid | Unique identifier of the folder containing collection |
| ItemType | string | Item type of the items in the collection |
POST /GetCollectionsByAliases
[
"string",
"string",
"string"
][
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "String",
"LastItemUpdate": "2019-12-10T13:40:15.6501554+01:00",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"ItemType": "ProductItemType"
},
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Alias": "String",
"LastItemUpdate": "2019-12-10T13:40:15.6501554+01:00",
"FolderUid": "00000000-0000-0000-0000-000000000000",
"ItemType": "ProductItemType"
}
]Request
Body parameters:
| Property name | Type | Description |
|---|---|---|
| Aliases | string[] | Array of collection aliases |
Response status OK (200)
Return value: Collection[]
| Collection | ||
|---|---|---|
| Property name | Type | Description |
| Uid | guid | Unique identifier for collection |
| Alias | string | Alias for collection |
| LastItemUpdate | DateTimeOffset | Datetime value for last item updated in collection with timezone offset |
| FolderUid | guid | Unique identifier of the folder containing collection |
| ItemType | string | Item type of the items in the collection |
GET /GetCollectionItemsByCollectionUid
[
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 84815
},
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 84816
}
]Request
Query parameters:
| Property name | Type | Description |
|---|---|---|
| collectionUid | guid | Unique identifier for collection |
Response status OK (200)
Return value: CollectionItem[]
| CollectionItem | ||
|---|---|---|
| Property name | Type | Description |
| ItemType | int | Item type for collection item derived from enum |
| ItemId | int | Unique item id for collection item |
GET /GetCollectionItemsByCollectionAlias
[
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 84815
},
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 84816
}
]Request
Query parameters:
| Property name | Type | Description |
|---|---|---|
| alias | string | alias of collection |
Response status OK (200)
Return value: CollectionItem[]
| CollectionItem | ||
|---|---|---|
| Property name | Type | Description |
| ItemType | int | Item type for collection item derived from enum |
| ItemId | int | Unique item id for collection item |
POST /GetCollectionItemsByCollectionUids
[
"3a04ec29-05ce-46ef-b3fb-e23f05efb2c4'"
"06f95c4f-a90e-45c8-9efd-63566b928aaa",
"61d668ea-ba7a-4c80-9803-7fabb792c197",
"1074185f-666f-45f8-a87f-b5960bb8e59b"
]{
"00000000-0000-0000-0000-000000000000": [
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 65784
},
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 65785
}
],
{
"00000000-0000-0000-0000-000000000000": [
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 65784
},
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 65785
}
]
}Request
Body parameters:
| Property name | Type | Description |
|---|---|---|
| CollectionUids | string[] | Array of collection uids as strings |
Response status OK (200)
Return value: none
| Property name | Type | Description |
|---|---|---|
| CollectionUid | guid | Unique indentifier for collection |
| CollectionItems | CollectionItem[] | Array of collection items contained in the collection |
| CollectionItem | ||
| Property name | Type | Description |
| ItemType | int | Item type for collection item derived from enum |
| ItemId | int | Unique item id for collection item |
POST /GetCollectionItemsByCollectionAliases
[
"string",
"string",
"string"
]{
"String": [
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 65784
},
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 65785
}
],
{
"String": [
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 65784
},
{
"CollectionUid": "00000000-0000-0000-0000-000000000000",
"ItemType": 20,
"ItemId": 65785
}
]
}Request
Body parameters:
| Property name | Type | Description |
|---|---|---|
| Aliases | string[] | Array of collection aliases |
Response status OK (200)
Return value: none
| Property name | Type | Description |
|---|---|---|
| Alias | string | Alias for collection |
| CollectionItems | CollectionItem[] | Array of collection items contained in the collection |
| CollectionItem | ||
| Property name | Type | Description |
| ItemType | int | Item type for collection item derived from enum |
| ItemId | int | Unique item id for collection item |
GET /GetCollectionFolders
[
{
"Uid": "00000000-0000-0000-0000-000000000000",
"ParentUid": "00000000-0000-0000-0000-000000000000"
"Name": "String"
},
{
"Uid": "00000000-0000-0000-0000-000000000000",
"Name": "String"
}
]Request
Parameters: none
Response status OK (200)
Return value: CollectionFolder[]
| Property name | Type | Description |
|---|---|---|
| Uid | guid | Unique identifier of folder |
| ParentUid | guid | Unique identifier of parent folder if any |
| Name | string | Name of folder |