API Reference

List Products

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

This method lists all the products you have access to.

Query Params
int32

Filters the shared status of the source products. (DRAFT=2 / PENDING=3 / ACCEPTED=4 / ARCHIVED=1 / DELETED=0 / PAUSED=6 / REFUSED=5)

int32

Filters the shared status of the target products. (DRAFT=2 / PENDING=3 / ACCEPTED=4 / ARCHIVED=1 / DELETED=0 / PAUSED=6 / REFUSED=5)

date-time

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

date-time

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

string
Defaults to 03663215000110

Filters by GTINs (several possible, comma-separated)

int32
Defaults to 250

Filters by target market (ISO 3166-1 numeric)

string
Defaults to fr

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

int32

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

boolean

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

date-time

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

date-time

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

string

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

string

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

string

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

string

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

date-time

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

date-time

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

int32

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

boolean

Identifies products part of the retailer's active range = products you have uploaded to SupplierXM. Products that manufacturers push proactively have a value "false"

string

Filters by request statuses (several possible, comma-separated). Values ACCEPTED, PENDING, REFUSED, RECIPIENT_NOT_RECONCILED

int32
Defaults to 20

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

int32
Defaults to 0

The index of the first product to be returned

int64

To use scroll search when you need to retrieve more than 10K products (see end of step 3 at https://docs.supplierxm.salsify.com/docs/getting-started for more info)

boolean

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

json

See details in "Search Products": https://docs.supplierxm.salsify.com/reference/search-product

string

sort the element according to the field specified

boolean

[DEPRECATED] Identifies products part of the retailer's active range = products you have uploaded to SupplierXM. Products that manufacturers push proactively have a value "false"

Headers
string
Defaults to fr

Filters by expected languages for labels associated to code values

Responses

Updated 9 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 9 months ago