List Orders
Lists every order across all customers — the data behind the admin Sales → Orders screen.
Endpoint
| Endpoint | Method |
|---|---|
/api/admin/orders | GET |
Response envelope
Admin collections return a { data, meta } body envelope:
data— the slim order rows for this page.meta—currentPage,perPage,lastPage,total,from,to.
Each row is slim — flat order fields plus a light items preview (name / sku / qty / thumbnail) for the listing badge. Heavy relations (full items, invoices, shipments) are served by the order detail endpoint, not the listing.
Query parameters
| Parameter | Description |
|---|---|
page, per_page | Pagination (per_page default 10, max 50) |
order_id | Order increment ID — partial match |
status | pending, pending_payment, processing, completed, canceled, closed, fraud |
grand_total | Exact grand total (matched against the base grand total) |
grand_total_from, grand_total_to | Grand total range (minimum / maximum) |
channel | Channel ID |
customer | Customer name — partial match |
email | Customer email — partial match |
date_range | Preset: today, yesterday, this_week, this_month, last_month, last_three_months, last_six_months, this_year |
date_from, date_to | Custom date range (Y-m-d) — overrides date_range |
sort, order | Sort field + asc/desc (default created_at desc) |
Every /api/admin/* request requires an admin Bearer token.