Method: OpenapiClient::BatchesApi#list_batch_errors

Defined in:
lib/openapi_client/api/batches_api.rb

#list_batch_errors(batch_id, opts = {}) ⇒ ListBatchErrorsResponseBody

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](www.shipengine.com/docs/reference/get-batch-by-id/) and getting an overview of the statuses or you can list errors directly here below to get detailed information about the errors.

Parameters:

  • batch_id (String) —

    Batch ID

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    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. (default to 1)

  • :pagesize (Integer)

Returns:



388
389
390
391
 
# File 'lib/openapi_client/api/batches_api.rb', line 388

def list_batch_errors(batch_id, opts = {})
  data, _status_code, _headers = list_batch_errors_with_http_info(batch_id, opts)
  data
end