We have a brand new Developer Portal!

This page will be expiring soon; be sure to bookmark the new link.
Take me there

Get orders by query

Retrieves orders based on query model passed in the request body.

Request
header Parameters
required
object

x-site-context value

Request Body schema: application/json
limit
integer <int32>
Default: 10

Numbers of records to be returned

offset
integer <int64>
Default: 0

Number of records to skipped

sortBy
string
Default: "updatedAt"

Item property on which data needed to be sorted on

sortDirection
string
Default: "desc"

Direction of sorting- ascending or descending

Enum: "asc" "desc"
required
object
Default: {}

JSON to do filtration of records. to filter records json structure should be similar to target entity structure i.e order, shipment etc

Responses
200

Matched orders

400

Bad request

404

Orders not found

500

Internal server error

post/order/query
Request samples
application/json
{
  • "limit": 10,
  • "offset": 0,
  • "sortBy": "updatedAt",
  • "sortDirection": "desc",
  • "filters": {
    }
}
Response samples
application/json
{
  • "count": 100,
  • "limit": 10,
  • "offset": 1,
  • "orders": [
    ]
}