List orders
aryeo_list_ordersList the orders of your Aryeo company (newest first by default), with payment status, fulfillment status, totals and links. Filter by search text (address or customer), payment/fulfillment status, appointment date range, tags or assigned users. GET /orders.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| sort | No | Comma-separated sort fields; a leading - sorts descending. Default -created_at. | |
| search | No | Orders whose address or customer matches this text, e.g. a street name. | |
| include | No | Comma-separated relations to expand. Examples: items, listing, customer, appointments, appointments.users, unconfirmed_appointments, order_form, discounts, discounts.coupon. An unknown value makes Aryeo reply with the allowed list. | |
| tag_ids | No | Orders carrying any of these tag ids. | |
| per_page | No | Results per page, 1-100 (Aryeo default 25). | |
| user_ids | No | Orders that have appointments with any of these user ids (user ids = company_user.id from aryeo_list_team_members, not the team member id). | |
| payment_status | No | Only orders with this payment status. | |
| creator_group_id | No | Only orders owned by this creator group (UUID). | |
| fulfillment_status | No | Only orders with this fulfillment status. | |
| appointment_start_after | No | Only orders with an appointment starting after this moment. ISO 8601 date-time with a timezone, e.g. 2026-10-01T13:00:00Z. | |
| appointment_start_before | No | Only orders with an appointment starting before this moment. ISO 8601 date-time with a timezone, e.g. 2026-10-01T13:00:00Z. |