Field | Type | Required | Description | Example |
---|---|---|---|---|
page |
Optional[int] | ➖ | The page number you want to select | |
results |
Optional[int] | ➖ | The number of results to return per page (max 100) | |
order_status |
List[components.OrderStatusEnum] | ➖ | Filter orders by order status | |
shop_app |
Optional[components.OrderShopAppEnum] | ➖ | Filter orders by shop app | Shippo |
start_date |
Optional[str] | ➖ | Filter orders created after the input date and time (ISO 8601 UTC format). This is based on the placed_at field, meaning when the order has been placed, not when the order object was created. |
|
end_date |
Optional[str] | ➖ | Filter orders created before the input date and time (ISO 8601 UTC format). This is based on the placed_at field, meaning when the order has been placed, not when the order object was created. |