Batch Shipment APIs (1.0.0)
The Batch Shipment APIs provide operations to create, import, process, track, and manage shipments in bulk. These APIs enable submission of multiple shipments in a single request or through file-based import, supporting high-volume shipping workflows.
Batch shipment processing supports two modes:
- Synchronous bulk creation using API payloads
- Asynchronous batch processing using file import (CSV via S3 URL)
The APIs also support ERR (Electronic Return Receipt) shipments, allowing generation of compliant return receipt documents for USPS shipments.
Batch
A collection of shipments grouped under a single processing request, identified by batchId.
Root Level attributes (Default)
Defines common attributes (e.g., carrier, service, parcel type) applied to all shipments in the batch.
Shipment Level attributes
Defines attributes specific to individual shipments. Values provided at this level override root-level defaults.
Combination Rule
carrierAccountId, parcelType, and serviceId must be provided together at the shipment level. Partial values result in validation errors.
Batch ID (batchId)
A system-generated identifier used to process, track, and manage batch operations.
- Bulk shipments can be created via API payload or imported using a CSV file hosted on S3
- Batch import generates a batchId used for further processing and tracking
- Batch processing is triggered explicitly using the
Process Batch API - Batch status and shipment-level results can be retrieved using
batchId - Shipments within a batch can be voided either partially (specific shipment IDs) or entire batch
- ERR batch supports additional document formats such as Shipping Label and Coversheet