Query Orders

Return a paginated list of matching orders

SecurityMarketplace Api Key | Merchant Secret Token | Admin JWT | Marketplace JWT | Merchant JWT
Request
query Parameters
limit
integer <int32>

Maximum results per page. Default to 20, must be between 1 and 500.

page
integer <int32>

Page number of results to show (starting at page 1).

sort
string

Comma-delimited list of fields to sort by with sort priority from first to last. Fields are sorted by their natural ordering unless prefixed with a - character.

orderId
Array of strings

Filter by merchant order id

merchantId
Array of strings

Filter by merchant identifier

orderType
Array of strings (OrderType)

Filter by order type

Items Enum: "online" "manual" "invoice"
referenceOrderId
Array of strings

Filter by reference order id

orderStatus
Array of strings (OrderStatus)

Filter by order status

Items Enum: "created" "accepted" "paid" "cancelled" "fulfilled" "returned"
Responses
200

Matching items sorted as specified

400
401
403
404
405
406
409
422
429
500
503
get/orders
Request samples 
Response samples 
application/json
[
  • {
    }
]
Copyright © April Solutions 2023. All right reserved.