Manifest Shipments
starshipit_manifest_shipmentFinalise and commit StarShipIt shipments to the carrier by order IDs, generating a manifest PDF for end-of-day or batch pickup.
Instructions
Manifest (finalise/close) shipments by order IDs in StarShipIt.
When to use: Use this tool to finalise and commit shipments to the carrier. Manifesting is typically done once at end-of-day or when a batch of orders is ready for carrier pickup. Once manifested, shipments cannot be easily reversed — ensure labels are correct before manifesting.
Important: This operation is idempotent — manifesting already-manifested orders will not create duplicate manifests.
Parameters:
order_ids(required): Array of numeric StarShipIt order IDs to include in the manifest. All orders must already have labels printed.
Returns: The manifest document as a base64 PDF, with its label type.
Example success response:
{
"success": true,
"label_type": "PDF",
"pdf": "JVBERi0xLjQK..."
}Error cases: 400 if order IDs are invalid or orders do not have labels printed; 404 if orders do not exist; 409 if orders are in an incompatible state for manifesting.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_ids | Yes | Array of StarShipIt order IDs to manifest. All must have labels already printed. |
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) |