put

https://api.perselio.com/api/v3/item

Insert or replace item.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

itemId

string

required

length between 3 and 40

ID of given item.

groupingId

string | null

Grouping ID of given item. Allows to link together variants of the same product or related products.

name

string

required

length ≥ 2

Name of item.

description

string | null

Description of item. Optional, but may be required if e.g. language models are used.

brand

string

required

length ≥ 2

Brand/company producing this item.

categories

array of objects

required

List of categories, latest one is the most specialized. For example electronics>mobile phones>iPhone mobile should result in array of three categories where your last item should be 'iPhone mobile' category.

categories*

imageUrls

array of objects | null

required

List of images related to the product. Order matter, first image is the most important one. Images are represented as objects for possible future extension with particular metadata (width, ratio etc).

imageUrls*

price

double

required

≥ 0

Price of given item. Make sure to always use the same currency.

priceOld

double | null

≥ 0

Price before discount.

rating

double | null

required

0 to 1

User rating of the item. Ranges in interval <0,1>.

ratingCount

int64 | null

required

≥ 0

Count of ratings for given item.

ageRating

int64 | null

≥ 0

Minimum user's age for usage of the product.

available

boolean

required

Describes whether given item is available and should be recommended by Perselio.

availabilityText

string | null

Availability text that is presentable for the user in the recommendation widget.

url

string | null

required

Item's URL.

labels

array of objects | null

List of product labels.

labels

variants

array of objects | null

List of product variants. See variant documentation for more info.

variants

Responses

204

No content

401

Unauthorized

500

Internal Server Error

400Bad Request