Get Manifest Files
starshipit_get_manifest_filesRetrieve manifest document files as base64 content, optionally filtered by manifest ID, to download carrier pickup PDFs or list available documents.
Instructions
Retrieve manifest documents (PDF, XML, etc.) as base64 file content.
Each manifest can have one or more associated document files that you submit to the carrier at pickup. The markdown format lists file names and sizes. The full base64 content is always in structuredContent; the JSON text output is capped at 25000 characters.
Query parameters:
manifest_id(optional): Filter to files for a specific manifest. Omit to list files across all manifests.limit: Max results per page (default 50, max 250)page: Page number (default 1)
Returns:
files: Array of{ file_name, file_data }, wherefile_datais the base64 file content
Error cases:
404: Manifest ID not found
401/403: Invalid or missing API credentials
Use this tool when:
Downloading a manifest PDF to hand to a carrier driver
Retrieving document URLs for a specific manifest ID
Listing all available manifest documents
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) | |
| manifest_id | No | Filter by a specific manifest ID — omit to return files for all manifests | |
| 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) |