Method: OpenapiClient::BatchesApi#list_batches

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

#list_batches(opts = {}) ⇒ ListBatchesResponseBody

List Batches List Batches associated with your Shipengine account

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (BatchStatus)
  • :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)

  • :page_size (Integer) —

    The number of results to return per response. (default to 25)

  • :sort_dir (SortDir) —

    Controls the sort order of the query.

  • :sort_by (BatchesSortBy)

Returns:



479
480
481
482
 
# File 'lib/openapi_client/api/batches_api.rb', line 479

def list_batches(opts = {})
  data, _status_code, _headers = list_batches_with_http_info(opts)
  data
end