personalizer.io Documentation

Help Page Home

POST v1/Items

Batch store (insert/update) items.

Request Information

URI Parameters

None.

Body Parameters

List of items to store. Maximum length of the list should not exceed 1,000 items.

Collection of Item
NameTypeDescriptionComments
Identifier string

Item's unique identifier in its source system.

Required

Title string

Title.

Vendor string

ItemType string

Item type.

Price decimal number

Price (if applicable).

OriginalPrice decimal number

Original Price (if applicable, and the "Price" is discounted).

DisplayUrl string

URL by which the Item is accessible (if applicable).

Description string

Description.

ImageUrl string

Image URL (if applicable).

Prevalence integer

Indicates the relative frequency with which an item appears.

Value must be between -5 and 5

CollectionPrevalence integer

Indicates the relative frequency with which a collection appears.

Value must be between -5 and 5

PopularityIndex integer

Overall popularity index calculated based on user behavior feedback.

Read only

TrendingIndex integer

Tags string

Comma-separated tags applicable to the item.

Active boolean

Indicates whether item is active or not.

Default is true

Collections Collection of string

List of collection identifiers this item belongs to.

UpdateDate date

Latest update date.

Request 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"
  }
]

Response Information

Resource Description

A list of identifiers of successfully stored items.

Collection of IdentifierContainer
NameTypeDescriptionComments
Identifier string

Response Formats

application/json, text/json

Sample:
[
  {
    "Identifier": "Sample string 1"
  },
  {
    "Identifier": "Sample string 2"
  }
]