BAbagisto
Admin Sales: Orders

List orders

Changed on

Paginated, filterable list of all orders across every customer. Returns a slim row per order in a { data, meta } envelope; use the order detail and sub-resources for items / invoices / shipments.

get/orders

Request

Query parameters

pageinteger
Example:1

Page number

per_pageinteger
Example:10

Items per page (max 50)

querystring
Example:john

Quick search: matches customer email, status or customer name (partial) or the order increment ID (exact), combined with OR

customer_idinteger
Example:12

Only orders placed by this customer

order_idstring

Filter by order increment ID (partial match)

status'pending' | 'pending_payment' | 'processing' | 'completed' | 'canceled' | 'closed' | 'fraud'

Filter by status

grand_totalnumber

Filter by base grand total (exact)

grand_total_fromnumber

Filter by base grand total (minimum)

grand_total_tonumber

Filter by base grand total (maximum)

channelinteger

Filter by channel ID

customerstring

Filter by customer name (partial match)

emailstring

Filter by customer email (partial match)

date_range'today' | 'yesterday' | 'this_week' | 'this_month' | 'last_month' | 'last_three_months' | 'last_six_months' | 'this_year'

Date preset (matches the admin datagrid)

date_fromstring date

Custom range start (Y-m-d)

date_tostring date

Custom range end (Y-m-d)

sortstring
Example:created_at

Sort field

order'asc' | 'desc'
Example:desc

Sort direction

Response

Paginated list of orders in the { data, meta } envelope.

Changes

  • 3198f11be70fRevision changes
    • info

      added the new optional query request parameter customer_id

    • info

      added the new optional query request parameter query