ultracart_api 3.11.61 → 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 +22 -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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: caa7c95568fa34d66c204071de692df045b279faacf4f89525f30542e5c7aa44
|
|
4
|
+
data.tar.gz: 5a120fe87a384d85f155d088224281874cfa3efd71fea03f4ed808d84fb5b8b5
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f9d557e192255167d36552396627239cbe7760e95b365d5b4eb58f7408e14c05727199056297b6e572dddfb888bc73ac5e96a129e7b4a78c98c610708a3ed880
|
|
7
|
+
data.tar.gz: 88239cb73537325dcfc176f305ea07acc3fe5d0a809817255b0b5b9574db7493b829cb7cd813d9bf4f4bc8d72624522d06f818a0a77b90d84e7463322828b363
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 3.11.
|
|
10
|
+
- Package version: 3.11.63
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./ultracart_api-3.11.
|
|
27
|
+
gem install ./ultracart_api-3.11.63.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.11.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.11.63.gem` to install the development dependencies)
|
|
30
30
|
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
32
32
|
|
|
33
33
|
Finally add this to the Gemfile:
|
|
34
34
|
|
|
35
|
-
gem 'ultracart_api', '~> 3.11.
|
|
35
|
+
gem 'ultracart_api', '~> 3.11.63'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -98,6 +98,9 @@ Class | Method | HTTP request | Description
|
|
|
98
98
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
|
|
99
99
|
*UltracartClient::AutoOrderApi* | [**pause_auto_order**](docs/AutoOrderApi.md#pause_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid}/pause | Pause auto order
|
|
100
100
|
*UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
|
|
101
|
+
*UltracartClient::AutoOrderApi* | [**update_auto_order_item_add_ons**](docs/AutoOrderApi.md#update_auto_order_item_add_ons) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons | Update an auto order item add ons
|
|
102
|
+
*UltracartClient::AutoOrderApi* | [**update_auto_order_item_properties**](docs/AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties
|
|
103
|
+
*UltracartClient::AutoOrderApi* | [**update_auto_order_properties**](docs/AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties
|
|
101
104
|
*UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
|
|
102
105
|
*UltracartClient::ChannelPartnerApi* | [**cancel_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
|
|
103
106
|
*UltracartClient::ChannelPartnerApi* | [**cancel_order_by_ultra_cart_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
|
|
@@ -165,6 +168,7 @@ Class | Method | HTTP request | Description
|
|
|
165
168
|
*UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
|
166
169
|
*UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
|
167
170
|
*UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
|
171
|
+
*UltracartClient::ConversationApi* | [**get_conversation_item_variations**](docs/ConversationApi.md#get_conversation_item_variations) | **GET** /conversation/items/{merchant_item_id}/variations | Retrieve an item with sparse variations populated
|
|
168
172
|
*UltracartClient::ConversationApi* | [**get_conversation_knowledge_base_document_upload_url**](docs/ConversationApi.md#get_conversation_knowledge_base_document_upload_url) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension} | Get a pre-signed conversation knowledge base document upload URL
|
|
169
173
|
*UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
170
174
|
*UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
|
|
@@ -357,6 +361,7 @@ Class | Method | HTTP request | Description
|
|
|
357
361
|
*UltracartClient::ItemApi* | [**get_inventory_snapshot**](docs/ItemApi.md#get_inventory_snapshot) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
358
362
|
*UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
|
|
359
363
|
*UltracartClient::ItemApi* | [**get_item_by_merchant_item_id**](docs/ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
|
|
364
|
+
*UltracartClient::ItemApi* | [**get_item_shipping_distribution_center_by_code**](docs/ItemApi.md#get_item_shipping_distribution_center_by_code) | **GET** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Retrieve an item shipping distribution center
|
|
360
365
|
*UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
|
361
366
|
*UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
|
|
362
367
|
*UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
|
|
@@ -368,6 +373,8 @@ Class | Method | HTTP request | Description
|
|
|
368
373
|
*UltracartClient::ItemApi* | [**insert_update_item_content_attribute**](docs/ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
|
|
369
374
|
*UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
|
|
370
375
|
*UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
|
376
|
+
*UltracartClient::ItemApi* | [**update_item_inventories**](docs/ItemApi.md#update_item_inventories) | **PUT** /item/items/update_item_inventories | Update item inventories for a distribution center
|
|
377
|
+
*UltracartClient::ItemApi* | [**update_item_shipping_distribution_center_by_code**](docs/ItemApi.md#update_item_shipping_distribution_center_by_code) | **PUT** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Update an item shipping distribution center
|
|
371
378
|
*UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
|
372
379
|
*UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
|
|
373
380
|
*UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
|
|
@@ -393,6 +400,8 @@ Class | Method | HTTP request | Description
|
|
|
393
400
|
*UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
|
|
394
401
|
*UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
|
|
395
402
|
*UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
|
|
403
|
+
*UltracartClient::OrderApi* | [**held_order_add_items_and_release**](docs/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
|
|
404
|
+
*UltracartClient::OrderApi* | [**held_order_release**](docs/OrderApi.md#held_order_release) | **PUT** /order/orders/{order_id}/hold/release | Release a held order
|
|
396
405
|
*UltracartClient::OrderApi* | [**insert_order**](docs/OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
|
|
397
406
|
*UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
|
|
398
407
|
*UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
|
@@ -676,6 +685,7 @@ Class | Method | HTTP request | Description
|
|
|
676
685
|
- [UltracartClient::AutoOrder](docs/AutoOrder.md)
|
|
677
686
|
- [UltracartClient::AutoOrderAddonItem](docs/AutoOrderAddonItem.md)
|
|
678
687
|
- [UltracartClient::AutoOrderAddonItemOption](docs/AutoOrderAddonItemOption.md)
|
|
688
|
+
- [UltracartClient::AutoOrderAddonItemsUpdateRequest](docs/AutoOrderAddonItemsUpdateRequest.md)
|
|
679
689
|
- [UltracartClient::AutoOrderConsolidate](docs/AutoOrderConsolidate.md)
|
|
680
690
|
- [UltracartClient::AutoOrderItem](docs/AutoOrderItem.md)
|
|
681
691
|
- [UltracartClient::AutoOrderItemFutureSchedule](docs/AutoOrderItemFutureSchedule.md)
|
|
@@ -683,6 +693,8 @@ Class | Method | HTTP request | Description
|
|
|
683
693
|
- [UltracartClient::AutoOrderItemSimpleSchedule](docs/AutoOrderItemSimpleSchedule.md)
|
|
684
694
|
- [UltracartClient::AutoOrderLog](docs/AutoOrderLog.md)
|
|
685
695
|
- [UltracartClient::AutoOrderManagement](docs/AutoOrderManagement.md)
|
|
696
|
+
- [UltracartClient::AutoOrderPropertiesUpdateRequest](docs/AutoOrderPropertiesUpdateRequest.md)
|
|
697
|
+
- [UltracartClient::AutoOrderProperty](docs/AutoOrderProperty.md)
|
|
686
698
|
- [UltracartClient::AutoOrderQuery](docs/AutoOrderQuery.md)
|
|
687
699
|
- [UltracartClient::AutoOrderQueryBatch](docs/AutoOrderQueryBatch.md)
|
|
688
700
|
- [UltracartClient::AutoOrderResponse](docs/AutoOrderResponse.md)
|
|
@@ -1274,6 +1286,8 @@ Class | Method | HTTP request | Description
|
|
|
1274
1286
|
- [UltracartClient::ItemInventorySnapshot](docs/ItemInventorySnapshot.md)
|
|
1275
1287
|
- [UltracartClient::ItemInventorySnapshotDistributionCenter](docs/ItemInventorySnapshotDistributionCenter.md)
|
|
1276
1288
|
- [UltracartClient::ItemInventorySnapshotResponse](docs/ItemInventorySnapshotResponse.md)
|
|
1289
|
+
- [UltracartClient::ItemInventoryUpdate](docs/ItemInventoryUpdate.md)
|
|
1290
|
+
- [UltracartClient::ItemInventoryUpdateRequest](docs/ItemInventoryUpdateRequest.md)
|
|
1277
1291
|
- [UltracartClient::ItemKitComponent](docs/ItemKitComponent.md)
|
|
1278
1292
|
- [UltracartClient::ItemKitDefinition](docs/ItemKitDefinition.md)
|
|
1279
1293
|
- [UltracartClient::ItemOption](docs/ItemOption.md)
|
|
@@ -1305,6 +1319,7 @@ Class | Method | HTTP request | Description
|
|
|
1305
1319
|
- [UltracartClient::ItemShippingDestinationMarkup](docs/ItemShippingDestinationMarkup.md)
|
|
1306
1320
|
- [UltracartClient::ItemShippingDestinationRestriction](docs/ItemShippingDestinationRestriction.md)
|
|
1307
1321
|
- [UltracartClient::ItemShippingDistributionCenter](docs/ItemShippingDistributionCenter.md)
|
|
1322
|
+
- [UltracartClient::ItemShippingDistributionCenterResponse](docs/ItemShippingDistributionCenterResponse.md)
|
|
1308
1323
|
- [UltracartClient::ItemShippingMethod](docs/ItemShippingMethod.md)
|
|
1309
1324
|
- [UltracartClient::ItemShippingPackageRequirement](docs/ItemShippingPackageRequirement.md)
|
|
1310
1325
|
- [UltracartClient::ItemTag](docs/ItemTag.md)
|
|
@@ -1342,6 +1357,7 @@ Class | Method | HTTP request | Description
|
|
|
1342
1357
|
- [UltracartClient::OauthRevokeSuccessResponse](docs/OauthRevokeSuccessResponse.md)
|
|
1343
1358
|
- [UltracartClient::OauthTokenResponse](docs/OauthTokenResponse.md)
|
|
1344
1359
|
- [UltracartClient::Order](docs/Order.md)
|
|
1360
|
+
- [UltracartClient::OrderAddItemsAndReleaseRequest](docs/OrderAddItemsAndReleaseRequest.md)
|
|
1345
1361
|
- [UltracartClient::OrderAffiliate](docs/OrderAffiliate.md)
|
|
1346
1362
|
- [UltracartClient::OrderAffiliateLedger](docs/OrderAffiliateLedger.md)
|
|
1347
1363
|
- [UltracartClient::OrderAssignToAffiliateRequest](docs/OrderAssignToAffiliateRequest.md)
|
|
@@ -1665,6 +1681,8 @@ Not every change is committed to every SDK.
|
|
|
1665
1681
|
|
|
1666
1682
|
| Version | Date | Comments |
|
|
1667
1683
|
| --: | :-: | --- |
|
|
1684
|
+
| 3.11.63 | 02/12/2026 | build automation issue |
|
|
1685
|
+
| 3.11.62 | 02/12/2026 | build automation run, no code changes |
|
|
1668
1686
|
| 3.11.61 | 02/12/2026 | order - methods to release held orders |
|
|
1669
1687
|
| 3.11.60 | 02/12/2026 | auto order - properties, item add-ons, and item properties |
|
|
1670
1688
|
| 3.11.59 | 02/10/2026 | conversations - new method to look up an item with sparse variations |
|
data/docs/AutoOrder.md
CHANGED
|
@@ -27,6 +27,7 @@ Name | Type | Description | Notes
|
|
|
27
27
|
**original_order** | [**Order**](Order.md) | | [optional]
|
|
28
28
|
**original_order_id** | **String** | The original order id that this auto order is associated with. | [optional]
|
|
29
29
|
**override_affiliate_id** | **Integer** | Override the affiliate id given credit for rebills of this auto order | [optional]
|
|
30
|
+
**properties** | [**Array<AutoOrderProperty>**](AutoOrderProperty.md) | Array of property objects | [optional]
|
|
30
31
|
**rebill_orders** | [**Array<Order>**](Order.md) | Rebill orders that have taken place on this auto order | [optional]
|
|
31
32
|
**rotating_transaction_gateway_code** | **String** | The RTG code associated with this order for future rebills | [optional]
|
|
32
33
|
**status** | **String** | The status of the auto order | [optional]
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderAddonItemsUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**add_on_items** | [**Array<AutoOrderAddonItem>**](AutoOrderAddonItem.md) | Add on items to update | [optional]
|
|
7
|
+
|
|
8
|
+
|
data/docs/AutoOrderApi.md
CHANGED
|
@@ -14,6 +14,9 @@ Method | HTTP request | Description
|
|
|
14
14
|
[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
|
|
15
15
|
[**pause_auto_order**](AutoOrderApi.md#pause_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid}/pause | Pause auto order
|
|
16
16
|
[**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
|
|
17
|
+
[**update_auto_order_item_add_ons**](AutoOrderApi.md#update_auto_order_item_add_ons) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons | Update an auto order item add ons
|
|
18
|
+
[**update_auto_order_item_properties**](AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties
|
|
19
|
+
[**update_auto_order_properties**](AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties
|
|
17
20
|
[**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
|
|
18
21
|
|
|
19
22
|
|
|
@@ -615,6 +618,183 @@ Name | Type | Description | Notes
|
|
|
615
618
|
|
|
616
619
|
|
|
617
620
|
|
|
621
|
+
# **update_auto_order_item_add_ons**
|
|
622
|
+
> AutoOrderResponse update_auto_order_item_add_ons(auto_order_add_ons_update_request, auto_order_oid, auto_order_item_oid, opts)
|
|
623
|
+
|
|
624
|
+
Update an auto order item add ons
|
|
625
|
+
|
|
626
|
+
Update an auto order item add ons. Returns the auto order based upon expansion
|
|
627
|
+
|
|
628
|
+
### Example
|
|
629
|
+
```ruby
|
|
630
|
+
# load the gem
|
|
631
|
+
require 'ultracart_api'
|
|
632
|
+
|
|
633
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
634
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
635
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
auto_order_add_ons_update_request = UltracartClient::AutoOrderAddonItemsUpdateRequest.new # AutoOrderAddonItemsUpdateRequest | Auto order add ons update request
|
|
639
|
+
|
|
640
|
+
auto_order_oid = 56 # Integer | The auto order oid to update.
|
|
641
|
+
|
|
642
|
+
auto_order_item_oid = 56 # Integer | The auto order item oid to update.
|
|
643
|
+
|
|
644
|
+
opts = {
|
|
645
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
646
|
+
}
|
|
647
|
+
|
|
648
|
+
begin
|
|
649
|
+
#Update an auto order item add ons
|
|
650
|
+
result = api_instance.update_auto_order_item_add_ons(auto_order_add_ons_update_request, auto_order_oid, auto_order_item_oid, opts)
|
|
651
|
+
p result
|
|
652
|
+
rescue UltracartClient::ApiError => e
|
|
653
|
+
puts "Exception when calling AutoOrderApi->update_auto_order_item_add_ons: #{e}"
|
|
654
|
+
end
|
|
655
|
+
```
|
|
656
|
+
|
|
657
|
+
### Parameters
|
|
658
|
+
|
|
659
|
+
Name | Type | Description | Notes
|
|
660
|
+
------------- | ------------- | ------------- | -------------
|
|
661
|
+
**auto_order_add_ons_update_request** | [**AutoOrderAddonItemsUpdateRequest**](AutoOrderAddonItemsUpdateRequest.md)| Auto order add ons update request |
|
|
662
|
+
**auto_order_oid** | **Integer**| The auto order oid to update. |
|
|
663
|
+
**auto_order_item_oid** | **Integer**| The auto order item oid to update. |
|
|
664
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
665
|
+
|
|
666
|
+
### Return type
|
|
667
|
+
|
|
668
|
+
[**AutoOrderResponse**](AutoOrderResponse.md)
|
|
669
|
+
|
|
670
|
+
### Authorization
|
|
671
|
+
|
|
672
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
673
|
+
|
|
674
|
+
### HTTP request headers
|
|
675
|
+
|
|
676
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
677
|
+
- **Accept**: application/json
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
# **update_auto_order_item_properties**
|
|
682
|
+
> AutoOrderResponse update_auto_order_item_properties(auto_order_properties_update_request, auto_order_oid, auto_order_item_oid, opts)
|
|
683
|
+
|
|
684
|
+
Update an auto order item properties
|
|
685
|
+
|
|
686
|
+
Update an auto order item properties. Returns the auto order based upon expansion
|
|
687
|
+
|
|
688
|
+
### Example
|
|
689
|
+
```ruby
|
|
690
|
+
# load the gem
|
|
691
|
+
require 'ultracart_api'
|
|
692
|
+
|
|
693
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
694
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
695
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
auto_order_properties_update_request = UltracartClient::AutoOrderPropertiesUpdateRequest.new # AutoOrderPropertiesUpdateRequest | Auto order property update request
|
|
699
|
+
|
|
700
|
+
auto_order_oid = 56 # Integer | The auto order oid to update.
|
|
701
|
+
|
|
702
|
+
auto_order_item_oid = 56 # Integer | The auto order item oid to update.
|
|
703
|
+
|
|
704
|
+
opts = {
|
|
705
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
begin
|
|
709
|
+
#Update an auto order item properties
|
|
710
|
+
result = api_instance.update_auto_order_item_properties(auto_order_properties_update_request, auto_order_oid, auto_order_item_oid, opts)
|
|
711
|
+
p result
|
|
712
|
+
rescue UltracartClient::ApiError => e
|
|
713
|
+
puts "Exception when calling AutoOrderApi->update_auto_order_item_properties: #{e}"
|
|
714
|
+
end
|
|
715
|
+
```
|
|
716
|
+
|
|
717
|
+
### Parameters
|
|
718
|
+
|
|
719
|
+
Name | Type | Description | Notes
|
|
720
|
+
------------- | ------------- | ------------- | -------------
|
|
721
|
+
**auto_order_properties_update_request** | [**AutoOrderPropertiesUpdateRequest**](AutoOrderPropertiesUpdateRequest.md)| Auto order property update request |
|
|
722
|
+
**auto_order_oid** | **Integer**| The auto order oid to update. |
|
|
723
|
+
**auto_order_item_oid** | **Integer**| The auto order item oid to update. |
|
|
724
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
725
|
+
|
|
726
|
+
### Return type
|
|
727
|
+
|
|
728
|
+
[**AutoOrderResponse**](AutoOrderResponse.md)
|
|
729
|
+
|
|
730
|
+
### Authorization
|
|
731
|
+
|
|
732
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
733
|
+
|
|
734
|
+
### HTTP request headers
|
|
735
|
+
|
|
736
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
737
|
+
- **Accept**: application/json
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
# **update_auto_order_properties**
|
|
742
|
+
> AutoOrderResponse update_auto_order_properties(auto_order_properties_update_request, auto_order_oid, opts)
|
|
743
|
+
|
|
744
|
+
Update an auto order properties
|
|
745
|
+
|
|
746
|
+
Update an auto order properties. Returns the auto order based upon expansion
|
|
747
|
+
|
|
748
|
+
### Example
|
|
749
|
+
```ruby
|
|
750
|
+
# load the gem
|
|
751
|
+
require 'ultracart_api'
|
|
752
|
+
|
|
753
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
754
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
755
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
auto_order_properties_update_request = UltracartClient::AutoOrderPropertiesUpdateRequest.new # AutoOrderPropertiesUpdateRequest | Auto order property update request
|
|
759
|
+
|
|
760
|
+
auto_order_oid = 56 # Integer | The auto order oid to update.
|
|
761
|
+
|
|
762
|
+
opts = {
|
|
763
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
764
|
+
}
|
|
765
|
+
|
|
766
|
+
begin
|
|
767
|
+
#Update an auto order properties
|
|
768
|
+
result = api_instance.update_auto_order_properties(auto_order_properties_update_request, auto_order_oid, opts)
|
|
769
|
+
p result
|
|
770
|
+
rescue UltracartClient::ApiError => e
|
|
771
|
+
puts "Exception when calling AutoOrderApi->update_auto_order_properties: #{e}"
|
|
772
|
+
end
|
|
773
|
+
```
|
|
774
|
+
|
|
775
|
+
### Parameters
|
|
776
|
+
|
|
777
|
+
Name | Type | Description | Notes
|
|
778
|
+
------------- | ------------- | ------------- | -------------
|
|
779
|
+
**auto_order_properties_update_request** | [**AutoOrderPropertiesUpdateRequest**](AutoOrderPropertiesUpdateRequest.md)| Auto order property update request |
|
|
780
|
+
**auto_order_oid** | **Integer**| The auto order oid to update. |
|
|
781
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
782
|
+
|
|
783
|
+
### Return type
|
|
784
|
+
|
|
785
|
+
[**AutoOrderResponse**](AutoOrderResponse.md)
|
|
786
|
+
|
|
787
|
+
### Authorization
|
|
788
|
+
|
|
789
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
790
|
+
|
|
791
|
+
### HTTP request headers
|
|
792
|
+
|
|
793
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
794
|
+
- **Accept**: application/json
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
|
|
618
798
|
# **update_auto_orders_batch**
|
|
619
799
|
> AutoOrdersResponse update_auto_orders_batch(auto_orders_request, opts)
|
|
620
800
|
|
data/docs/AutoOrderItem.md
CHANGED
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**add_ons** | [**Array<AutoOrderAddonItem>**](AutoOrderAddonItem.md) | Array of addon objects instructing which items to add to auto order and how many times they should be added. | [optional]
|
|
6
7
|
**arbitrary_item_id** | **String** | Arbitrary item id that should be rebilled instead of the normal schedule | [optional]
|
|
7
8
|
**arbitrary_percentage_discount** | **Float** | An arbitrary percentage discount to provide on future rebills | [optional]
|
|
8
9
|
**arbitrary_quantity** | **Float** | Arbitrary quantity to rebill | [optional]
|
|
@@ -28,6 +29,7 @@ Name | Type | Description | Notes
|
|
|
28
29
|
**paypal_payer_id** | **String** | The PayPal Payer ID tied to this item | [optional]
|
|
29
30
|
**paypal_recurring_payment_profile_id** | **String** | The PayPal Profile ID tied to this item | [optional]
|
|
30
31
|
**preshipment_notice_sent** | **BOOLEAN** | True if the preshipment notice associated with the next rebill has been sent | [optional]
|
|
32
|
+
**properties** | [**Array<AutoOrderProperty>**](AutoOrderProperty.md) | Array of property objects | [optional]
|
|
31
33
|
**rebill_value** | **Float** | The value of the rebills of this item | [optional]
|
|
32
34
|
**remaining_repeat_count** | **Integer** | The number of rebills remaining before this item is complete | [optional]
|
|
33
35
|
**simple_schedule** | [**AutoOrderItemSimpleSchedule**](AutoOrderItemSimpleSchedule.md) | | [optional]
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderPropertiesUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**properties** | [**Array<AutoOrderProperty>**](AutoOrderProperty.md) | Properties to update | [optional]
|
|
7
|
+
|
|
8
|
+
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# UltracartClient::AutoOrderProperty
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**name** | **String** | Name of the property | [optional]
|
|
7
|
+
**value** | **String** | Value of the property | [optional]
|
|
8
|
+
|
|
9
|
+
|
data/docs/ConversationApi.md
CHANGED
|
@@ -36,6 +36,7 @@ Method | HTTP request | Description
|
|
|
36
36
|
[**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
|
|
37
37
|
[**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
|
|
38
38
|
[**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
|
|
39
|
+
[**get_conversation_item_variations**](ConversationApi.md#get_conversation_item_variations) | **GET** /conversation/items/{merchant_item_id}/variations | Retrieve an item with sparse variations populated
|
|
39
40
|
[**get_conversation_knowledge_base_document_upload_url**](ConversationApi.md#get_conversation_knowledge_base_document_upload_url) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension} | Get a pre-signed conversation knowledge base document upload URL
|
|
40
41
|
[**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
|
|
41
42
|
[**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
|
|
@@ -1699,6 +1700,56 @@ This endpoint does not need any parameter.
|
|
|
1699
1700
|
|
|
1700
1701
|
|
|
1701
1702
|
|
|
1703
|
+
# **get_conversation_item_variations**
|
|
1704
|
+
> ItemResponse get_conversation_item_variations(merchant_item_id)
|
|
1705
|
+
|
|
1706
|
+
Retrieve an item with sparse variations populated
|
|
1707
|
+
|
|
1708
|
+
Retrieve an item with sparse variations populated
|
|
1709
|
+
|
|
1710
|
+
### Example
|
|
1711
|
+
```ruby
|
|
1712
|
+
# load the gem
|
|
1713
|
+
require 'ultracart_api'
|
|
1714
|
+
|
|
1715
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1716
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1717
|
+
api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, false, false)
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
merchant_item_id = 'merchant_item_id_example' # String |
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
begin
|
|
1724
|
+
#Retrieve an item with sparse variations populated
|
|
1725
|
+
result = api_instance.get_conversation_item_variations(merchant_item_id)
|
|
1726
|
+
p result
|
|
1727
|
+
rescue UltracartClient::ApiError => e
|
|
1728
|
+
puts "Exception when calling ConversationApi->get_conversation_item_variations: #{e}"
|
|
1729
|
+
end
|
|
1730
|
+
```
|
|
1731
|
+
|
|
1732
|
+
### Parameters
|
|
1733
|
+
|
|
1734
|
+
Name | Type | Description | Notes
|
|
1735
|
+
------------- | ------------- | ------------- | -------------
|
|
1736
|
+
**merchant_item_id** | **String**| |
|
|
1737
|
+
|
|
1738
|
+
### Return type
|
|
1739
|
+
|
|
1740
|
+
[**ItemResponse**](ItemResponse.md)
|
|
1741
|
+
|
|
1742
|
+
### Authorization
|
|
1743
|
+
|
|
1744
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1745
|
+
|
|
1746
|
+
### HTTP request headers
|
|
1747
|
+
|
|
1748
|
+
- **Content-Type**: application/json
|
|
1749
|
+
- **Accept**: application/json
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
|
|
1702
1753
|
# **get_conversation_knowledge_base_document_upload_url**
|
|
1703
1754
|
> ConversationKnowledgeBaseDocumentUploadUrlResponse get_conversation_knowledge_base_document_upload_url(user_id, extension)
|
|
1704
1755
|
|
|
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
|
|
|
13
13
|
**postcard_container_cjson_last_modified_dts** | **String** | Timestamp the last time the container was modified. | [optional]
|
|
14
14
|
**postcard_front_container_cjson** | **String** | Postcard front container cjson | [optional]
|
|
15
15
|
**postcard_front_container_uuid** | **String** | Postcard front container uuid | [optional]
|
|
16
|
-
**screenshot_back_url** | **String** | URL to screenshot of the
|
|
16
|
+
**screenshot_back_url** | **String** | URL to screenshot of the back of the postcard | [optional]
|
|
17
17
|
**screenshot_front_url** | **String** | URL to screenshot of the front of the postcard | [optional]
|
|
18
18
|
**storefront_oid** | **Integer** | Storefront oid | [optional]
|
|
19
19
|
|
data/docs/ItemApi.md
CHANGED
|
@@ -13,6 +13,7 @@ Method | HTTP request | Description
|
|
|
13
13
|
[**get_inventory_snapshot**](ItemApi.md#get_inventory_snapshot) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
|
14
14
|
[**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
|
|
15
15
|
[**get_item_by_merchant_item_id**](ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
|
|
16
|
+
[**get_item_shipping_distribution_center_by_code**](ItemApi.md#get_item_shipping_distribution_center_by_code) | **GET** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Retrieve an item shipping distribution center
|
|
16
17
|
[**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
|
17
18
|
[**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
|
|
18
19
|
[**get_review**](ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
|
|
@@ -24,6 +25,8 @@ Method | HTTP request | Description
|
|
|
24
25
|
[**insert_update_item_content_attribute**](ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
|
|
25
26
|
[**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
|
|
26
27
|
[**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
|
28
|
+
[**update_item_inventories**](ItemApi.md#update_item_inventories) | **PUT** /item/items/update_item_inventories | Update item inventories for a distribution center
|
|
29
|
+
[**update_item_shipping_distribution_center_by_code**](ItemApi.md#update_item_shipping_distribution_center_by_code) | **PUT** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Update an item shipping distribution center
|
|
27
30
|
[**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
|
28
31
|
[**update_review**](ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
|
|
29
32
|
[**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
|
|
@@ -497,6 +500,65 @@ Name | Type | Description | Notes
|
|
|
497
500
|
|
|
498
501
|
|
|
499
502
|
|
|
503
|
+
# **get_item_shipping_distribution_center_by_code**
|
|
504
|
+
> ItemShippingDistributionCenterResponse get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, opts)
|
|
505
|
+
|
|
506
|
+
Retrieve an item shipping distribution center
|
|
507
|
+
|
|
508
|
+
Retrieve an item shipping distribution center.
|
|
509
|
+
|
|
510
|
+
### Example
|
|
511
|
+
```ruby
|
|
512
|
+
# load the gem
|
|
513
|
+
require 'ultracart_api'
|
|
514
|
+
|
|
515
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
516
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
517
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
merchant_item_oid = 56 # Integer | The item oid to retrieve.
|
|
521
|
+
|
|
522
|
+
distribution_center_code = 'distribution_center_code_example' # String |
|
|
523
|
+
|
|
524
|
+
opts = {
|
|
525
|
+
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
|
526
|
+
_placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
begin
|
|
530
|
+
#Retrieve an item shipping distribution center
|
|
531
|
+
result = api_instance.get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, opts)
|
|
532
|
+
p result
|
|
533
|
+
rescue UltracartClient::ApiError => e
|
|
534
|
+
puts "Exception when calling ItemApi->get_item_shipping_distribution_center_by_code: #{e}"
|
|
535
|
+
end
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
### Parameters
|
|
539
|
+
|
|
540
|
+
Name | Type | Description | Notes
|
|
541
|
+
------------- | ------------- | ------------- | -------------
|
|
542
|
+
**merchant_item_oid** | **Integer**| The item oid to retrieve. |
|
|
543
|
+
**distribution_center_code** | **String**| |
|
|
544
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
|
545
|
+
**_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
|
|
546
|
+
|
|
547
|
+
### Return type
|
|
548
|
+
|
|
549
|
+
[**ItemShippingDistributionCenterResponse**](ItemShippingDistributionCenterResponse.md)
|
|
550
|
+
|
|
551
|
+
### Authorization
|
|
552
|
+
|
|
553
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
554
|
+
|
|
555
|
+
### HTTP request headers
|
|
556
|
+
|
|
557
|
+
- **Content-Type**: application/json
|
|
558
|
+
- **Accept**: application/json
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
|
|
500
562
|
# **get_items**
|
|
501
563
|
> ItemsResponse get_items(opts)
|
|
502
564
|
|
|
@@ -1100,6 +1162,110 @@ Name | Type | Description | Notes
|
|
|
1100
1162
|
|
|
1101
1163
|
|
|
1102
1164
|
|
|
1165
|
+
# **update_item_inventories**
|
|
1166
|
+
> update_item_inventories(item_inventory_update_request)
|
|
1167
|
+
|
|
1168
|
+
Update item inventories for a distribution center
|
|
1169
|
+
|
|
1170
|
+
Update item inventories for a distribution center
|
|
1171
|
+
|
|
1172
|
+
### Example
|
|
1173
|
+
```ruby
|
|
1174
|
+
# load the gem
|
|
1175
|
+
require 'ultracart_api'
|
|
1176
|
+
|
|
1177
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1178
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1179
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
item_inventory_update_request = UltracartClient::ItemInventoryUpdateRequest.new # ItemInventoryUpdateRequest | Item inventory updates
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
begin
|
|
1186
|
+
#Update item inventories for a distribution center
|
|
1187
|
+
api_instance.update_item_inventories(item_inventory_update_request)
|
|
1188
|
+
rescue UltracartClient::ApiError => e
|
|
1189
|
+
puts "Exception when calling ItemApi->update_item_inventories: #{e}"
|
|
1190
|
+
end
|
|
1191
|
+
```
|
|
1192
|
+
|
|
1193
|
+
### Parameters
|
|
1194
|
+
|
|
1195
|
+
Name | Type | Description | Notes
|
|
1196
|
+
------------- | ------------- | ------------- | -------------
|
|
1197
|
+
**item_inventory_update_request** | [**ItemInventoryUpdateRequest**](ItemInventoryUpdateRequest.md)| Item inventory updates |
|
|
1198
|
+
|
|
1199
|
+
### Return type
|
|
1200
|
+
|
|
1201
|
+
nil (empty response body)
|
|
1202
|
+
|
|
1203
|
+
### Authorization
|
|
1204
|
+
|
|
1205
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1206
|
+
|
|
1207
|
+
### HTTP request headers
|
|
1208
|
+
|
|
1209
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1210
|
+
- **Accept**: application/json
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
# **update_item_shipping_distribution_center_by_code**
|
|
1215
|
+
> update_item_shipping_distribution_center_by_code(item_shipping_distribution_center, merchant_item_oid, distribution_center_code)
|
|
1216
|
+
|
|
1217
|
+
Update an item shipping distribution center
|
|
1218
|
+
|
|
1219
|
+
Update an item shipping distribution center
|
|
1220
|
+
|
|
1221
|
+
### Example
|
|
1222
|
+
```ruby
|
|
1223
|
+
# load the gem
|
|
1224
|
+
require 'ultracart_api'
|
|
1225
|
+
|
|
1226
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1227
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1228
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
item_shipping_distribution_center = UltracartClient::ItemShippingDistributionCenter.new # ItemShippingDistributionCenter | Item shipping distribution center
|
|
1232
|
+
|
|
1233
|
+
merchant_item_oid = 56 # Integer | The item oid to update.
|
|
1234
|
+
|
|
1235
|
+
distribution_center_code = 'distribution_center_code_example' # String |
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
begin
|
|
1239
|
+
#Update an item shipping distribution center
|
|
1240
|
+
api_instance.update_item_shipping_distribution_center_by_code(item_shipping_distribution_center, merchant_item_oid, distribution_center_code)
|
|
1241
|
+
rescue UltracartClient::ApiError => e
|
|
1242
|
+
puts "Exception when calling ItemApi->update_item_shipping_distribution_center_by_code: #{e}"
|
|
1243
|
+
end
|
|
1244
|
+
```
|
|
1245
|
+
|
|
1246
|
+
### Parameters
|
|
1247
|
+
|
|
1248
|
+
Name | Type | Description | Notes
|
|
1249
|
+
------------- | ------------- | ------------- | -------------
|
|
1250
|
+
**item_shipping_distribution_center** | [**ItemShippingDistributionCenter**](ItemShippingDistributionCenter.md)| Item shipping distribution center |
|
|
1251
|
+
**merchant_item_oid** | **Integer**| The item oid to update. |
|
|
1252
|
+
**distribution_center_code** | **String**| |
|
|
1253
|
+
|
|
1254
|
+
### Return type
|
|
1255
|
+
|
|
1256
|
+
nil (empty response body)
|
|
1257
|
+
|
|
1258
|
+
### Authorization
|
|
1259
|
+
|
|
1260
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1261
|
+
|
|
1262
|
+
### HTTP request headers
|
|
1263
|
+
|
|
1264
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1265
|
+
- **Accept**: application/json
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
|
|
1103
1269
|
# **update_items**
|
|
1104
1270
|
> ItemsResponse update_items(items_request, opts)
|
|
1105
1271
|
|