List orders

Get the list of orders.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Error cases

Wrong type in query param (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "per_page",
            "error": "wrong_type",
            "error_description": "This value should be of type numeric."
        },
        {
            "error_key": "per_page",
            "error": "wrong_value",
            "error_description": "This value should be greater than 0."
        }
    ]
}

Wrong operator in search (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "operator",
            "error": "wrong_value",
            "error_description": "Operator \"trytest\" is invalid. Allowed operators : equal, is, greater, lower, after, before, notequal, isnot, contains, ends, starts, like."
        }
    ]
}

Wrong field in search (400)

{
    "status": 400,
    "errors": [
        {
            "error_key": "fields.0.key",
            "error": "wrong_value",
            "error_description": "Field \"test\" is invalid. Recognized fields : ext_id, external_id, shipping_amount, discount_amount, total_price, tax_amount, currency, sales_person, creation_date, created_at, ordered_date, ordered_at, c0, c1, c2, c3, c4, c5, c6, c7, c8, c9."
        }
    ]
}
Query Params
integer
1 to 1000
Defaults to 50

Number of items displayed per page.

integer
≥ 1
Defaults to 1

Page number.

fields
array of objects

Use a combination of field, operator and searched value. It will return orders that matched your search. Fields available on search in orders are 'external_id', 'shipping_amount', 'discount_amount', 'total_price', 'tax_amount', 'currency', 'sales_person', 'created_at', 'ordered_at' and custom fields numbers (0, 1, 2, ...)

fields
Responses

401

Authentication failed.

403

Forbidden.

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json