List orders with filters
starshipit_list_ordersRead-only
List full order details for one status (Unshipped by default, or Shipped / Printed), narrowed by a filter such as Order:::1419,Country:::Australia and sorted. Heavier than the summary: use starshipit_orders_summary for overviews. Label files are not returned. GET /api/orders (no id).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| filter | No | Filter string COLUMN:::VALUE, several separated by commas, e.g. `Order:::1419,State:::NSW` or `Source:::Shopify`. Columns: Order, Name, Address (valid), Date (>=MAY 2024), Source, State, Country, Carrier, Service, Status, SKU, SingleSKU, Writeback, Weight (>=5), ShippingMethod, ShippingDescription, Tag. Prefix a column with ! to negate (!Country:::Australia). | |
| status | No | Order status (default Unshipped). | |
| include | No | Extra sections to include. | |
| page_size | No | Results per page, 1-100 (default 25). | |
| page_number | No | Page number, from 1 (default 1). Pass the previous reply's next_page. | |
| sort_column | No | ||
| sort_direction | No |