Method: OrderCloud::AdminAddressApi#list

Defined in:
lib/order_cloud/api/admin_address_api.rb

#list(opts = {}) ⇒ ListAddress

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search (String) —

    Word or phrase to search for.

  • :search_on (String) —

    Comma-delimited list of fields to search on.

  • :sort_by (String) —

    Comma-delimited list of fields to sort by.

  • :page (Integer) —

    Page of results to return. Default: 1

  • :page_size (Integer) —

    Number of results to return per page. Default: 20, max: 100.

  • :filters (Hash<String, String>) —

    Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or &#39;xp.???&#39;

Returns:



214
215
216
217
 
# File 'lib/order_cloud/api/admin_address_api.rb', line 214

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  return data
end