get_orders
Retrieve store orders with filters for status, time period, and pagination. Use to manage and analyze sales data efficiently in CS-Cart.
Instructions
Retrieve orders from the CS-Cart store
Input Schema
Name | Required | Description | Default |
---|---|---|---|
items_per_page | No | Number of items per page | |
page | No | Page number for pagination | |
period | No | Time period filter (A=All time, D=Today, W=This week, M=This month, Y=This year) | |
status | No | Order status filter (O=Open, P=Processed, C=Complete, F=Failed, D=Declined, B=Backordered, I=Incomplete) | |
time_from | No | Start date for custom period (YYYY-MM-DD) | |
time_to | No | End date for custom period (YYYY-MM-DD) | |
user_id | No | Filter by user ID |
Input Schema (JSON Schema)
{
"properties": {
"items_per_page": {
"default": 10,
"description": "Number of items per page",
"type": "number"
},
"page": {
"default": 1,
"description": "Page number for pagination",
"type": "number"
},
"period": {
"description": "Time period filter (A=All time, D=Today, W=This week, M=This month, Y=This year)",
"enum": [
"A",
"D",
"W",
"M",
"Y"
],
"type": "string"
},
"status": {
"description": "Order status filter (O=Open, P=Processed, C=Complete, F=Failed, D=Declined, B=Backordered, I=Incomplete)",
"enum": [
"O",
"P",
"C",
"F",
"D",
"B",
"I"
],
"type": "string"
},
"time_from": {
"description": "Start date for custom period (YYYY-MM-DD)",
"type": "string"
},
"time_to": {
"description": "End date for custom period (YYYY-MM-DD)",
"type": "string"
},
"user_id": {
"description": "Filter by user ID",
"type": "number"
}
},
"type": "object"
}