list_orders
Updated May 21, 20261 min read
List orders with paging, sorting, search, merchant filters, date filters, and fulfillment-order-aware filters. Use select with json-mask syntax to trim the returned payload.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
tenantId | string | Yes | — |
agg_by | string | No | — |
country_access | oneOf | No | — |
creation_date_from | string | No | — |
creation_date_to | string | No | — |
creation_source_type | oneOf | No | — |
fields | oneOf | No | — |
fulfillment_order_item_cancellation_reason | oneOf | No | — |
fulfillment_order_item_status | oneOf | No | — |
location_access | oneOf | No | — |
location_id | oneOf | No | — |
merchant | oneOf | No | — |
order_date_from | string | No | — |
order_date_to | string | No | — |
order_ids | oneOf | No | — |
order_refs | oneOf | No | — |
page | oneOf | No | — |
page_size | oneOf | No | — |
search_mode | string | No | — |
search_string | string | No | — |
select | string | No | json-mask expression to filter response fields. |
shipping_city | oneOf | No | — |
shipping_country | oneOf | No | — |
shipping_state | oneOf | No | — |
sort_by | string | No | — |
sort_direction | string | No | Values: asc, desc. |
status | oneOf | No | — |
sub_agg_by | string | No | — |
total_quantity_from | oneOf | No | — |
total_quantity_to | oneOf | No | — |
tzoffset | oneOf | No | — |
update_date_from | string | No | — |
update_date_to | string | No | — |
update_source_type | oneOf | No | — |
Example agent prompt
"Show me the recent orders."
list_orders(
tenantId="…"
)