Get list of products

You need to have a valid JWT to access this API. Please read JWT Authentication.

Request

GET https://api.nexway.store/products

Query parameters

Parameter name Value Description Additional
page int32

Number of page you want to display

size int32

Number of items to load per page

sort string

Sort column (ascending/descending)

locale string

Locale used to filter assets

country string

Country used to filter prices

ip string

IP used to filter prices

storeId string

Filter products by store ID

includeParent ref

Include product parent or not in _parent field

id string

Filter products by ID

parentId string

Filter products by parent ID

creationDate string

Filter products by creation date with format yyyy-MM-dd'T'HH:mm:ss; the < symbol allows filtering before (<X), after (X<), and between a range of dates (X<<Y)

genericName string

Filter products by generic name; you can use the * symbol to substitute for letters at the beginning and at the end

customerId string

Filter products by customer ID

status ref

Filter products by status

type ref

Filter products by type

publisherRefId string

Filter products by product publisher ID

lifeTime string

Filter products by life time; you can use the * symbol to substitute for letters at the beginning and at the end

var string

Filter products by variant; syntax is var=,

full ref

Merge product variant with its product parent or not

Authorisation

You need to have a valid JWT to access this API. Please read JWT Authentication.

This request requires the use of one of following authorisation methods: OAuth2.

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

Success

SearchResult«BaseProduct»
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

500 Internal Server Error

Failure


Explore this API

page

Number of page you want to display

size

Number of items to load per page

sort

Sort column (ascending/descending)

locale

Locale used to filter assets

country

Country used to filter prices

ip

IP used to filter prices

storeId

Filter products by store ID

includeParent

Include product parent or not in _parent field

id

Filter products by ID

parentId

Filter products by parent ID

creationDate

Filter products by creation date with format yyyy-MM-dd'T'HH:mm:ss; the < symbol allows filtering before (<X), after (X<), and between a range of dates (X<<Y)

genericName

Filter products by generic name; you can use the * symbol to substitute for letters at the beginning and at the end

customerId

Filter products by customer ID

status

Filter products by status

type

Filter products by type

publisherRefId

Filter products by product publisher ID

lifeTime

Filter products by life time; you can use the * symbol to substitute for letters at the beginning and at the end

var

Filter products by variant; syntax is var=,

full

Merge product variant with its product parent or not

Response Content-Type

Choose an authorisation method:

Access Token Access token to be used for request
Try it out!