Get Batch Errors

Use this endpoint to retrieve booking errors from a batch that has been processed via the Batch Book endpoint. Returns only the quotes that had booking errors.

REST Endpoint

GET /restapi/v1/customers/:customerId/batch/:batchId/errors

Request Example

GET /restapi/v1/customers/TEST00002/batch/42/errors

Response Status Code

200 OK

Response Content Type

application/json

Response JSON Example

{
  "errors": [
    {
      "quoteId": 1236,
      "bookingError": "Insufficient prepay balance"
    },
    {
      "quoteId": 1240,
      "bookingError": "Address validation failed: invalid zip code"
    }
  ]
}

Explanation of Response Fields

Field Type Description
errors array Array of error objects. Empty array if no errors.
errors[n].quoteId integer The quote ID that failed booking
errors[n].bookingError string The error message from the booking attempt

Notes

  • Returns an empty errors array for batches that have not been processed or had no errors.
  • Use this endpoint to review failures after a batch book operation and determine which quotes need attention.