List Batch Errors

tip

Requirements

Batches must be shipped from the same warehouse.

Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by getting a batch and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.

Example

GET /v1/batches/:batch_id/errors

GET /v1/batches/se-1010644/errors HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
{
  "errors": [
  {
    "error": "Recipient address has not been verified.",
    "shipment_id": "se-1085084"
  }
  ],
  "links": {
  "first": {
    "href": "https://api.shipengine.com/v1/batches/se-1000723/errors?page=1&page_size=100"
  },
  "last": {
    "href": "https://api.shipengine.com/v1/batches/se-1000723/errors?page=1&page_size=100"
  },
    "prev": {},
    "next": {}
  }
}