docs/OrderApi.md in ultracart_api-3.10.143 vs docs/OrderApi.md in ultracart_api-3.10.144
- old
+ new
@@ -84,11 +84,11 @@
- **Accept**: application/json
# **cancel_order**
-> BaseResponse cancel_order(order_id)
+> BaseResponse cancel_order(order_id, opts)
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.
@@ -102,14 +102,18 @@
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
order_id = 'order_id_example' # String | The order id to cancel.
+opts = {
+ lock_self_ship_orders: true, # BOOLEAN | Flag to prevent a order shipping during a refund process
+ skip_refund_and_hold: true # BOOLEAN | Skip refund and move order to Held Orders department
+}
begin
#Cancel an order
- result = api_instance.cancel_order(order_id)
+ result = api_instance.cancel_order(order_id, opts)
p result
rescue UltracartClient::ApiError => e
puts "Exception when calling OrderApi->cancel_order: #{e}"
end
```
@@ -117,9 +121,11 @@
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order_id** | **String**| The order id to cancel. |
+ **lock_self_ship_orders** | **BOOLEAN**| Flag to prevent a order shipping during a refund process | [optional]
+ **skip_refund_and_hold** | **BOOLEAN**| Skip refund and move order to Held Orders department | [optional]
### Return type
[**BaseResponse**](BaseResponse.md)