List Manifests
starshipit_list_manifestsList all manifests in your StarShipIt account.
Instructions
List all manifests in your StarShipIt account.
Manifests group shipments that have been closed/submitted to a carrier. A manifest is created when you "manifest" a set of shipments, signalling to the carrier that they are ready for collection.
Returns: Manifest ID, name, date, carrier ID, and the number of consignments and articles in each manifest.
Example response fields:
id: Unique identifier for the manifestname: Manifest namedate: ISO 8601 timestamp of the manifestcarrierId: Numeric carrier IDnumberConsignments/numberArticles: Counts in the manifesttotal_count/total_pages: Pagination totals
Pagination: Use limit (max 250) and page to page through results.
Error cases:
401/403: Invalid or missing API credentials
Use this tool when:
Reviewing past manifests for a carrier
Looking up a manifest ID before downloading its PDF
Auditing which shipments have been submitted to carriers
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (default: 1) | |
| limit | No | Maximum number of results to return (default: 50, max: 250) | |
| 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) |