Search Products

post

https://apis.supplierxm.salsify.com/public/v1/products/list

This method lists all the products you have access to. If you would like to call this API from this website, you will be asked to provide your authentication token, please prefix this token with following wording 'Bearer '.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

status_shared_from

int32

Filters the shared status of the source products (retailer specific). (DRAFT=2 / PENDING=3 / ACCEPTED=4)

status_shared_with

int32

Filters the shared status of the target products (manufacturer specific). (DRAFT=2 / PENDING=3 / ACCEPTED=4)

updated_at_from

date-time

Defaults to 1470643732

Filters the minimum latest update date of the returned products (UNIX timestamp)

updated_at_to

date-time

Filters the maximum latest update date of the returned products (UNIX timestamp)

filter_gtins_in

string

Defaults to 03663215000110

Filters by GTINs (several possible, comma-separated)

filter_target_market

int32

Defaults to 250

Filters by target market (ISO 3166-1 numeric)

filter_product_languages

string

Defaults to fr

Filters by product languages (several possible, comma-separated)

filter_validation_status_in

int32

Filters the data quality status (validation) of the products (several possible, comma-separated). (NA=0 / NOT OK=1 / OK=2 / CORRECTION=3)

filter_has_packshot_new

boolean

Filters on products based on the presence/absence a packshot.

filter_pictures_last_updated_at_from

date-time

Filters the minimum latest update date for the images (milliseconds since 01/01/1970)

filter_pictures_last_updated_at_to

date-time

Filters the maximum latest update date for the images (milliseconds since 01/01/1970)

filter_tags_in

string

Filter products depending on a specific tag. Returns all products for which the specified tag is on

filter_tags_not_in

string

Filter products depending on a specific tag. Returns all products for which the specified tag is off

filter_source_include

string

Defaults to description

Filters the fields returned by the API (fields are comma separated)

filter_source_exclude

string

Filters the fields returned by the API (fields are comma separated)

filter_active_range

boolean

Identifies products part of the retailer's active range

filter_quality_changed_at_from

date-time

Filters the minimum latest quality update date of the returned products.

filter_quality_changed_at_to

date-time

Filters the maximum latest quality update date of the returned products.

filter_lifecycle_in

int32

Filters the lifecycle status of the source products. (PRELAUNCH=0 / PURCHASABLE=1 / NOT_PURCHASABLE=2 / ARCHIVED=3)

limit

int32

Defaults to 20

The maximum number of products to be returned. The max value allowed is 500.

offset

int32

Defaults to 0

The index of the first product to be returned

next_page

int64

To use scroll search when you need to retrieve more than 10K products (see https://docs.supplierxm.salsify.com/docs/retrieve-product#using-the-pagination-system for more info)

decrypt_price

int32

Defaults to null

Decrypt price if possible (based on permission). Possible values are : false, true.

advanced_search

json

See details up, section "Some details on..."

sort_by

string

sort the element according to the field specified

Headers

Accept-language

string

Defaults to en

Filters by expected languages for labels associated to code values

Responses

200200

400400