Skip to content

List Orders

Lists every order across all customers — the data behind the admin Sales → Orders screen.

Operation

OperationTypePurpose
adminOrdersQueryCursor-paginated list of all orders

Details

  • Requires an admin Bearer token in the Authorization header.
  • Cursor pagination — pass first for the page size and after (the endCursor from the previous page) to advance. pageInfo.hasNextPage tells you when to stop; totalCount is the grand total.
  • Each node is a slim order row — flat fields only. Heavy relations (full items, invoices, shipments) are not embedded here; fetch a single order's detail for those.
  • The REST equivalent (GET /api/admin/orders) uses offset pagination with a { data, meta } envelope instead of cursors.

Filtering

Pass any of these arguments alongside first / after to narrow the list (they mirror the admin datagrid filters):

ArgumentDescription
order_idOrder increment ID — partial match
statuspending, pending_payment, processing, completed, canceled, closed, fraud
grand_totalExact grand total (matched against the base grand total)
grand_total_from, grand_total_toGrand total range (minimum / maximum)
channelChannel ID
customerCustomer name — partial match
emailCustomer email — partial match
date_rangePreset: today, yesterday, this_week, this_month, last_month, last_three_months, last_six_months, this_year
date_from, date_toCustom date range (Y-m-d) — overrides date_range
sort, orderSort field + asc / desc (default created_at desc)

Released under the MIT License.