Sign in
batches

Get batch errors

Errors in batches must be handled differently from synchronous requests. You must retrieve the status of your batch by getting a batch and getting an overview of the statuses or by listing the batch errors.

get/v2/batches/{batch_id}/errors

Request

  • Base URL: https://api.shipstation.com
  • URL: https://api.shipstation.com/v2/batches/{batch_id}/errors
  • Auth: API key in header api-key

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",
      "external_shipment_id": "1234567"
    }
  ],
  "links": {
    "first": {
      "href": "http://api.shipstation.com/v2/labels/se-28529731",
      "type": "child"
    },
    "last": {
      "href": "http://api.shipstation.com/v2/labels/se-28529731",
      "type": "child"
    },
    "prev": {
      "href": "http://api.shipstation.com/v2/labels/se-28529731",
      "type": "child"
    },
    "next": {
      "href": "http://api.shipstation.com/v2/labels/se-28529731",
      "type": "child"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.