list_orders
Retrieve and filter orders using pagination, sorting, and date-based criteria via the ShipStation API. Manage order lists by status, store, or creation/modification date for efficient order tracking and processing.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| createDateEnd | No | Filter by creation date (end) | |
| createDateStart | No | Filter by creation date (start) | |
| modifyDateEnd | No | Filter by modification date (end) | |
| modifyDateStart | No | Filter by modification date (start) | |
| orderStatus | No | Filter by order status | |
| page | No | Page number | |
| pageSize | No | Number of orders per page (max 500) | |
| sortBy | No | Sort orders by a specific field | |
| sortDir | No | Sort direction | |
| storeId | No | Filter by store ID |
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {
"createDateEnd": {
"description": "Filter by creation date (end)",
"type": "string"
},
"createDateStart": {
"description": "Filter by creation date (start)",
"type": "string"
},
"modifyDateEnd": {
"description": "Filter by modification date (end)",
"type": "string"
},
"modifyDateStart": {
"description": "Filter by modification date (start)",
"type": "string"
},
"orderStatus": {
"description": "Filter by order status",
"type": "string"
},
"page": {
"description": "Page number",
"type": "number"
},
"pageSize": {
"description": "Number of orders per page (max 500)",
"type": "number"
},
"sortBy": {
"description": "Sort orders by a specific field",
"type": "string"
},
"sortDir": {
"description": "Sort direction",
"enum": [
"ASC",
"DESC"
],
"type": "string"
},
"storeId": {
"description": "Filter by store ID",
"type": "number"
}
},
"type": "object"
}