get_orders
Retrieve order packages for your store using status, date range, and pagination filters. View order summaries with status, total price, and customer city details.
Instructions
List order packages (shipment packages) for the store (read-only).
Args: status: Optional filter. Documented values: Created, Picking, Invoiced, Shipped, Cancelled, Delivered, UnDelivered, Returned, AtCollectionPoint, UnSupplied. start_date: 'YYYY-MM-DD' or epoch milliseconds. end_date: 'YYYY-MM-DD' (inclusive) or epoch milliseconds. page: Zero-based page number (API allows pages 0-49). size: Items per page, max 200. include_pii: Customer name and full shipping address are REDACTED by default; set True only when personal data is genuinely needed.
Returns a paged summary: orderNumber, status, orderDate, totalPrice, order lines, and the customer's city only (unless include_pii=True).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | ||
| size | No | ||
| status | No | ||
| end_date | No | ||
| start_date | No | ||
| include_pii | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||