GET https://api.nexway.store/orders
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 |
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
.
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 |