personalizer.io Documentation

Help Page Home

GET v1/Upsell?identifiers={identifiers}&limit={limit}&fields={fields}&trackerReference={trackerReference}

Returns the Upsell Items for a particular item.

Request Information

URI Parameters

NameTypeDescriptionComments
identifiers string

Comma-separated list of item identifiers for which the upsell items are requested. In case of more than one identifier, the result will be a mix of mostly relevant items.

limit integer

Number of results requested.

Optional - Default: 3

fields string

Comma-separated list of fields to include in the response.

Optional - Default: "Identifier"

host HostPage

Host Page on which the recommendations will be rendered.

trackerReference string

Additional tracker reference data.

Optional

Body Parameters

None.

Response Information

Resource Description

A list of upsell items.

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

UpdateDate date

Response Formats

application/json, text/json

Sample:
[
  {
    "Identifier": "sample string 1",
    "Title": "T-Shirt",
    "Vendor": "Nike",
    "Description": "Sample T-Shirt",
    "Prevalence": 0,
    "PopularityIndex": 2,
    "Tags": "Tee,Shirt,T-Shirt"
  },
  {
    "Identifier": "sample string 2",
    "Title": "Shoe",
    "Vendor": "Adidas",
    "Description": "Sample Shoe",
    "Prevalence": 0,
    "PopularityIndex": 1,
    "Tags": "Footwear,Shoe"
  }
]