List orders
list_ordersRetrieve and filter workspace orders by payment, fulfillment, delivery or warehouse status, customer, company, currency, and date range, with cursor-based pagination for large result sets.
Instructions
List orders in the workspace. Filter by payment, fulfillment or delivery status, state (open/closed/canceled), customer, company (B2B), pipeline stage, warehouse queue (to pack, in transit, shipping problem, returns), a search string (customer email or company name), currency, or a date range. Each order carries customerId, companyId and companyName when it was placed for a customer or a company. Paginated: while hasMore is true, pass nextCursor back as cursor while it is set; if hasMore is true but nextCursor is null, page with the offset instead, and past offset 10000 narrow the filter.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_orders"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | How many orders to skip, at most 10000 - the paging offset (there is no offset parameter); page past that with cursor | |
| limit | No | Page size, at most 100; pass nextCursor back as cursor while it is set | |
| queue | No | A warehouse work queue, the same tabs as the admin order list: to_pack = open, paid and not yet fully shipped; in_transit = a parcel has a label or is on its way, without a delivery problem; shipping_problem = delivery status exception; returns = an open return. Combines with every other filter. | |
| state | No | open, closed (done) or canceled | |
| cursor | No | nextCursor from the previous page. The page continues after it in the same filter and sort; leave the skip/offset at 0 when you pass it | |
| dateTo | No | ISO date-time upper bound | |
| search | No | Case-insensitive contains match on the customer email or the frozen company name | |
| currency | No | Only orders placed in this currency (ISO 4217, e.g. EUR) - order totals are never added across currencies, so filter by it before summing | |
| dateFrom | No | ISO date-time lower bound | |
| companyId | No | Only orders placed for this company record (B2B). Pass the company record's id - find it with list_records on the company model named by the account model's auth.companyField; a company name goes into search instead. | |
| customerId | No | ||
| paymentStatus | No | ||
| deliveryStatus | No | ||
| pipelineStageId | No | ||
| fulfillmentStatus | No |