list_orders
Retrieve paginated orders with filters by status, shop, warehouse, platform, date range, or search by order code, transaction number, or tracking number.
Instructions
List orders with filters. Returns paginated results.
IMPORTANT for AI:
Use 'q' to search by order code, transaction number, or tracking number.
Use date range filters to narrow results.
Response 'meta.pagination' has total, total_pages, current_page for pagination.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Search by order code, transaction number, or tracking number | |
| status | No | Order status (call get_sys_helpers for valid values) | |
| shop_id | No | Filter by shop ID | |
| warehouse_id | No | Filter by warehouse ID | |
| platform | No | Filter by platform (1=shopee, 2=lazada, 3=tiktokshop, 4=tiki, 5=pancake, 6=pos) | |
| start_create_date | No | Creation date range start (YYYY-MM-DD) | |
| end_create_date | No | Creation date range end (YYYY-MM-DD) | |
| sort | No | Sort order (default id:-1 = newest first) | id:-1 |
| limit | No | Page size (default 25) | |
| page | No | Page number (1-indexed) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||