docs/AutoOrderApi.md in ultracart_api-3.1.0 vs docs/AutoOrderApi.md in ultracart_api-3.1.1

- old
+ new

@@ -2,24 +2,24 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order -[**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order -[**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order +[**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid +[**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code +[**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id [**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders [**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch -[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders +[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query [**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders # **get_auto_order** > AutoOrderResponse get_auto_order(auto_order_oid, opts) -Retrieve an auto order +Retrieve an auto order by oid Retrieves a single auto order using the specified auto order oid. ### Example ```ruby @@ -36,11 +36,11 @@ opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } begin - #Retrieve an auto order + #Retrieve an auto order by oid result = api_instance.get_auto_order(auto_order_oid, opts) p result rescue UltracartClient::ApiError => e puts "Exception when calling AutoOrderApi->get_auto_order: #{e}" end @@ -69,11 +69,11 @@ # **get_auto_order_by_code** > AutoOrderResponse get_auto_order_by_code(auto_order_code, opts) -Retrieve an auto order +Retrieve an auto order by code Retrieves a single auto order using the specified reference (original) order id. ### Example ```ruby @@ -90,11 +90,11 @@ opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } begin - #Retrieve an auto order + #Retrieve an auto order by code result = api_instance.get_auto_order_by_code(auto_order_code, opts) p result rescue UltracartClient::ApiError => e puts "Exception when calling AutoOrderApi->get_auto_order_by_code: #{e}" end @@ -123,11 +123,11 @@ # **get_auto_order_by_reference_order_id** > AutoOrderResponse get_auto_order_by_reference_order_id(reference_order_id, opts) -Retrieve an auto order +Retrieve an auto order by order id Retrieves a single auto order using the specified reference (original) order id. ### Example ```ruby @@ -144,11 +144,11 @@ opts = { _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples } begin - #Retrieve an auto order + #Retrieve an auto order by order id result = api_instance.get_auto_order_by_reference_order_id(reference_order_id, opts) p result rescue UltracartClient::ApiError => e puts "Exception when calling AutoOrderApi->get_auto_order_by_reference_order_id: #{e}" end @@ -326,11 +326,11 @@ # **get_auto_orders_by_query** > AutoOrdersResponse get_auto_orders_by_query(auto_order_query, opts) -Retrieve auto orders +Retrieve auto orders by query Retrieves a group of auto orders from the account based on a query object. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. ### Example ```ruby @@ -350,10 +350,10 @@ _sort: '_sort_example', # String | The sort order of the auto orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. _expand: '_expand_example' # String | The object expansion to perform on the result. } begin - #Retrieve auto orders + #Retrieve auto orders by query result = api_instance.get_auto_orders_by_query(auto_order_query, opts) p result rescue UltracartClient::ApiError => e puts "Exception when calling AutoOrderApi->get_auto_orders_by_query: #{e}" end