List Batch Errors

If any of your batches encounter an error when processing, you can use the List Batch Errors call to specifically list the errors that occured on a specific batch.

Once you identify the reason(s) your batch failed, you can do the following:

Correct the errors in the shipments by updating the shipment.
Create a new batch for the shipments and rates in the invalid or error state.
Process the new batch.

Example Request & Response

GET /v1/batches/:batch_id/errors

1
2
3
GET /v1/batches/se-12345/errors HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Response

1
2
3
4
5
{
      "error": "Insufficient account balance",
      "shipment_id": "se-12345",
      "external_shipment_id": "TestId-1"
}