List orders
list_ordersRetrieve paginated store orders, newest first, filtered by update time for incremental sync. Check coverage envelope to detect partial results before reporting completeness.
Instructions
List orders of the store (paginated), newest first. updated_from/updated_to filter by last-change time, which is what an incremental sync should poll on: an order that only changed status still falls inside the window, while a created-at filter would miss it. The filter is inclusive on both ends, so an overlapping window re-delivers boundary orders — deduplicate by order ID. The response carries a machine-readable coverage envelope (coverage, received, total_count, pages_read); coverage:"partial" MUST be reflected in the user-facing answer and forbids claiming the listing is complete.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| all | No | Fetch all pages via auto-pagination, up to 500 items; ignores page/per_page. | |
| page | No | Page number, starting at 1 (default 1). | |
| fields | No | CSV columns; only valid together with format:"csv". Field names are validated against the item schema of the operation's response — an unknown name fails with the list of allowed fields. Default: every top-level scalar field of the item. | |
| format | No | Output format: "csv" renders the items as RFC 4180 CSV (a leading "# coverage:" comment line, then the header row) instead of JSON — cheaper for wide exports. Default: JSON. | |
| redact | No | Use redact:true when the task does not need personal data (e.g. counting or aggregating orders) — personal fields (name, phone, email, date of birth, delivery address and its parts, notes) are replaced with "[redacted]". Applies to the response only; request bodies are never redacted. Default false. | |
| per_page | No | Items per page, 1-100 (default 25). Values outside the range are clamped. | |
| updated_to | No | Latest order update time, inclusive. RFC 3339 date-time, e.g. "2026-10-02T00:00:00Z". | |
| updated_from | No | Earliest order update time, inclusive. RFC 3339 date-time, e.g. "2026-10-01T00:00:00Z". |