Manifest All Shipments by Carrier
starshipit_manifest_by_carrierBulk-manifest all unmanifested shipments for a specific carrier in one operation, creating a single manifest document for end-of-day carrier pickup.
Instructions
Manifest ALL unmanifested shipments for a specific carrier in one operation.
This is a bulk operation that closes every shipment that is ready-to-manifest for the given carrier and creates a single manifest document for them. Use this at end-of-day or before carrier pickup when you want to submit everything at once.
Body parameters:
carrier(required): The carrier identifier string. Common values:"AusPost"— Australia Post"PlainLabel"— Generic/plain label carrier"DHL"— DHL Express"StarTrack"— StarTrack"Fastway"— Fastway / Aramex Check your StarShipIt account carrier settings for the exact identifier strings available.
Returns:
records_manifested: Number of shipments manifestedsuccess: Whether the manifest was created successfullyerrors: Any errors encountered during manifesting
Error cases:
400: Invalid or unrecognised carrier name
404: No unmanifested shipments found for this carrier
409: Conflict — may already be manifested
Use this tool when:
Performing an end-of-day manifest run for a specific carrier
You want to submit ALL pending shipments for a carrier at once rather than selecting individually
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| carrier | Yes | Carrier identifier (e.g. "AusPost", "PlainLabel", "DHL", "StarTrack", "Fastway"). Must match the carrier name as configured in StarShipIt. | |
| 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) |