List orders
list_ordersManage store operations by searching orders. Filter results by status, date range, or customer ID to monitor delivery timelines and identify late shipments.
Instructions
Search orders with filters (status, customer, placed date range, total range, late-only) and pagination. Each row includes total, amount refunded, and delivery timing (promised vs delivered date, days late).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | placed_at_desc | |
| limit | No | Page size, 1-100 (default 20). | |
| offset | No | Rows to skip; use next_offset from the previous page. | |
| status | No | Only orders in this status or any of these statuses, e.g. "paid" or ["paid","shipped"]. | |
| late_only | No | Only late orders: delivered after the promised date, or paid/shipped and already past it (overdue). Check each row's delivery_status to tell them apart. | |
| placed_to | No | Placed on or before this date (YYYY-MM-DD, inclusive). | |
| customer_id | No | Only orders for this customer (see search_customers). | |
| placed_from | No | Placed on or after this date (YYYY-MM-DD, inclusive). | |
| max_total_cents | No | Order total <= this many cents. | |
| min_total_cents | No | Order total >= this many cents. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | Yes | ||
| offset | Yes | ||
| orders | Yes | ||
| next_offset | Yes | Pass as offset to fetch the next page; null on the last page. | |
| total_count | Yes | Rows matching the filters across all pages. |