List Delivered Orders
starshipit_list_delivered_ordersRetrieves delivered orders confirmed by the carrier for post-delivery reporting, customer-service lookups, and reconciliation; optionally filters by order reference.
Instructions
List delivered orders from StarShipIt. Returns orders where the carrier has confirmed delivery.
When to use: Use for post-delivery reporting, customer-service lookups, or reconciliation workflows.
Parameters:
order_ref(optional) — Filter by order reference string; useful for looking up a specific customer's deliveriesresponse_format—"markdown"(default) or"json"
Returns: List of delivered Order objects including carrier and destination details.
Errors: 401 if API keys invalid.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_ref | No | Filter delivered orders by order reference string | |
| 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) |