ultracart_api 3.11.62 → 3.11.63
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.
- checksums.yaml +4 -4
- data/README.md +21 -4
- data/docs/AutoOrder.md +1 -0
- data/docs/AutoOrderAddonItemsUpdateRequest.md +8 -0
- data/docs/AutoOrderApi.md +180 -0
- data/docs/AutoOrderItem.md +2 -0
- data/docs/AutoOrderPropertiesUpdateRequest.md +8 -0
- data/docs/AutoOrderProperty.md +9 -0
- data/docs/ConversationApi.md +51 -0
- data/docs/EmailCommseqPostcard.md +1 -1
- data/docs/ItemApi.md +166 -0
- data/docs/ItemInventoryUpdate.md +10 -0
- data/docs/ItemInventoryUpdateRequest.md +8 -0
- data/docs/ItemShipping.md +1 -0
- data/docs/ItemShippingDistributionCenterResponse.md +12 -0
- data/docs/OrderAddItemsAndReleaseRequest.md +8 -0
- data/docs/OrderApi.md +113 -0
- data/lib/ultracart_api/api/auto_order_api.rb +204 -0
- data/lib/ultracart_api/api/conversation_api.rb +55 -0
- data/lib/ultracart_api/api/item_api.rb +187 -0
- data/lib/ultracart_api/api/order_api.rb +122 -0
- data/lib/ultracart_api/models/auto_order.rb +13 -1
- data/lib/ultracart_api/models/auto_order_addon_items_update_request.rb +187 -0
- data/lib/ultracart_api/models/auto_order_item.rb +25 -1
- data/lib/ultracart_api/models/auto_order_properties_update_request.rb +187 -0
- data/lib/ultracart_api/models/auto_order_property.rb +195 -0
- data/lib/ultracart_api/models/email_commseq_postcard.rb +1 -1
- data/lib/ultracart_api/models/item_inventory_update.rb +205 -0
- data/lib/ultracart_api/models/item_inventory_update_request.rb +187 -0
- data/lib/ultracart_api/models/item_shipping.rb +11 -1
- data/lib/ultracart_api/models/item_shipping_distribution_center_response.rb +221 -0
- data/lib/ultracart_api/models/order_add_items_and_release_request.rb +187 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +7 -0
- metadata +15 -1
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# UltracartClient::ItemInventoryUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**distribution_center_code** | **String** | Distribution center code | [optional]
|
|
7
|
+
**inventory_level** | **Float** | Inventory level | [optional]
|
|
8
|
+
**merchant_item_id** | **String** | Merchant Item ID | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# UltracartClient::ItemInventoryUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**inventory_updates** | [**Array<ItemInventoryUpdate>**](ItemInventoryUpdate.md) | Inventory updates array | [optional]
|
|
7
|
+
|
|
8
|
+
|
data/docs/ItemShipping.md
CHANGED
|
@@ -45,6 +45,7 @@ Name | Type | Description | Notes
|
|
|
45
45
|
**restrict_shipment_on_thursday** | **BOOLEAN** | Restrict shipment on Thursday | [optional]
|
|
46
46
|
**restrict_shipment_on_tuesday** | **BOOLEAN** | Restrict shipment on Tuesday | [optional]
|
|
47
47
|
**restrict_shipment_on_wednesday** | **BOOLEAN** | Restrict shipment on Wednesday | [optional]
|
|
48
|
+
**send_to_hold_before_fulfillment** | **BOOLEAN** | Send order to hold stage before fulfillment | [optional]
|
|
48
49
|
**ship_separately** | **BOOLEAN** | Ship this item in a separate box | [optional]
|
|
49
50
|
**ship_separately_additional_weight** | [**Weight**](Weight.md) | | [optional]
|
|
50
51
|
**ship_separately_height** | [**Distance**](Distance.md) | | [optional]
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# UltracartClient::ItemShippingDistributionCenterResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
7
|
+
**item_shipping_distribution_center** | [**ItemShippingDistributionCenter**](ItemShippingDistributionCenter.md) | | [optional]
|
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
|
11
|
+
|
|
12
|
+
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# UltracartClient::OrderAddItemsAndReleaseRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**items** | [**Array<OrderItem>**](OrderItem.md) | Items to add to the order. Must have at least the item id and quantity specified. These will be FREE items on the order since we are post payment on this method. | [optional]
|
|
7
|
+
|
|
8
|
+
|
data/docs/OrderApi.md
CHANGED
|
@@ -24,6 +24,8 @@ Method | HTTP request | Description
|
|
|
24
24
|
[**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
|
|
25
25
|
[**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
|
|
26
26
|
[**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
|
|
27
|
+
[**held_order_add_items_and_release**](OrderApi.md#held_order_add_items_and_release) | **PUT** /order/orders/{order_id}/hold/add_items_and_release | Add items and release a held order
|
|
28
|
+
[**held_order_release**](OrderApi.md#held_order_release) | **PUT** /order/orders/{order_id}/hold/release | Release a held order
|
|
27
29
|
[**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
|
|
28
30
|
[**is_refundable_order**](OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
|
|
29
31
|
[**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
|
@@ -1154,6 +1156,117 @@ Name | Type | Description | Notes
|
|
|
1154
1156
|
|
|
1155
1157
|
|
|
1156
1158
|
|
|
1159
|
+
# **held_order_add_items_and_release**
|
|
1160
|
+
> OrderResponse held_order_add_items_and_release(add_items_and_release_request, order_id, opts)
|
|
1161
|
+
|
|
1162
|
+
Add items and release a held order
|
|
1163
|
+
|
|
1164
|
+
This method adds items to an order in the hold stage and releases it
|
|
1165
|
+
|
|
1166
|
+
### Example
|
|
1167
|
+
```ruby
|
|
1168
|
+
# load the gem
|
|
1169
|
+
require 'ultracart_api'
|
|
1170
|
+
|
|
1171
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1172
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1173
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
add_items_and_release_request = UltracartClient::OrderAddItemsAndReleaseRequest.new # OrderAddItemsAndReleaseRequest | Add items and release request
|
|
1177
|
+
|
|
1178
|
+
order_id = 'order_id_example' # String | The order id to release.
|
|
1179
|
+
|
|
1180
|
+
opts = {
|
|
1181
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
1182
|
+
}
|
|
1183
|
+
|
|
1184
|
+
begin
|
|
1185
|
+
#Add items and release a held order
|
|
1186
|
+
result = api_instance.held_order_add_items_and_release(add_items_and_release_request, order_id, opts)
|
|
1187
|
+
p result
|
|
1188
|
+
rescue UltracartClient::ApiError => e
|
|
1189
|
+
puts "Exception when calling OrderApi->held_order_add_items_and_release: #{e}"
|
|
1190
|
+
end
|
|
1191
|
+
```
|
|
1192
|
+
|
|
1193
|
+
### Parameters
|
|
1194
|
+
|
|
1195
|
+
Name | Type | Description | Notes
|
|
1196
|
+
------------- | ------------- | ------------- | -------------
|
|
1197
|
+
**add_items_and_release_request** | [**OrderAddItemsAndReleaseRequest**](OrderAddItemsAndReleaseRequest.md)| Add items and release request |
|
|
1198
|
+
**order_id** | **String**| The order id to release. |
|
|
1199
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
1200
|
+
|
|
1201
|
+
### Return type
|
|
1202
|
+
|
|
1203
|
+
[**OrderResponse**](OrderResponse.md)
|
|
1204
|
+
|
|
1205
|
+
### Authorization
|
|
1206
|
+
|
|
1207
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1208
|
+
|
|
1209
|
+
### HTTP request headers
|
|
1210
|
+
|
|
1211
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1212
|
+
- **Accept**: application/json
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
# **held_order_release**
|
|
1217
|
+
> OrderResponse held_order_release(order_id, opts)
|
|
1218
|
+
|
|
1219
|
+
Release a held order
|
|
1220
|
+
|
|
1221
|
+
This method releases an order from the hold stage
|
|
1222
|
+
|
|
1223
|
+
### Example
|
|
1224
|
+
```ruby
|
|
1225
|
+
# load the gem
|
|
1226
|
+
require 'ultracart_api'
|
|
1227
|
+
|
|
1228
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1229
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1230
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
order_id = 'order_id_example' # String | The order id to release.
|
|
1234
|
+
|
|
1235
|
+
opts = {
|
|
1236
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
1237
|
+
}
|
|
1238
|
+
|
|
1239
|
+
begin
|
|
1240
|
+
#Release a held order
|
|
1241
|
+
result = api_instance.held_order_release(order_id, opts)
|
|
1242
|
+
p result
|
|
1243
|
+
rescue UltracartClient::ApiError => e
|
|
1244
|
+
puts "Exception when calling OrderApi->held_order_release: #{e}"
|
|
1245
|
+
end
|
|
1246
|
+
```
|
|
1247
|
+
|
|
1248
|
+
### Parameters
|
|
1249
|
+
|
|
1250
|
+
Name | Type | Description | Notes
|
|
1251
|
+
------------- | ------------- | ------------- | -------------
|
|
1252
|
+
**order_id** | **String**| The order id to release. |
|
|
1253
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
1254
|
+
|
|
1255
|
+
### Return type
|
|
1256
|
+
|
|
1257
|
+
[**OrderResponse**](OrderResponse.md)
|
|
1258
|
+
|
|
1259
|
+
### Authorization
|
|
1260
|
+
|
|
1261
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1262
|
+
|
|
1263
|
+
### HTTP request headers
|
|
1264
|
+
|
|
1265
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1266
|
+
- **Accept**: application/json
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1157
1270
|
# **insert_order**
|
|
1158
1271
|
> OrderResponse insert_order(order, opts)
|
|
1159
1272
|
|
|
@@ -702,6 +702,210 @@ module UltracartClient
|
|
|
702
702
|
end
|
|
703
703
|
return data, status_code, headers
|
|
704
704
|
end
|
|
705
|
+
# Update an auto order item add ons
|
|
706
|
+
# Update an auto order item add ons. Returns the auto order based upon expansion
|
|
707
|
+
# @param auto_order_add_ons_update_request Auto order add ons update request
|
|
708
|
+
# @param auto_order_oid The auto order oid to update.
|
|
709
|
+
# @param auto_order_item_oid The auto order item oid to update.
|
|
710
|
+
# @param [Hash] opts the optional parameters
|
|
711
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
712
|
+
# @return [AutoOrderResponse]
|
|
713
|
+
def update_auto_order_item_add_ons(auto_order_add_ons_update_request, auto_order_oid, auto_order_item_oid, opts = {})
|
|
714
|
+
data, _status_code, _headers = update_auto_order_item_add_ons_with_http_info(auto_order_add_ons_update_request, auto_order_oid, auto_order_item_oid, opts)
|
|
715
|
+
data
|
|
716
|
+
end
|
|
717
|
+
|
|
718
|
+
# Update an auto order item add ons
|
|
719
|
+
# Update an auto order item add ons. Returns the auto order based upon expansion
|
|
720
|
+
# @param auto_order_add_ons_update_request Auto order add ons update request
|
|
721
|
+
# @param auto_order_oid The auto order oid to update.
|
|
722
|
+
# @param auto_order_item_oid The auto order item oid to update.
|
|
723
|
+
# @param [Hash] opts the optional parameters
|
|
724
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
725
|
+
# @return [Array<(AutoOrderResponse, Fixnum, Hash)>] AutoOrderResponse data, response status code and response headers
|
|
726
|
+
def update_auto_order_item_add_ons_with_http_info(auto_order_add_ons_update_request, auto_order_oid, auto_order_item_oid, opts = {})
|
|
727
|
+
if @api_client.config.debugging
|
|
728
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.update_auto_order_item_add_ons ...'
|
|
729
|
+
end
|
|
730
|
+
# verify the required parameter 'auto_order_add_ons_update_request' is set
|
|
731
|
+
if @api_client.config.client_side_validation && auto_order_add_ons_update_request.nil?
|
|
732
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_add_ons_update_request' when calling AutoOrderApi.update_auto_order_item_add_ons"
|
|
733
|
+
end
|
|
734
|
+
# verify the required parameter 'auto_order_oid' is set
|
|
735
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
|
736
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.update_auto_order_item_add_ons"
|
|
737
|
+
end
|
|
738
|
+
# verify the required parameter 'auto_order_item_oid' is set
|
|
739
|
+
if @api_client.config.client_side_validation && auto_order_item_oid.nil?
|
|
740
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_item_oid' when calling AutoOrderApi.update_auto_order_item_add_ons"
|
|
741
|
+
end
|
|
742
|
+
# resource path
|
|
743
|
+
local_var_path = '/auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons'.sub('{' + 'auto_order_oid' + '}', auto_order_oid.to_s).sub('{' + 'auto_order_item_oid' + '}', auto_order_item_oid.to_s)
|
|
744
|
+
|
|
745
|
+
# query parameters
|
|
746
|
+
query_params = {}
|
|
747
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
748
|
+
|
|
749
|
+
# header parameters
|
|
750
|
+
header_params = {}
|
|
751
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
752
|
+
# HTTP header 'Accept' (if needed)
|
|
753
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
754
|
+
# HTTP header 'Content-Type'
|
|
755
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
756
|
+
|
|
757
|
+
# form parameters
|
|
758
|
+
form_params = {}
|
|
759
|
+
|
|
760
|
+
# http body (model)
|
|
761
|
+
post_body = @api_client.object_to_http_body(auto_order_add_ons_update_request)
|
|
762
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
763
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
764
|
+
:header_params => header_params,
|
|
765
|
+
:query_params => query_params,
|
|
766
|
+
:form_params => form_params,
|
|
767
|
+
:body => post_body,
|
|
768
|
+
:auth_names => auth_names,
|
|
769
|
+
:return_type => 'AutoOrderResponse')
|
|
770
|
+
if @api_client.config.debugging
|
|
771
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#update_auto_order_item_add_ons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
772
|
+
end
|
|
773
|
+
return data, status_code, headers
|
|
774
|
+
end
|
|
775
|
+
# Update an auto order item properties
|
|
776
|
+
# Update an auto order item properties. Returns the auto order based upon expansion
|
|
777
|
+
# @param auto_order_properties_update_request Auto order property update request
|
|
778
|
+
# @param auto_order_oid The auto order oid to update.
|
|
779
|
+
# @param auto_order_item_oid The auto order item oid to update.
|
|
780
|
+
# @param [Hash] opts the optional parameters
|
|
781
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
782
|
+
# @return [AutoOrderResponse]
|
|
783
|
+
def update_auto_order_item_properties(auto_order_properties_update_request, auto_order_oid, auto_order_item_oid, opts = {})
|
|
784
|
+
data, _status_code, _headers = update_auto_order_item_properties_with_http_info(auto_order_properties_update_request, auto_order_oid, auto_order_item_oid, opts)
|
|
785
|
+
data
|
|
786
|
+
end
|
|
787
|
+
|
|
788
|
+
# Update an auto order item properties
|
|
789
|
+
# Update an auto order item properties. Returns the auto order based upon expansion
|
|
790
|
+
# @param auto_order_properties_update_request Auto order property update request
|
|
791
|
+
# @param auto_order_oid The auto order oid to update.
|
|
792
|
+
# @param auto_order_item_oid The auto order item oid to update.
|
|
793
|
+
# @param [Hash] opts the optional parameters
|
|
794
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
795
|
+
# @return [Array<(AutoOrderResponse, Fixnum, Hash)>] AutoOrderResponse data, response status code and response headers
|
|
796
|
+
def update_auto_order_item_properties_with_http_info(auto_order_properties_update_request, auto_order_oid, auto_order_item_oid, opts = {})
|
|
797
|
+
if @api_client.config.debugging
|
|
798
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.update_auto_order_item_properties ...'
|
|
799
|
+
end
|
|
800
|
+
# verify the required parameter 'auto_order_properties_update_request' is set
|
|
801
|
+
if @api_client.config.client_side_validation && auto_order_properties_update_request.nil?
|
|
802
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_properties_update_request' when calling AutoOrderApi.update_auto_order_item_properties"
|
|
803
|
+
end
|
|
804
|
+
# verify the required parameter 'auto_order_oid' is set
|
|
805
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
|
806
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.update_auto_order_item_properties"
|
|
807
|
+
end
|
|
808
|
+
# verify the required parameter 'auto_order_item_oid' is set
|
|
809
|
+
if @api_client.config.client_side_validation && auto_order_item_oid.nil?
|
|
810
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_item_oid' when calling AutoOrderApi.update_auto_order_item_properties"
|
|
811
|
+
end
|
|
812
|
+
# resource path
|
|
813
|
+
local_var_path = '/auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties'.sub('{' + 'auto_order_oid' + '}', auto_order_oid.to_s).sub('{' + 'auto_order_item_oid' + '}', auto_order_item_oid.to_s)
|
|
814
|
+
|
|
815
|
+
# query parameters
|
|
816
|
+
query_params = {}
|
|
817
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
818
|
+
|
|
819
|
+
# header parameters
|
|
820
|
+
header_params = {}
|
|
821
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
822
|
+
# HTTP header 'Accept' (if needed)
|
|
823
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
824
|
+
# HTTP header 'Content-Type'
|
|
825
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
826
|
+
|
|
827
|
+
# form parameters
|
|
828
|
+
form_params = {}
|
|
829
|
+
|
|
830
|
+
# http body (model)
|
|
831
|
+
post_body = @api_client.object_to_http_body(auto_order_properties_update_request)
|
|
832
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
833
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
834
|
+
:header_params => header_params,
|
|
835
|
+
:query_params => query_params,
|
|
836
|
+
:form_params => form_params,
|
|
837
|
+
:body => post_body,
|
|
838
|
+
:auth_names => auth_names,
|
|
839
|
+
:return_type => 'AutoOrderResponse')
|
|
840
|
+
if @api_client.config.debugging
|
|
841
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#update_auto_order_item_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
842
|
+
end
|
|
843
|
+
return data, status_code, headers
|
|
844
|
+
end
|
|
845
|
+
# Update an auto order properties
|
|
846
|
+
# Update an auto order properties. Returns the auto order based upon expansion
|
|
847
|
+
# @param auto_order_properties_update_request Auto order property update request
|
|
848
|
+
# @param auto_order_oid The auto order oid to update.
|
|
849
|
+
# @param [Hash] opts the optional parameters
|
|
850
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
851
|
+
# @return [AutoOrderResponse]
|
|
852
|
+
def update_auto_order_properties(auto_order_properties_update_request, auto_order_oid, opts = {})
|
|
853
|
+
data, _status_code, _headers = update_auto_order_properties_with_http_info(auto_order_properties_update_request, auto_order_oid, opts)
|
|
854
|
+
data
|
|
855
|
+
end
|
|
856
|
+
|
|
857
|
+
# Update an auto order properties
|
|
858
|
+
# Update an auto order properties. Returns the auto order based upon expansion
|
|
859
|
+
# @param auto_order_properties_update_request Auto order property update request
|
|
860
|
+
# @param auto_order_oid The auto order oid to update.
|
|
861
|
+
# @param [Hash] opts the optional parameters
|
|
862
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
863
|
+
# @return [Array<(AutoOrderResponse, Fixnum, Hash)>] AutoOrderResponse data, response status code and response headers
|
|
864
|
+
def update_auto_order_properties_with_http_info(auto_order_properties_update_request, auto_order_oid, opts = {})
|
|
865
|
+
if @api_client.config.debugging
|
|
866
|
+
@api_client.config.logger.debug 'Calling API: AutoOrderApi.update_auto_order_properties ...'
|
|
867
|
+
end
|
|
868
|
+
# verify the required parameter 'auto_order_properties_update_request' is set
|
|
869
|
+
if @api_client.config.client_side_validation && auto_order_properties_update_request.nil?
|
|
870
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_properties_update_request' when calling AutoOrderApi.update_auto_order_properties"
|
|
871
|
+
end
|
|
872
|
+
# verify the required parameter 'auto_order_oid' is set
|
|
873
|
+
if @api_client.config.client_side_validation && auto_order_oid.nil?
|
|
874
|
+
fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.update_auto_order_properties"
|
|
875
|
+
end
|
|
876
|
+
# resource path
|
|
877
|
+
local_var_path = '/auto_order/auto_orders/{auto_order_oid}/properties'.sub('{' + 'auto_order_oid' + '}', auto_order_oid.to_s)
|
|
878
|
+
|
|
879
|
+
# query parameters
|
|
880
|
+
query_params = {}
|
|
881
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
882
|
+
|
|
883
|
+
# header parameters
|
|
884
|
+
header_params = {}
|
|
885
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
886
|
+
# HTTP header 'Accept' (if needed)
|
|
887
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
888
|
+
# HTTP header 'Content-Type'
|
|
889
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
890
|
+
|
|
891
|
+
# form parameters
|
|
892
|
+
form_params = {}
|
|
893
|
+
|
|
894
|
+
# http body (model)
|
|
895
|
+
post_body = @api_client.object_to_http_body(auto_order_properties_update_request)
|
|
896
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
897
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
898
|
+
:header_params => header_params,
|
|
899
|
+
:query_params => query_params,
|
|
900
|
+
:form_params => form_params,
|
|
901
|
+
:body => post_body,
|
|
902
|
+
:auth_names => auth_names,
|
|
903
|
+
:return_type => 'AutoOrderResponse')
|
|
904
|
+
if @api_client.config.debugging
|
|
905
|
+
@api_client.config.logger.debug "API called: AutoOrderApi#update_auto_order_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
906
|
+
end
|
|
907
|
+
return data, status_code, headers
|
|
908
|
+
end
|
|
705
909
|
# Update multiple auto orders
|
|
706
910
|
# Update multiple auto orders on the UltraCart account.
|
|
707
911
|
# @param auto_orders_request Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
|
|
@@ -1769,6 +1769,61 @@ module UltracartClient
|
|
|
1769
1769
|
end
|
|
1770
1770
|
return data, status_code, headers
|
|
1771
1771
|
end
|
|
1772
|
+
# Retrieve an item with sparse variations populated
|
|
1773
|
+
# Retrieve an item with sparse variations populated
|
|
1774
|
+
# @param merchant_item_id
|
|
1775
|
+
# @param [Hash] opts the optional parameters
|
|
1776
|
+
# @return [ItemResponse]
|
|
1777
|
+
def get_conversation_item_variations(merchant_item_id, opts = {})
|
|
1778
|
+
data, _status_code, _headers = get_conversation_item_variations_with_http_info(merchant_item_id, opts)
|
|
1779
|
+
data
|
|
1780
|
+
end
|
|
1781
|
+
|
|
1782
|
+
# Retrieve an item with sparse variations populated
|
|
1783
|
+
# Retrieve an item with sparse variations populated
|
|
1784
|
+
# @param merchant_item_id
|
|
1785
|
+
# @param [Hash] opts the optional parameters
|
|
1786
|
+
# @return [Array<(ItemResponse, Fixnum, Hash)>] ItemResponse data, response status code and response headers
|
|
1787
|
+
def get_conversation_item_variations_with_http_info(merchant_item_id, opts = {})
|
|
1788
|
+
if @api_client.config.debugging
|
|
1789
|
+
@api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_item_variations ...'
|
|
1790
|
+
end
|
|
1791
|
+
# verify the required parameter 'merchant_item_id' is set
|
|
1792
|
+
if @api_client.config.client_side_validation && merchant_item_id.nil?
|
|
1793
|
+
fail ArgumentError, "Missing the required parameter 'merchant_item_id' when calling ConversationApi.get_conversation_item_variations"
|
|
1794
|
+
end
|
|
1795
|
+
# resource path
|
|
1796
|
+
local_var_path = '/conversation/items/{merchant_item_id}/variations'.sub('{' + 'merchant_item_id' + '}', merchant_item_id.to_s)
|
|
1797
|
+
|
|
1798
|
+
# query parameters
|
|
1799
|
+
query_params = {}
|
|
1800
|
+
|
|
1801
|
+
# header parameters
|
|
1802
|
+
header_params = {}
|
|
1803
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1804
|
+
# HTTP header 'Accept' (if needed)
|
|
1805
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1806
|
+
# HTTP header 'Content-Type'
|
|
1807
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
1808
|
+
|
|
1809
|
+
# form parameters
|
|
1810
|
+
form_params = {}
|
|
1811
|
+
|
|
1812
|
+
# http body (model)
|
|
1813
|
+
post_body = nil
|
|
1814
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1815
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
1816
|
+
:header_params => header_params,
|
|
1817
|
+
:query_params => query_params,
|
|
1818
|
+
:form_params => form_params,
|
|
1819
|
+
:body => post_body,
|
|
1820
|
+
:auth_names => auth_names,
|
|
1821
|
+
:return_type => 'ItemResponse')
|
|
1822
|
+
if @api_client.config.debugging
|
|
1823
|
+
@api_client.config.logger.debug "API called: ConversationApi#get_conversation_item_variations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1824
|
+
end
|
|
1825
|
+
return data, status_code, headers
|
|
1826
|
+
end
|
|
1772
1827
|
# Get a pre-signed conversation knowledge base document upload URL
|
|
1773
1828
|
# Get a pre-signed conversation knowledge base document upload URL
|
|
1774
1829
|
# @param user_id
|
|
@@ -548,6 +548,73 @@ module UltracartClient
|
|
|
548
548
|
end
|
|
549
549
|
return data, status_code, headers
|
|
550
550
|
end
|
|
551
|
+
# Retrieve an item shipping distribution center
|
|
552
|
+
# Retrieve an item shipping distribution center.
|
|
553
|
+
# @param merchant_item_oid The item oid to retrieve.
|
|
554
|
+
# @param distribution_center_code
|
|
555
|
+
# @param [Hash] opts the optional parameters
|
|
556
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
557
|
+
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
558
|
+
# @return [ItemShippingDistributionCenterResponse]
|
|
559
|
+
def get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, opts = {})
|
|
560
|
+
data, _status_code, _headers = get_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, opts)
|
|
561
|
+
data
|
|
562
|
+
end
|
|
563
|
+
|
|
564
|
+
# Retrieve an item shipping distribution center
|
|
565
|
+
# Retrieve an item shipping distribution center.
|
|
566
|
+
# @param merchant_item_oid The item oid to retrieve.
|
|
567
|
+
# @param distribution_center_code
|
|
568
|
+
# @param [Hash] opts the optional parameters
|
|
569
|
+
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
|
570
|
+
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
571
|
+
# @return [Array<(ItemShippingDistributionCenterResponse, Fixnum, Hash)>] ItemShippingDistributionCenterResponse data, response status code and response headers
|
|
572
|
+
def get_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, opts = {})
|
|
573
|
+
if @api_client.config.debugging
|
|
574
|
+
@api_client.config.logger.debug 'Calling API: ItemApi.get_item_shipping_distribution_center_by_code ...'
|
|
575
|
+
end
|
|
576
|
+
# verify the required parameter 'merchant_item_oid' is set
|
|
577
|
+
if @api_client.config.client_side_validation && merchant_item_oid.nil?
|
|
578
|
+
fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.get_item_shipping_distribution_center_by_code"
|
|
579
|
+
end
|
|
580
|
+
# verify the required parameter 'distribution_center_code' is set
|
|
581
|
+
if @api_client.config.client_side_validation && distribution_center_code.nil?
|
|
582
|
+
fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling ItemApi.get_item_shipping_distribution_center_by_code"
|
|
583
|
+
end
|
|
584
|
+
# resource path
|
|
585
|
+
local_var_path = '/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s).sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s)
|
|
586
|
+
|
|
587
|
+
# query parameters
|
|
588
|
+
query_params = {}
|
|
589
|
+
query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
|
|
590
|
+
query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
|
|
591
|
+
|
|
592
|
+
# header parameters
|
|
593
|
+
header_params = {}
|
|
594
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
595
|
+
# HTTP header 'Accept' (if needed)
|
|
596
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
597
|
+
# HTTP header 'Content-Type'
|
|
598
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
|
599
|
+
|
|
600
|
+
# form parameters
|
|
601
|
+
form_params = {}
|
|
602
|
+
|
|
603
|
+
# http body (model)
|
|
604
|
+
post_body = nil
|
|
605
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
606
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
|
607
|
+
:header_params => header_params,
|
|
608
|
+
:query_params => query_params,
|
|
609
|
+
:form_params => form_params,
|
|
610
|
+
:body => post_body,
|
|
611
|
+
:auth_names => auth_names,
|
|
612
|
+
:return_type => 'ItemShippingDistributionCenterResponse')
|
|
613
|
+
if @api_client.config.debugging
|
|
614
|
+
@api_client.config.logger.debug "API called: ItemApi#get_item_shipping_distribution_center_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
615
|
+
end
|
|
616
|
+
return data, status_code, headers
|
|
617
|
+
end
|
|
551
618
|
# Retrieve items
|
|
552
619
|
# Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
|
553
620
|
# @param [Hash] opts the optional parameters
|
|
@@ -1221,6 +1288,126 @@ module UltracartClient
|
|
|
1221
1288
|
end
|
|
1222
1289
|
return data, status_code, headers
|
|
1223
1290
|
end
|
|
1291
|
+
# Update item inventories for a distribution center
|
|
1292
|
+
# Update item inventories for a distribution center
|
|
1293
|
+
# @param item_inventory_update_request Item inventory updates
|
|
1294
|
+
# @param [Hash] opts the optional parameters
|
|
1295
|
+
# @return [nil]
|
|
1296
|
+
def update_item_inventories(item_inventory_update_request, opts = {})
|
|
1297
|
+
update_item_inventories_with_http_info(item_inventory_update_request, opts)
|
|
1298
|
+
nil
|
|
1299
|
+
end
|
|
1300
|
+
|
|
1301
|
+
# Update item inventories for a distribution center
|
|
1302
|
+
# Update item inventories for a distribution center
|
|
1303
|
+
# @param item_inventory_update_request Item inventory updates
|
|
1304
|
+
# @param [Hash] opts the optional parameters
|
|
1305
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1306
|
+
def update_item_inventories_with_http_info(item_inventory_update_request, opts = {})
|
|
1307
|
+
if @api_client.config.debugging
|
|
1308
|
+
@api_client.config.logger.debug 'Calling API: ItemApi.update_item_inventories ...'
|
|
1309
|
+
end
|
|
1310
|
+
# verify the required parameter 'item_inventory_update_request' is set
|
|
1311
|
+
if @api_client.config.client_side_validation && item_inventory_update_request.nil?
|
|
1312
|
+
fail ArgumentError, "Missing the required parameter 'item_inventory_update_request' when calling ItemApi.update_item_inventories"
|
|
1313
|
+
end
|
|
1314
|
+
# resource path
|
|
1315
|
+
local_var_path = '/item/items/update_item_inventories'
|
|
1316
|
+
|
|
1317
|
+
# query parameters
|
|
1318
|
+
query_params = {}
|
|
1319
|
+
|
|
1320
|
+
# header parameters
|
|
1321
|
+
header_params = {}
|
|
1322
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1323
|
+
# HTTP header 'Accept' (if needed)
|
|
1324
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1325
|
+
# HTTP header 'Content-Type'
|
|
1326
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
1327
|
+
|
|
1328
|
+
# form parameters
|
|
1329
|
+
form_params = {}
|
|
1330
|
+
|
|
1331
|
+
# http body (model)
|
|
1332
|
+
post_body = @api_client.object_to_http_body(item_inventory_update_request)
|
|
1333
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1334
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1335
|
+
:header_params => header_params,
|
|
1336
|
+
:query_params => query_params,
|
|
1337
|
+
:form_params => form_params,
|
|
1338
|
+
:body => post_body,
|
|
1339
|
+
:auth_names => auth_names)
|
|
1340
|
+
if @api_client.config.debugging
|
|
1341
|
+
@api_client.config.logger.debug "API called: ItemApi#update_item_inventories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1342
|
+
end
|
|
1343
|
+
return data, status_code, headers
|
|
1344
|
+
end
|
|
1345
|
+
# Update an item shipping distribution center
|
|
1346
|
+
# Update an item shipping distribution center
|
|
1347
|
+
# @param item_shipping_distribution_center Item shipping distribution center
|
|
1348
|
+
# @param merchant_item_oid The item oid to update.
|
|
1349
|
+
# @param distribution_center_code
|
|
1350
|
+
# @param [Hash] opts the optional parameters
|
|
1351
|
+
# @return [nil]
|
|
1352
|
+
def update_item_shipping_distribution_center_by_code(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, opts = {})
|
|
1353
|
+
update_item_shipping_distribution_center_by_code_with_http_info(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, opts)
|
|
1354
|
+
nil
|
|
1355
|
+
end
|
|
1356
|
+
|
|
1357
|
+
# Update an item shipping distribution center
|
|
1358
|
+
# Update an item shipping distribution center
|
|
1359
|
+
# @param item_shipping_distribution_center Item shipping distribution center
|
|
1360
|
+
# @param merchant_item_oid The item oid to update.
|
|
1361
|
+
# @param distribution_center_code
|
|
1362
|
+
# @param [Hash] opts the optional parameters
|
|
1363
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
|
1364
|
+
def update_item_shipping_distribution_center_by_code_with_http_info(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, opts = {})
|
|
1365
|
+
if @api_client.config.debugging
|
|
1366
|
+
@api_client.config.logger.debug 'Calling API: ItemApi.update_item_shipping_distribution_center_by_code ...'
|
|
1367
|
+
end
|
|
1368
|
+
# verify the required parameter 'item_shipping_distribution_center' is set
|
|
1369
|
+
if @api_client.config.client_side_validation && item_shipping_distribution_center.nil?
|
|
1370
|
+
fail ArgumentError, "Missing the required parameter 'item_shipping_distribution_center' when calling ItemApi.update_item_shipping_distribution_center_by_code"
|
|
1371
|
+
end
|
|
1372
|
+
# verify the required parameter 'merchant_item_oid' is set
|
|
1373
|
+
if @api_client.config.client_side_validation && merchant_item_oid.nil?
|
|
1374
|
+
fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.update_item_shipping_distribution_center_by_code"
|
|
1375
|
+
end
|
|
1376
|
+
# verify the required parameter 'distribution_center_code' is set
|
|
1377
|
+
if @api_client.config.client_side_validation && distribution_center_code.nil?
|
|
1378
|
+
fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling ItemApi.update_item_shipping_distribution_center_by_code"
|
|
1379
|
+
end
|
|
1380
|
+
# resource path
|
|
1381
|
+
local_var_path = '/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s).sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s)
|
|
1382
|
+
|
|
1383
|
+
# query parameters
|
|
1384
|
+
query_params = {}
|
|
1385
|
+
|
|
1386
|
+
# header parameters
|
|
1387
|
+
header_params = {}
|
|
1388
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
|
1389
|
+
# HTTP header 'Accept' (if needed)
|
|
1390
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
1391
|
+
# HTTP header 'Content-Type'
|
|
1392
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
|
|
1393
|
+
|
|
1394
|
+
# form parameters
|
|
1395
|
+
form_params = {}
|
|
1396
|
+
|
|
1397
|
+
# http body (model)
|
|
1398
|
+
post_body = @api_client.object_to_http_body(item_shipping_distribution_center)
|
|
1399
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
|
1400
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
|
1401
|
+
:header_params => header_params,
|
|
1402
|
+
:query_params => query_params,
|
|
1403
|
+
:form_params => form_params,
|
|
1404
|
+
:body => post_body,
|
|
1405
|
+
:auth_names => auth_names)
|
|
1406
|
+
if @api_client.config.debugging
|
|
1407
|
+
@api_client.config.logger.debug "API called: ItemApi#update_item_shipping_distribution_center_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1408
|
+
end
|
|
1409
|
+
return data, status_code, headers
|
|
1410
|
+
end
|
|
1224
1411
|
# Update multiple items
|
|
1225
1412
|
# Update multiple item on the UltraCart account.
|
|
1226
1413
|
# @param items_request Items to update (synchronous maximum 20 / asynchronous maximum 100)
|