Sign in

v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB
batches

Get Batch Errors

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.

get/v1/batches/{batch_id}/errors

Query parameters

pageinteger

Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.

pagesizeinteger

Response

The request was a success.

Example response

{
  "errors": [
    {
      "error": "Recipient address has not been verified.",
      "shipment_id": "se-28529731"
    }
  ],
  "links": {
    "first": {
      "href": "http://api.shipengine.com/v1/labels/se-28529731"
    },
    "last": {
      "href": "http://api.shipengine.com/v1/labels/se-28529731"
    },
    "prev": {
      "href": "http://api.shipengine.com/v1/labels/se-28529731"
    },
    "next": {
      "href": "http://api.shipengine.com/v1/labels/se-28529731"
    }
  }
}