Get Manifests
machship_get_manifestsReturns a paginated list of manifests for a company (max 200 per call). A manifest represents a carrier pickup booking for a group of consignments.
Instructions
Returns a paginated list of manifests for a company (max 200 per call). A manifest represents a carrier pickup booking for a group of consignments.
Args:
companyId (number, optional): Company ID
startIndex (number, optional): Pagination start index (default 1)
retrieveSize (number, optional): Number to retrieve (default 40, max 200)
carrierId (number, optional): Filter by carrier
includeChildCompanies (boolean, optional): Include sub-companies
startDate / endDate (string, optional): Date range filter (ISO 8601)
response_format ('json' | 'markdown'): Output format (default: 'json')
Returns: Array of manifest summary objects: { "id": number, "manifestDate": string, "carrierName": string, "status": string, "consignmentCount": number }
Examples:
Use when: "List today's manifests" -> set startDate/endDate to today
Use when: You need a manifestId to download a manifest PDF
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| endDate | No | Filter to date (ISO 8601) | |
| carrierId | No | Filter by carrier ID | |
| companyId | No | Company ID | |
| startDate | No | Filter from date (ISO 8601) | |
| startIndex | No | Pagination start index (default 1) | |
| retrieveSize | No | Number of results to return (default 40, max 200) | |
| response_format | No | Output format: 'json' (default) or 'markdown' | json |
| includeChildCompanies | No | Include manifests from child companies |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| errors | No | Validation errors returned by Machship, if any | |
| object | No | Response payload from the Machship API |