Get list of orders

Request

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

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 orders by order ID.
creationDate string

filter the orders 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)
currency ref

filter the orders by currency
status ref

filter the orders by status
source ref

filter the orders by source
price ref

filter the orders by price. The < symbol allow to filter lower (<X), greater (X<) and between a range of prices (X<<Y)
cartId string

filter the orders by cart ID.
parentOrderId string

filter the orders by parent order ID.
subsidiaryId string

filter the orders by parent subsidiary ID.
transactionId string

filter the orders by parent transaction ID.
endUserId string

filter the orders by end user ID.
endUserEmail string

filter the orders by end user email. The * symbol may substitute letters at the beginning and at the end
endUserFirstName string

filter the orders by end user first name. The * symbol may substitute letters at the beginning and at the end
endUserLastName string

filter the orders by end user last name. The * symbol may substitute letters at the beginning and at the end
customerId string

filter the orders by customer ID.
customerName string

filter the orders by customer name. The * symbol may substitute letters at the beginning and at the end
lineItemsId string

filter the orders by line item ID.
lineItemsProductId string

filter the orders by product ID.
lineItemsPublisherProductId string

filter the orders by publisher product ID.
lineItemsPublisherFulfillmentId string

filter the orders by publisher fulfillment ID.
lineItemsProductName string

filter the orders by product name. The * symbol may substitute letters at the beginning and at the end
lineItemsVersion string

filter the orders by product version. The * symbol may substitute letters at the beginning and at the end
lineItemsSubscriptionModelId string

filter the orders by subscription model ID. The * symbol may substitute letters at the beginning and at the end
lineItemsProcessingStatus ref

filter the orders by product status
lineItemsSku string

filter the orders by product SKU. The * symbol may substitute letters at the beginning and at the end
lineItemsFulfillmentTemplate string

filter the orders by fulfillment template. The * symbol may substitute letters at the beginning and at the end
storeId string

filter the orders by store ID.
storeName string

filter the orders by store name. The * symbol may substitute letters at the beginning and at the end
invoiceId string

filter the orders by invoice id. The * symbol may substitute letters at the beginning and at the end

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

 OrderSearchResult
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 orders by order ID.
creationDate

filter the orders 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)
currency

filter the orders by currency
status

filter the orders by status
source

filter the orders by source
price

filter the orders by price. The < symbol allow to filter lower (<X), greater (X<) and between a range of prices (X<<Y)
cartId

filter the orders by cart ID.
parentOrderId

filter the orders by parent order ID.
subsidiaryId

filter the orders by parent subsidiary ID.
transactionId

filter the orders by parent transaction ID.
endUserId

filter the orders by end user ID.
endUserEmail

filter the orders by end user email. The * symbol may substitute letters at the beginning and at the end
endUserFirstName

filter the orders by end user first name. The * symbol may substitute letters at the beginning and at the end
endUserLastName

filter the orders by end user last name. The * symbol may substitute letters at the beginning and at the end
customerId

filter the orders by customer ID.
customerName

filter the orders by customer name. The * symbol may substitute letters at the beginning and at the end
lineItemsId

filter the orders by line item ID.
lineItemsProductId

filter the orders by product ID.
lineItemsPublisherProductId

filter the orders by publisher product ID.
lineItemsPublisherFulfillmentId

filter the orders by publisher fulfillment ID.
lineItemsProductName

filter the orders by product name. The * symbol may substitute letters at the beginning and at the end
lineItemsVersion

filter the orders by product version. The * symbol may substitute letters at the beginning and at the end
lineItemsSubscriptionModelId

filter the orders by subscription model ID. The * symbol may substitute letters at the beginning and at the end
lineItemsProcessingStatus

filter the orders by product status
lineItemsSku

filter the orders by product SKU. The * symbol may substitute letters at the beginning and at the end
lineItemsFulfillmentTemplate

filter the orders by fulfillment template. The * symbol may substitute letters at the beginning and at the end
storeId

filter the orders by store ID.
storeName

filter the orders by store name. The * symbol may substitute letters at the beginning and at the end
invoiceId

filter the orders by invoice id. The * symbol may substitute letters at the beginning and at the end
Response Content-Type

Choose an authorisation method:

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