ecommerce_listOrdersV1
Filter and list store orders by status, payment, fulfillment, email, or number. Get full order details including line items, addresses, and fulfilments.
Instructions
List a store's orders newest first as summaries. Filter by status, payment or fulfilment status, customer email, order number or a free-text query. Amounts are in the smallest currency unit. Retrieve a single order for its line items, addresses and fulfilments.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Free-text search over customer name, email, order number and line items. | |
| page | No | Page number | |
| No | Customer email, matched exactly. | ||
| status | No | Order statuses to include. | |
| store_id | Yes | The ID of the store to list orders for. | |
| display_id | No | The order number the merchant and customer see. | |
| created_at_to | No | Latest creation time to include, inclusive. A bare date covers that whole day. | |
| payment_status | No | Payment statuses to include. A paid order is "captured". | |
| created_at_from | No | Earliest creation time to include, inclusive. Accepts a date or ISO date-time (UTC). | |
| fulfillment_status | No | Fulfilment statuses to include. |