POST marketing/v1/CuratedCollections?preview={preview}&fields={fields}
Request Information
URI Parameters
Name | Type | Description | Comments |
---|---|---|---|
preview | boolean | ||
fields | string |
Body Parameters
CuratedCollectionVariationName | Type | Description | Comments |
---|---|---|---|
Guid | globally unique identifier | ||
Title | string | ||
UserSegmentGuids | Collection of globally unique identifier | ||
ProductCollectionIDs | Collection of integer | ||
ProductSegmentGuids | Collection of globally unique identifier | ||
Sorting | CuratedCollectionVariationSorting | ||
Limit | integer | ||
PinnedProductIDs | Collection of integer |
Request Formats
application/json, text/json
Sample:
{ "Guid": "a06514e4-2519-47f5-93bc-d8a0be1d382e", "Title": "sample string 2", "UserSegmentGuids": [ "59bf6307-72a7-46f8-bae3-e45d60af8c70", "ace4711e-4b39-4cb6-9977-57b52154b990" ], "ProductCollectionIDs": [ 1, 2 ], "ProductSegmentGuids": [ "252a6cb4-9d0b-4b33-ad3e-901397e72ae8", "e2acee43-f01a-4695-8cf2-c11e259b20d1" ], "Sorting": "Original", "Limit": 3, "PinnedProductIDs": [ 1, 2 ] }
Response Information
Resource Description
Collection of ItemName | Type | Description | Comments |
---|---|---|---|
Identifier | string | ||
Title | string | ||
Vendor | string | ||
ItemType | string | ||
Price | decimal number | ||
OriginalPrice | decimal number | ||
DisplayUrl | string | ||
Description | string | ||
ImageUrl | string | ||
Prevalence | integer | ||
CollectionPrevalence | integer | ||
PopularityIndex | integer | ||
TrendingIndex | integer | ||
Tags | string | ||
Active | boolean | ||
Collections | Collection of string | ||
CreateDate | date | ||
VersionDate | date | ||
UpdateDate | date |
Response Formats
application/json, text/json
Sample:
[ { "ID": 1, "SubscriberID": 1, "Nature": "Product", "Identifier": "sample string 1", "Title": "sample string 2", "Vendor": "sample string 3", "ItemTypeID": 1, "ItemTypeTitle": "sample string 4", "ItemType": "sample string 5", "Price": 1.0, "OriginalPrice": 1.0, "DisplayUrl": "sample string 6", "HtmlContent": "sample string 7", "Description": "sample string 8", "ImageUrl": "sample string 9", "Prevalence": 1, "CollectionPrevalence": 1, "PopularityIndex": 1, "TrendingIndex": 1, "Attributes": [ { "Title": "sample string 1", "SourceType": "Platform", "Values": [ { "Title": "sample string 1", "Parameters": [ "sample string 1", "sample string 2" ] }, { "Title": "sample string 1", "Parameters": [ "sample string 1", "sample string 2" ] } ] }, { "Title": "sample string 1", "SourceType": "Platform", "Values": [ { "Title": "sample string 1", "Parameters": [ "sample string 1", "sample string 2" ] }, { "Title": "sample string 1", "Parameters": [ "sample string 1", "sample string 2" ] } ] } ], "Tags": "sample string 10", "Active": true, "Deleted": true, "Collections": [ "sample string 1", "sample string 2" ], "CollectionIDs": [ 1, 2 ], "ExtraAutoTargetKeywords": [ "sample string 1", "sample string 2" ], "TargetingRules": [ { "ItemID": 1, "TargetingRuleID": 2, "Effect": "None", "Auto": true, "TargetingRuleAttributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "ItemID": 1, "TargetingRuleID": 2, "Effect": "None", "Auto": true, "TargetingRuleAttributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ], "TargetedKeywords": [ { "KeywordID": 1, "Auto": true }, { "KeywordID": 1, "Auto": true } ], "TargetedUserSegments": [ { "UserSegmentGuid": "931ac03b-385a-489e-88c5-fd1ef4387040", "Auto": true }, { "UserSegmentGuid": "931ac03b-385a-489e-88c5-fd1ef4387040", "Auto": true } ], "CreateDate": "2021-01-15T21:32:46.4473898+00:00", "VersionDate": "2021-01-15T21:32:46.4473898+00:00", "UpdateDate": "2021-01-15T21:32:46.4473898+00:00" }, { "ID": 1, "SubscriberID": 1, "Nature": "Product", "Identifier": "sample string 1", "Title": "sample string 2", "Vendor": "sample string 3", "ItemTypeID": 1, "ItemTypeTitle": "sample string 4", "ItemType": "sample string 5", "Price": 1.0, "OriginalPrice": 1.0, "DisplayUrl": "sample string 6", "HtmlContent": "sample string 7", "Description": "sample string 8", "ImageUrl": "sample string 9", "Prevalence": 1, "CollectionPrevalence": 1, "PopularityIndex": 1, "TrendingIndex": 1, "Attributes": [ { "Title": "sample string 1", "SourceType": "Platform", "Values": [ { "Title": "sample string 1", "Parameters": [ "sample string 1", "sample string 2" ] }, { "Title": "sample string 1", "Parameters": [ "sample string 1", "sample string 2" ] } ] }, { "Title": "sample string 1", "SourceType": "Platform", "Values": [ { "Title": "sample string 1", "Parameters": [ "sample string 1", "sample string 2" ] }, { "Title": "sample string 1", "Parameters": [ "sample string 1", "sample string 2" ] } ] } ], "Tags": "sample string 10", "Active": true, "Deleted": true, "Collections": [ "sample string 1", "sample string 2" ], "CollectionIDs": [ 1, 2 ], "ExtraAutoTargetKeywords": [ "sample string 1", "sample string 2" ], "TargetingRules": [ { "ItemID": 1, "TargetingRuleID": 2, "Effect": "None", "Auto": true, "TargetingRuleAttributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } }, { "ItemID": 1, "TargetingRuleID": 2, "Effect": "None", "Auto": true, "TargetingRuleAttributes": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" } } ], "TargetedKeywords": [ { "KeywordID": 1, "Auto": true }, { "KeywordID": 1, "Auto": true } ], "TargetedUserSegments": [ { "UserSegmentGuid": "931ac03b-385a-489e-88c5-fd1ef4387040", "Auto": true }, { "UserSegmentGuid": "931ac03b-385a-489e-88c5-fd1ef4387040", "Auto": true } ], "CreateDate": "2021-01-15T21:32:46.4473898+00:00", "VersionDate": "2021-01-15T21:32:46.4473898+00:00", "UpdateDate": "2021-01-15T21:32:46.4473898+00:00" } ]