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 display

size int32

Number of items to load per page

sort string

Sort column (ascending/descending)

id string

Filter orders by order ID

creationDate string

Filter orders 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)

currency ref

Filter orders by currency

status ref

Filter orders by status

source ref

Filter orders by source

price ref

Filter orders by price; the < symbol allows filtering lower (<X), greater (X<), and between a range of prices (X<<Y)

cartId string

Filter orders by cart ID

parentOrderId string

Filter orders by parent order ID

subsidiaryId string

Filter orders by parent subsidiary ID

transactionId string

Filter orders by parent transaction ID

endUserId string

Filter orders by end-user ID

endUserEmail string

Filter orders by end-user email; you can use the * symbol to substitute for letters at the beginning and at the end

endUserFirstName string

Filter orders by end-user first name; you can use the * symbol to substitute for letters at the beginning and at the end

endUserLastName string

Filter orders by end-user last name; you can use the * symbol to substitute for letters at the beginning and at the end

customerId string

Filter orders by customer ID

customerName string

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

lineItemsId string

Filter orders by line item ID

lineItemsProductId string

Filter orders by product ID

lineItemsPublisherProductId string

Filter orders by publisher product ID

lineItemsPublisherFulfillmentId string

Filter orders by publisher fulfillment ID

lineItemsProductName string

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

lineItemsVersion string

Filter orders by product version; you can use the * symbol to substitute for letters at the beginning and at the end

lineItemsSubscriptionTemplate string

Filter orders by subscription template

lineItemsProcessingStatus ref

Filter orders by product status

lineItemsSku string

Filter orders by product SKU; you can use the * symbol to substitute for letters at the beginning and at the end

lineItemsFulfillmentTemplate string

Filter orders by fulfillment template; you can use the * symbol to substitute for letters at the beginning and at the end

storeId string

Filter orders by store ID

storeName string

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

invoiceId string

Filter orders by invoice ID; you can use the * symbol to substitute for letters at the beginning and at the end

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

id

Filter orders by order ID

creationDate

Filter orders 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)

currency

Filter orders by currency

status

Filter orders by status

source

Filter orders by source

price

Filter orders by price; the < symbol allows filtering lower (<X), greater (X<), and between a range of prices (X<<Y)

cartId

Filter orders by cart ID

parentOrderId

Filter orders by parent order ID

subsidiaryId

Filter orders by parent subsidiary ID

transactionId

Filter orders by parent transaction ID

endUserId

Filter orders by end-user ID

endUserEmail

Filter orders by end-user email; you can use the * symbol to substitute for letters at the beginning and at the end

endUserFirstName

Filter orders by end-user first name; you can use the * symbol to substitute for letters at the beginning and at the end

endUserLastName

Filter orders by end-user last name; you can use the * symbol to substitute for letters at the beginning and at the end

customerId

Filter orders by customer ID

customerName

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

lineItemsId

Filter orders by line item ID

lineItemsProductId

Filter orders by product ID

lineItemsPublisherProductId

Filter orders by publisher product ID

lineItemsPublisherFulfillmentId

Filter orders by publisher fulfillment ID

lineItemsProductName

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

lineItemsVersion

Filter orders by product version; you can use the * symbol to substitute for letters at the beginning and at the end

lineItemsSubscriptionTemplate

Filter orders by subscription template

lineItemsProcessingStatus

Filter orders by product status

lineItemsSku

Filter orders by product SKU; you can use the * symbol to substitute for letters at the beginning and at the end

lineItemsFulfillmentTemplate

Filter orders by fulfillment template; you can use the * symbol to substitute for letters at the beginning and at the end

storeId

Filter orders by store ID

storeName

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

invoiceId

Filter orders by invoice ID; you can use the * symbol to substitute for 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!