Get list of products

You need to have a valid JWT to access to 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 hit

size int32

number of items into the current page

sort string

sort a specific column to a direction (columnName,asc)

locale string

locale used to filter the assets

country string

country used to filter the prices

ip string

IP used to filter the prices

storeId string

filter the products by store ID

includeParent ref

Include its product parent or not in the _parent field

id string

filter the products by ID

parentId string

filter the products by parent ID

creationDate string

filter the products by creation date with format yyyy-MM-dd'T'HH:mm:ss. The < symbol allow to filter before (<X), after (X<) and between a range of dates (X<<Y)

genericName string

filter the products by generic name. The * symbol may substitute letters at the beginning and at the end

customerId string

filter the products by customer ID

status ref

filter the products by status

type ref

filter the products by type

publisherRefId string

filter the products by product publisher ID

lifeTime string

filter the products by life time. The * symbol may substitute letters at the beginning and at the end

var string

filter the products by variant. The syntax is var=,

full ref

Merge product variant with its product parent or not

Authorisation

You need to have a valid JWT to access to 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

ProductSearchResult«Product»
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 hit

size

number of items into the current page

sort

sort a specific column to a direction (columnName,asc)

locale

locale used to filter the assets

country

country used to filter the prices

ip

IP used to filter the prices

storeId

filter the products by store ID

includeParent

Include its product parent or not in the _parent field

id

filter the products by ID

parentId

filter the products by parent ID

creationDate

filter the products by creation date with format yyyy-MM-dd'T'HH:mm:ss. The < symbol allow to filter before (<X), after (X<) and between a range of dates (X<<Y)

genericName

filter the products by generic name. The * symbol may substitute letters at the beginning and at the end

customerId

filter the products by customer ID

status

filter the products by status

type

filter the products by type

publisherRefId

filter the products by product publisher ID

lifeTime

filter the products by life time. The * symbol may substitute letters at the beginning and at the end

var

filter the products by variant. The 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!