personalizer.io Documentation

Help Page Home

GET v1/NewArrival?collectionIdentifier={collectionIdentifier}&itemIdentifier={itemIdentifier}&excludedItemIdentifier={excludedItemIdentifier}&limit={limit}&fields={fields}&trackerReference={trackerReference}

Returns the New Arrivals

Request Information

URI Parameters

NameTypeDescriptionComments
collectionIdentifier string

Collection identifier for which you want to optionally limit the results within.

Optional

itemIdentifier string

Item identifier for collection(s) of which you want to optionally limit the results within.

Optional

excludedItemIdentifier string

Identifier of the item to exclude from results (e.g. Item that is already being displayed).

Optional

limit integer

Number of results requested.

Optional - Default: 20

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 new arrival 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"
  }
]