Skip to content
Last-mile
/
/
List orders

List orders

Request

Return a list of orders filtered by the given date parameters. The date format has to be YYYY-MM-DD

Security
bearerToken or oauthToken
Query
pageinteger, (int32)required
fromstringrequired

YYYY-MM-DD

tostringrequired

YYYY-MM-DD

per_pageinteger, (int32)required
filters[state]string

Optional. One of the lowercase state values. An unrecognised or wrongly-cased value returns 200 with an empty results array and, confusingly, total: 1. Branch on results.length, not on total. Without this filter the list leaves out pending orders; send pending to include them.

filters[partner_order_id]string

Matches every reference that contains this value, ignoring case, so ORDER-1 also matches ORDER-10. On its own it does not find pending orders, because the list leaves them out unless filters[state] asks for them. A timed-out create leaves a pending order, so to check whether it landed send filters[state]=pending together with this filter.

curl -i -X GET \
  'https://api.staging.quiqup.com/orders?page=0&from=string&to=string&per_page=0&filters%5Bstate%5D=string&filters%5Bpartner_order_id%5D=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

A page of orders matching the filters.

Headers
any
Bodyapplication/json
current_pageinteger
per_pageinteger
totalinteger
total_pagesinteger
resultsArray of objects
Response
{
  "current_page": 0,
  "per_page": 0,
  "total": 0,
  "total_pages": 0,
  "results": [
    {}
  ]
}