Create a Shipments Batch

Use this endpoint to generate a daily manifest or scan form. Note that some carriers may have up to a 15-minute delay in generating the physical file. If a PDF isn’t returned in the response but the request was successful, wait a few minutes and try a GET request again. Ensure you only include shipment_ids for a single carrier at a time.

Supported Carriers

• USPS
• DHL eCommerce

Unsupported Carriers

• UPS
  • UPS has a concept of manifesting that is mainly done through UPS World Ship. However, PC postage providers like EasyPost don't support it, and therefore neither do we.
• FedEx
  • FedEx doesn't have a concept of manifesting.

Carrier-Specific Notes

DHL

• Most carriers will return the manifest instantly, however DHL has an expected manifest creation time of 2-15 minutes.
• Due to limitations imposed by DHL, clients needing to retrieve or handle the DHL manifest returned from a manifest creation request (batch) should wait at least 1-2 minutes before performing a GET /api/v2/shipments/batches/{shipments_batch_id} request.
  • This will provide the AWS S3 URL located in the "bol_url" field. You can then make a subsequent HTTP GET request to the AWS S3 URL to retrieve the file.
• For domestic and international shipments:
  • Manifests will be split into separate documents.
  • Example: For 115 shipments, with 41 domestic and 74 international, you will receive two documents, one for the 41 domestic shipments and another for the 74 international shipments.

USPS

• USPS will automatically manifest or close out all shipments for a customer at the end of the day, usually around 2:00 AM Central Time.
• Attempting to manifest a package that has been manifested by USPS from this automatic closeout process will result in an error.
• If you need to provide a manifest document to the driver at pick-up, you must create a same-day manifest before USPS automatically closes it out. This document is also known as a Scan Form.