personalizer.io Documentation

Help Page Home

POST v1/CuratedCollections?preview={preview}&fields={fields}

Request Information

URI Parameters

NameTypeDescriptionComments
preview boolean

fields string

Body Parameters

CuratedCollectionVariation
NameTypeDescriptionComments
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": "4e5de10a-630a-4f72-b1b8-75852fcefcae",
  "Title": "sample string 2",
  "UserSegmentGuids": [
    "07f4a2e9-cf17-4cd4-b265-1aa8207b4bca",
    "7aba6258-a7a7-41db-91dd-d93728758905"
  ],
  "ProductCollectionIDs": [
    1,
    2
  ],
  "ProductSegmentGuids": [
    "ee2f0b3c-cb87-4212-9063-ed83da6354db",
    "3bb5761c-b248-457f-89c0-485b6e1752be"
  ],
  "Sorting": "Original",
  "Limit": 3,
  "PinnedProductIDs": [
    1,
    2
  ]
}

Response Information

Resource Description

Collection of Item
NameTypeDescriptionComments
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,
    "CollectionCount": 1,
    "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": "c7c1ce33-3e57-40c1-9448-28b3f00eeb06",
        "Auto": true
      },
      {
        "UserSegmentGuid": "c7c1ce33-3e57-40c1-9448-28b3f00eeb06",
        "Auto": true
      }
    ],
    "CreateDate": "2020-10-26T13:26:06.7734925+00:00",
    "VersionDate": "2020-10-26T13:26:06.7734925+00:00",
    "UpdateDate": "2020-10-26T13:26:06.7734925+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,
    "CollectionCount": 1,
    "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": "c7c1ce33-3e57-40c1-9448-28b3f00eeb06",
        "Auto": true
      },
      {
        "UserSegmentGuid": "c7c1ce33-3e57-40c1-9448-28b3f00eeb06",
        "Auto": true
      }
    ],
    "CreateDate": "2020-10-26T13:26:06.7734925+00:00",
    "VersionDate": "2020-10-26T13:26:06.7734925+00:00",
    "UpdateDate": "2020-10-26T13:26:06.7734925+00:00"
  }
]