npm - ultra_cart_rest_api_v2 - Versions diffs - 3.10.14 → 4.0.5 - Mend

ultra_cart_rest_api_v2 3.10.14 → 4.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (2041) hide show

package/docs/OrderApi.md DELETED Viewed

@@ -1,1309 +0,0 @@
-# UltraCartRestApiV2.OrderApi
-All URIs are relative to *https://secure.ultracart.com/rest/v2*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**adjustOrderTotal**](OrderApi.md#adjustOrderTotal) | **POST** /order/orders/{order_id}/adjust_order_total/{desired_total} | Adjusts an order total
-[**cancelOrder**](OrderApi.md#cancelOrder) | **POST** /order/orders/{order_id}/cancel | Cancel an order
-[**deleteOrder**](OrderApi.md#deleteOrder) | **DELETE** /order/orders/{order_id} | Delete an order
-[**duplicateOrder**](OrderApi.md#duplicateOrder) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
-[**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
-[**generateOrderToken**](OrderApi.md#generateOrderToken) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
-[**generatePackingSlipAllDC**](OrderApi.md#generatePackingSlipAllDC) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
-[**generatePackingSlipSpecificDC**](OrderApi.md#generatePackingSlipSpecificDC) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
-[**getAccountsReceivableRetryConfig**](OrderApi.md#getAccountsReceivableRetryConfig) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
-[**getAccountsReceivableRetryStats**](OrderApi.md#getAccountsReceivableRetryStats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
-[**getOrder**](OrderApi.md#getOrder) | **GET** /order/orders/{order_id} | Retrieve an order
-[**getOrderByToken**](OrderApi.md#getOrderByToken) | **POST** /order/orders/token | Retrieve an order using a token
-[**getOrders**](OrderApi.md#getOrders) | **GET** /order/orders | Retrieve orders
-[**getOrdersBatch**](OrderApi.md#getOrdersBatch) | **POST** /order/orders/batch | Retrieve order batch
-[**getOrdersByQuery**](OrderApi.md#getOrdersByQuery) | **POST** /order/orders/query | Retrieve orders by query
-[**insertOrder**](OrderApi.md#insertOrder) | **POST** /order/orders | Insert an order
-[**processPayment**](OrderApi.md#processPayment) | **POST** /order/orders/{order_id}/process_payment | Process payment
-[**refundOrder**](OrderApi.md#refundOrder) | **PUT** /order/orders/{order_id}/refund | Refund an order
-[**replacement**](OrderApi.md#replacement) | **POST** /order/orders/{order_id}/replacement | Replacement order
-[**resendReceipt**](OrderApi.md#resendReceipt) | **POST** /order/orders/{order_id}/resend_receipt | Resend receipt
-[**resendShipmentConfirmation**](OrderApi.md#resendShipmentConfirmation) | **POST** /order/orders/{order_id}/resend_shipment_confirmation | Resend shipment confirmation
-[**updateAccountsReceivableRetryConfig**](OrderApi.md#updateAccountsReceivableRetryConfig) | **POST** /order/accountsReceivableRetryConfig | Update A/R Retry Configuration
-[**updateOrder**](OrderApi.md#updateOrder) | **PUT** /order/orders/{order_id} | Update an order
-<a name="adjustOrderTotal"></a>
-# **adjustOrderTotal**
-> BaseResponse adjustOrderTotal(order_id, desired_total)
-Adjusts an order total
-Adjusts an order total.  Adjusts individual items appropriately and considers taxes.  Desired total should be provided in the same currency as the order and must be less than the current total and greater than zero.  This call will change the order total.  It returns true if the desired total is achieved.  If the goal seeking algorithm falls short (usually by pennies), this method returns back false.  View the merchant notes for the order for further details.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to cancel.
-var desired_total = "desired_total_example"; // String | The desired total with no formatting. example 123.45
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.adjustOrderTotal(order_id, desired_total, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to cancel. |
- **desired_total** | **String**| The desired total with no formatting. example 123.45 |
-### Return type
-[**BaseResponse**](BaseResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="cancelOrder"></a>
-# **cancelOrder**
-> BaseResponse cancelOrder(order_id)
-Cancel an order
-Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to cancel.
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.cancelOrder(order_id, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to cancel. |
-### Return type
-[**BaseResponse**](BaseResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="deleteOrder"></a>
-# **deleteOrder**
-> deleteOrder(order_id)
-Delete an order
-Delete an order on the UltraCart account.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to delete.
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-apiInstance.deleteOrder(order_id, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to delete. |
-### Return type
-null (empty response body)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="duplicateOrder"></a>
-# **duplicateOrder**
-> OrderResponse duplicateOrder(order_id, opts)
-Duplicate an order
-Perform a duplicate of the specified order_id and return a new order located in Accounts Receivable.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to duplicate.
-var opts = {
-  '_expand': "_expand_example" // String | The object expansion to perform on the result.  See documentation for examples
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.duplicateOrder(order_id, opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to duplicate. |
- **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional]
-### Return type
-[**OrderResponse**](OrderResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json; charset=UTF-8
- - **Accept**: application/json
-<a name="format"></a>
-# **format**
-> OrderFormatResponse format(order_id, format_options)
-Format order
-Format the order for display at text or html
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to format
-var format_options = new UltraCartRestApiV2.OrderFormat(); // OrderFormat | Format options
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.format(order_id, format_options, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to format |
- **format_options** | [**OrderFormat**](OrderFormat.md)| Format options |
-### Return type
-[**OrderFormatResponse**](OrderFormatResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="generateOrderToken"></a>
-# **generateOrderToken**
-> OrderTokenResponse generateOrderToken(order_id)
-Generate an order token for a given order id
-Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to generate a token for.
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.generateOrderToken(order_id, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to generate a token for. |
-### Return type
-[**OrderTokenResponse**](OrderTokenResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="generatePackingSlipAllDC"></a>
-# **generatePackingSlipAllDC**
-> OrderPackingSlipResponse generatePackingSlipAllDC(order_id)
-Generate a packing slip for this order across all distribution centers.
-The packing slip PDF that is returned is base 64 encoded
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | Order ID
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.generatePackingSlipAllDC(order_id, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| Order ID |
-### Return type
-[**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="generatePackingSlipSpecificDC"></a>
-# **generatePackingSlipSpecificDC**
-> OrderPackingSlipResponse generatePackingSlipSpecificDC(distribution_center_code, order_id)
-Generate a packing slip for this order for the given distribution center.
-The packing slip PDF that is returned is base 64 encoded
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var distribution_center_code = "distribution_center_code_example"; // String | Distribution center code
-var order_id = "order_id_example"; // String | Order ID
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.generatePackingSlipSpecificDC(distribution_center_code, order_id, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **distribution_center_code** | **String**| Distribution center code |
- **order_id** | **String**| Order ID |
-### Return type
-[**OrderPackingSlipResponse**](OrderPackingSlipResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="getAccountsReceivableRetryConfig"></a>
-# **getAccountsReceivableRetryConfig**
-> AccountsReceivableRetryConfigResponse getAccountsReceivableRetryConfig()
-Retrieve A/R Retry Configuration
-Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.getAccountsReceivableRetryConfig(callback);
-```
-### Parameters
-This endpoint does not need any parameter.
-### Return type
-[**AccountsReceivableRetryConfigResponse**](AccountsReceivableRetryConfigResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="getAccountsReceivableRetryStats"></a>
-# **getAccountsReceivableRetryStats**
-> AccountsReceivableRetryStatsResponse getAccountsReceivableRetryStats(opts)
-Retrieve A/R Retry Statistics
-Retrieve A/R Retry Statistics. This is primarily an internal API call.  It is doubtful you would ever need to use it.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var opts = {
-  'from': "from_example", // String |
-  'to': "to_example" // String |
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.getAccountsReceivableRetryStats(opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **from** | **String**|  | [optional]
- **to** | **String**|  | [optional]
-### Return type
-[**AccountsReceivableRetryStatsResponse**](AccountsReceivableRetryStatsResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="getOrder"></a>
-# **getOrder**
-> OrderResponse getOrder(order_id, opts)
-Retrieve an order
-Retrieves a single order using the specified order id.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to retrieve.
-var opts = {
-  '_expand': "_expand_example" // String | The object expansion to perform on the result.  See documentation for examples
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.getOrder(order_id, opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to retrieve. |
- **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional]
-### Return type
-[**OrderResponse**](OrderResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="getOrderByToken"></a>
-# **getOrderByToken**
-> OrderResponse getOrderByToken(order_by_token_query, opts)
-Retrieve an order using a token
-Retrieves a single order using the specified order token.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_by_token_query = new UltraCartRestApiV2.OrderByTokenQuery(); // OrderByTokenQuery | Order by token query
-var opts = {
-  '_expand': "_expand_example" // String | The object expansion to perform on the result.  See documentation for examples
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.getOrderByToken(order_by_token_query, opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_by_token_query** | [**OrderByTokenQuery**](OrderByTokenQuery.md)| Order by token query |
- **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional]
-### Return type
-[**OrderResponse**](OrderResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="getOrders"></a>
-# **getOrders**
-> OrdersResponse getOrders(opts)
-Retrieve orders
-Retrieves a group of orders from the account.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var opts = {
-  'order_id': "order_id_example", // String | Order Id
-  'payment_method': "payment_method_example", // String | Payment Method
-  'company': "company_example", // String | Company
-  'first_name': "first_name_example", // String | First Name
-  'last_name': "last_name_example", // String | Last Name
-  'city': "city_example", // String | City
-  'state_region': "state_region_example", // String | State/Region
-  'postal_code': "postal_code_example", // String | Postal Code
-  'country_code': "country_code_example", // String | Country Code (ISO-3166 two letter)
-  'phone': "phone_example", // String | Phone
-  'email': "email_example", // String | Email
-  'cc_email': "cc_email_example", // String | CC Email
-  'total': 8.14, // Number | Total
-  'screen_branding_theme_code': "screen_branding_theme_code_example", // String | Screen Branding Theme Code
-  'storefront_host_name': "storefront_host_name_example", // String | StoreFront Host Name
-  'creation_date_begin': "creation_date_begin_example", // String | Creation Date Begin
-  'creation_date_end': "creation_date_end_example", // String | Creation Date End
-  'payment_date_begin': "payment_date_begin_example", // String | Payment Date Begin
-  'payment_date_end': "payment_date_end_example", // String | Payment Date End
-  'shipment_date_begin': "shipment_date_begin_example", // String | Shipment Date Begin
-  'shipment_date_end': "shipment_date_end_example", // String | Shipment Date End
-  'rma': "rma_example", // String | RMA
-  'purchase_order_number': "purchase_order_number_example", // String | Purchase Order Number
-  'item_id': "item_id_example", // String | Item Id
-  'current_stage': "current_stage_example", // String | Current Stage
-  'channel_partner_code': "channel_partner_code_example", // String | Channel Partner Code
-  'channel_partner_order_id': "channel_partner_order_id_example", // String | Channel Partner Order ID
-  '_limit': 100, // Number | The maximum number of records to return on this one API call. (Maximum 200)
-  '_offset': 0, // Number | Pagination of the record set.  Offset is a zero based index.
-  '_sort': "_sort_example", // String | The sort order of the 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.
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.getOrders(opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| Order Id | [optional]
- **payment_method** | **String**| Payment Method | [optional]
- **company** | **String**| Company | [optional]
- **first_name** | **String**| First Name | [optional]
- **last_name** | **String**| Last Name | [optional]
- **city** | **String**| City | [optional]
- **state_region** | **String**| State/Region | [optional]
- **postal_code** | **String**| Postal Code | [optional]
- **country_code** | **String**| Country Code (ISO-3166 two letter) | [optional]
- **phone** | **String**| Phone | [optional]
- **email** | **String**| Email | [optional]
- **cc_email** | **String**| CC Email | [optional]
- **total** | **Number**| Total | [optional]
- **screen_branding_theme_code** | **String**| Screen Branding Theme Code | [optional]
- **storefront_host_name** | **String**| StoreFront Host Name | [optional]
- **creation_date_begin** | **String**| Creation Date Begin | [optional]
- **creation_date_end** | **String**| Creation Date End | [optional]
- **payment_date_begin** | **String**| Payment Date Begin | [optional]
- **payment_date_end** | **String**| Payment Date End | [optional]
- **shipment_date_begin** | **String**| Shipment Date Begin | [optional]
- **shipment_date_end** | **String**| Shipment Date End | [optional]
- **rma** | **String**| RMA | [optional]
- **purchase_order_number** | **String**| Purchase Order Number | [optional]
- **item_id** | **String**| Item Id | [optional]
- **current_stage** | **String**| Current Stage | [optional]
- **channel_partner_code** | **String**| Channel Partner Code | [optional]
- **channel_partner_order_id** | **String**| Channel Partner Order ID | [optional]
- **_limit** | **Number**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
- **_offset** | **Number**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
- **_sort** | **String**| The sort order of the orders.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
- **_expand** | **String**| The object expansion to perform on the result. | [optional]
-### Return type
-[**OrdersResponse**](OrdersResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="getOrdersBatch"></a>
-# **getOrdersBatch**
-> OrdersResponse getOrdersBatch(order_batch, opts)
-Retrieve order batch
-Retrieves a group of orders from the account based on an array of order ids.  If more than 500 order ids are specified, the API call will fail with a bad request error.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_batch = new UltraCartRestApiV2.OrderQueryBatch(); // OrderQueryBatch | Order batch
-var opts = {
-  '_expand': "_expand_example" // String | The object expansion to perform on the result.
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.getOrdersBatch(order_batch, opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_batch** | [**OrderQueryBatch**](OrderQueryBatch.md)| Order batch |
- **_expand** | **String**| The object expansion to perform on the result. | [optional]
-### Return type
-[**OrdersResponse**](OrdersResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="getOrdersByQuery"></a>
-# **getOrdersByQuery**
-> OrdersResponse getOrdersByQuery(order_query, opts)
-Retrieve orders by query
-Retrieves a group of orders from the account based on a query object.  If no parameters are specified, the API call will fail with a bad request error.  Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in.  You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_query = new UltraCartRestApiV2.OrderQuery(); // OrderQuery | Order query
-var opts = {
-  '_limit': 100, // Number | The maximum number of records to return on this one API call. (Maximum 200)
-  '_offset': 0, // Number | Pagination of the record set.  Offset is a zero based index.
-  '_sort': "_sort_example", // String | The sort order of the 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.
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.getOrdersByQuery(order_query, opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_query** | [**OrderQuery**](OrderQuery.md)| Order query |
- **_limit** | **Number**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
- **_offset** | **Number**| Pagination of the record set.  Offset is a zero based index. | [optional] [default to 0]
- **_sort** | **String**| The sort order of the orders.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
- **_expand** | **String**| The object expansion to perform on the result. | [optional]
-### Return type
-[**OrdersResponse**](OrdersResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="insertOrder"></a>
-# **insertOrder**
-> OrderResponse insertOrder(order, opts)
-Insert an order
-Inserts a new order on the UltraCart account.  This is probably NOT the method you want.  This is for channel orders.  For regular orders the customer is entering, use the CheckoutApi.  It has many, many more features, checks, and validations.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order = new UltraCartRestApiV2.Order(); // Order | Order to insert
-var opts = {
-  '_expand': "_expand_example" // String | The object expansion to perform on the result.  See documentation for examples
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.insertOrder(order, opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order** | [**Order**](Order.md)| Order to insert |
- **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional]
-### Return type
-[**OrderResponse**](OrderResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json; charset=UTF-8
- - **Accept**: application/json
-<a name="processPayment"></a>
-# **processPayment**
-> OrderProcessPaymentResponse processPayment(order_id, process_payment_request)
-Process payment
-Process payment on order
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to process payment on
-var process_payment_request = new UltraCartRestApiV2.OrderProcessPaymentRequest(); // OrderProcessPaymentRequest | Process payment parameters
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.processPayment(order_id, process_payment_request, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to process payment on |
- **process_payment_request** | [**OrderProcessPaymentRequest**](OrderProcessPaymentRequest.md)| Process payment parameters |
-### Return type
-[**OrderProcessPaymentResponse**](OrderProcessPaymentResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="refundOrder"></a>
-# **refundOrder**
-> OrderResponse refundOrder(order, order_id, opts)
-Refund an order
-Perform a refund operation on an order and then update the order if successful
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order = new UltraCartRestApiV2.Order(); // Order | Order to refund
-var order_id = "order_id_example"; // String | The order id to refund.
-var opts = {
-  'reject_after_refund': false, // Boolean | Reject order after refund
-  'skip_customer_notification': false, // Boolean | Skip customer email notification
-  'auto_order_cancel': false, // Boolean | Cancel associated auto orders
-  'manual_refund': false, // Boolean | Consider a manual refund done externally
-  'reverse_affiliate_transactions': true, // Boolean | Reverse affiliate transactions
-  '_expand': "_expand_example" // String | The object expansion to perform on the result.  See documentation for examples
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.refundOrder(order, order_id, opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order** | [**Order**](Order.md)| Order to refund |
- **order_id** | **String**| The order id to refund. |
- **reject_after_refund** | **Boolean**| Reject order after refund | [optional] [default to false]
- **skip_customer_notification** | **Boolean**| Skip customer email notification | [optional] [default to false]
- **auto_order_cancel** | **Boolean**| Cancel associated auto orders | [optional] [default to false]
- **manual_refund** | **Boolean**| Consider a manual refund done externally | [optional] [default to false]
- **reverse_affiliate_transactions** | **Boolean**| Reverse affiliate transactions | [optional] [default to true]
- **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional]
-### Return type
-[**OrderResponse**](OrderResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json; charset=UTF-8
- - **Accept**: application/json
-<a name="replacement"></a>
-# **replacement**
-> OrderReplacementResponse replacement(order_id, replacement)
-Replacement order
-Create a replacement order based upon a previous order
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to generate a replacement for.
-var replacement = new UltraCartRestApiV2.OrderReplacement(); // OrderReplacement | Replacement order details
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.replacement(order_id, replacement, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to generate a replacement for. |
- **replacement** | [**OrderReplacement**](OrderReplacement.md)| Replacement order details |
-### Return type
-[**OrderReplacementResponse**](OrderReplacementResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="resendReceipt"></a>
-# **resendReceipt**
-> BaseResponse resendReceipt(order_id)
-Resend receipt
-Resend the receipt for an order on the UltraCart account.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to resend the receipt for.
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.resendReceipt(order_id, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to resend the receipt for. |
-### Return type
-[**BaseResponse**](BaseResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="resendShipmentConfirmation"></a>
-# **resendShipmentConfirmation**
-> BaseResponse resendShipmentConfirmation(order_id)
-Resend shipment confirmation
-Resend shipment confirmation for an order on the UltraCart account.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order_id = "order_id_example"; // String | The order id to resend the shipment notification for.
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.resendShipmentConfirmation(order_id, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order_id** | **String**| The order id to resend the shipment notification for. |
-### Return type
-[**BaseResponse**](BaseResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="updateAccountsReceivableRetryConfig"></a>
-# **updateAccountsReceivableRetryConfig**
-> BaseResponse updateAccountsReceivableRetryConfig(retry_config)
-Update A/R Retry Configuration
-Update A/R Retry Configuration.  This is primarily an internal API call.  It is doubtful you would ever need to use it.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var retry_config = new UltraCartRestApiV2.AccountsReceivableRetryConfig(); // AccountsReceivableRetryConfig | AccountsReceivableRetryConfig object
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.updateAccountsReceivableRetryConfig(retry_config, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **retry_config** | [**AccountsReceivableRetryConfig**](AccountsReceivableRetryConfig.md)| AccountsReceivableRetryConfig object |
-### Return type
-[**BaseResponse**](BaseResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json
- - **Accept**: application/json
-<a name="updateOrder"></a>
-# **updateOrder**
-> OrderResponse updateOrder(order, order_id, opts)
-Update an order
-Update a new order on the UltraCart account.  This is probably NOT the method you want.  It is rare to update a completed order.  This will not trigger charges, emails, or any other automation.
-### Example
-```javascript
-var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
-// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
-var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
-UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
-var apiInstance = new UltraCartRestApiV2.OrderApi();
-var order = new UltraCartRestApiV2.Order(); // Order | Order to update
-var order_id = "order_id_example"; // String | The order id to update.
-var opts = {
-  '_expand': "_expand_example" // String | The object expansion to perform on the result.  See documentation for examples
-};
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully. Returned data: ' + data);
-  }
-};
-apiInstance.updateOrder(order, order_id, opts, callback);
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **order** | [**Order**](Order.md)| Order to update |
- **order_id** | **String**| The order id to update. |
- **_expand** | **String**| The object expansion to perform on the result.  See documentation for examples | [optional]
-### Return type
-[**OrderResponse**](OrderResponse.md)
-### Authorization
-[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
-### HTTP request headers
- - **Content-Type**: application/json; charset=UTF-8
- - **Accept**: application/json