Get list of stores

Request

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

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)

id string

filter the stores by ID. The * symbol may substitute letters at the beginning and at the end

creationDate string

filter the stores 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)

status ref

filter the stores by status

name string

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

customerId string

filter the stores by customer ID. The * symbol may substitute letters at the beginning and at the end

baseProduct string

filter the stores by base product ID. The * symbol may substitute letters at the beginning and at the end

defaultLocale string

filter the stores by default locale. The * symbol may substitute letters at the beginning and at the end

theme string

filter the stores by theme. The * symbol may substitute letters at the beginning and at the end

status ref

filter the stores by status

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

StoreSearchResult
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)

id

filter the stores by ID. The * symbol may substitute letters at the beginning and at the end

creationDate

filter the stores 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)

status

filter the stores by status

name

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

customerId

filter the stores by customer ID. The * symbol may substitute letters at the beginning and at the end

baseProduct

filter the stores by base product ID. The * symbol may substitute letters at the beginning and at the end

defaultLocale

filter the stores by default locale. The * symbol may substitute letters at the beginning and at the end

theme

filter the stores by theme. The * symbol may substitute letters at the beginning and at the end

status

filter the stores by status

Response Content-Type

Choose an authorisation method:

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