Get Orders Summary
starshipit_get_orders_summaryRetrieve a paginated summary of StarShipIt orders filtered by status for dashboards and reporting. Get status-specific counts or listings with optional sorting, not for fulfilment operations.
Instructions
Get a summary of orders filtered by status from StarShipIt. Useful for dashboards and reporting.
When to use: Use when you need a status-specific count or listing for reporting, not fulfilment operations. Supports sorting and pagination.
Parameters:
order_status(required) — Status to filter on (e.g."shipped","unshipped","delivered","archived")sort(optional) — Sort field; refer to the StarShipIt API docs for supported valueslimit(optional, default 50, max 250) — Number of results per pagepage(optional, default 1) — Page numberresponse_format—"markdown"(default) or"json"
Returns: Summary list of orders for the given status. Includes has_more flag.
Errors: 400 if order_status is not a recognised value; 401 if API keys invalid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (default: 1) | |
| sort | No | Sort field for results (refer to StarShipIt API docs for supported values) | |
| limit | No | Maximum number of results to return (default: 50, max: 250) | |
| order_status | Yes | Order status to summarise — e.g. "shipped", "unshipped", "delivered", "archived" | |
| response_format | No | Output format: 'markdown' for human-readable or 'json' for machine-readable | markdown |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation or processing errors returned by StarShipIt | |
| object | No | The response payload when StarShipIt returns a non-object value | |
| success | No | StarShipIt success flag (a boolean on most endpoints) |