docs/AutoOrderApi.md in ultracart_api-3.10.194 vs docs/AutoOrderApi.md in ultracart_api-3.10.195

- old
+ new

@@ -2,18 +2,76 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2* Method | HTTP request | Description ------------- | ------------- | ------------- +[**consolidate_auto_orders**](AutoOrderApi.md#consolidate_auto_orders) | **PUT** /auto_order/auto_orders/{auto_order_oid}/consolidate | Consolidates multiple auto orders [**establish_auto_order_by_reference_order_id**](AutoOrderApi.md#establish_auto_order_by_reference_order_id) | **POST** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Establish an auto order by referencing a regular order id [**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 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 + + +# **consolidate_auto_orders** +> AutoOrderResponse consolidate_auto_orders(auto_order_consolidate, auto_order_oid, opts) + +Consolidates multiple auto orders + +Consolidates mutliple auto orders on the UltraCart account. + +### Example +```ruby +# load the gem +require 'ultracart_api' + +# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key +simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00' +api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false) + + +auto_order_consolidate = UltracartClient::AutoOrderConsolidate.new # AutoOrderConsolidate | Auto orders to consolidate + +auto_order_oid = 56 # Integer | The auto order oid to consolidate into. + +opts = { + _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples +} + +begin + #Consolidates multiple auto orders + result = api_instance.consolidate_auto_orders(auto_order_consolidate, auto_order_oid, opts) + p result +rescue UltracartClient::ApiError => e + puts "Exception when calling AutoOrderApi->consolidate_auto_orders: #{e}" +end +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **auto_order_consolidate** | [**AutoOrderConsolidate**](AutoOrderConsolidate.md)| Auto orders to consolidate | + **auto_order_oid** | **Integer**| The auto order oid to consolidate into. | + **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional] + +### Return type + +[**AutoOrderResponse**](AutoOrderResponse.md) + +### Authorization + +[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey) + +### HTTP request headers + + - **Content-Type**: application/json; charset=UTF-8 + - **Accept**: application/json + # **establish_auto_order_by_reference_order_id** > AutoOrderResponse establish_auto_order_by_reference_order_id(reference_order_id, opts)