ultracart_api 3.10.94 → 3.10.95

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d3237e3f9a5f0d0507dd42a1d5f888569d417f15b78e4090cf5e558b63dc7475
4
- data.tar.gz: 194242afd7ac7ade8d4e4fb3a37cdc43cf78821c1a7713f85be17ad5d896c500
3
+ metadata.gz: cb0ce63beb97a544421dff5628b9a1bf0b8be1b855e620f5d83ed23b720d993f
4
+ data.tar.gz: cefc368bd2121737c39724c0272d051373649a78deb4b78cf61f05c389174c07
5
5
  SHA512:
6
- metadata.gz: c9009738f5bfb155a8f7e422610fdc061717a57c1266330529485efd4bd952a1ee5c5c28ece1ba356cb5425c4b29fe57ebf0b5f12a6905f10c4709a990278626
7
- data.tar.gz: 0d42a3bfa1ff4503b43d47c436c1dce95f58ccd6cd9447956f55b4e1b0034d07a04c2fca19fc5907a687ec3dd68014472a071dd5acf1b83a280e60fdfd22320b
6
+ metadata.gz: 3ca959b5cdf6593bb3deb495109c04b2938de1556b1d39e7e312384090a42491fb39819f5de328a830a81ddc7630e8a759e28e0de411f08262709ec9e689b4db
7
+ data.tar.gz: 4ac69d5f2e67c923722c8ed8fcb94b1b2a3496da0ece88cb14e07a0f5522420bb212bddc64db4916d3851c2ce54d26153516bc7f6a8c468334b1a1137095ba51
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.10.94
10
+ - Package version: 3.10.95
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
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.10.94.gem
27
+ gem install ./ultracart_api-3.10.95.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.10.94.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.10.95.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.10.94'
35
+ gem 'ultracart_api', '~> 3.10.95'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -98,9 +98,15 @@ Class | Method | HTTP request | Description
98
98
  *UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
99
99
  *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
100
100
  *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
101
+ *UltracartClient::ChannelPartnerApi* | [**delete_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#delete_channel_partner_ship_to_preference) | **DELETE** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Delete a ship to preference record for the channel partner.
101
102
  *UltracartClient::ChannelPartnerApi* | [**estimate_shipping_for_channel_partner_order**](docs/ChannelPartnerApi.md#estimate_shipping_for_channel_partner_order) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
102
103
  *UltracartClient::ChannelPartnerApi* | [**estimate_tax_for_channel_partner_order**](docs/ChannelPartnerApi.md#estimate_tax_for_channel_partner_order) | **POST** /channel_partner/estimate_tax | Estimate tax for channel partner order
104
+ *UltracartClient::ChannelPartnerApi* | [**get_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#get_channel_partner_ship_to_preference) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Retrieve the ship to preference associated with the channel partner and the specific id.
105
+ *UltracartClient::ChannelPartnerApi* | [**get_channel_partner_ship_to_preferences**](docs/ChannelPartnerApi.md#get_channel_partner_ship_to_preferences) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Retrieve the ship to preferences associated with the channel partner.
106
+ *UltracartClient::ChannelPartnerApi* | [**get_channel_partners**](docs/ChannelPartnerApi.md#get_channel_partners) | **GET** /channel_partner/channel_partners | Retrieve the channel partners configured on the account.
103
107
  *UltracartClient::ChannelPartnerApi* | [**import_channel_partner_order**](docs/ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
108
+ *UltracartClient::ChannelPartnerApi* | [**insert_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#insert_channel_partner_ship_to_preference) | **POST** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Insert a ship to preference record for the channel partner.
109
+ *UltracartClient::ChannelPartnerApi* | [**update_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#update_channel_partner_ship_to_preference) | **PUT** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Update a ship to preference record for the channel partner.
104
110
  *UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
105
111
  *UltracartClient::ChargebackApi* | [**get_chargeback_dispute**](docs/ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
106
112
  *UltracartClient::ChargebackApi* | [**get_chargeback_disputes**](docs/ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks
@@ -586,7 +592,11 @@ Class | Method | HTTP request | Description
586
592
  - [UltracartClient::ChannelPartnerOrderItemOption](docs/ChannelPartnerOrderItemOption.md)
587
593
  - [UltracartClient::ChannelPartnerOrderTransaction](docs/ChannelPartnerOrderTransaction.md)
588
594
  - [UltracartClient::ChannelPartnerOrderTransactionDetail](docs/ChannelPartnerOrderTransactionDetail.md)
595
+ - [UltracartClient::ChannelPartnerShipToPreference](docs/ChannelPartnerShipToPreference.md)
596
+ - [UltracartClient::ChannelPartnerShipToPreferenceResponse](docs/ChannelPartnerShipToPreferenceResponse.md)
597
+ - [UltracartClient::ChannelPartnerShipToPreferencesResponse](docs/ChannelPartnerShipToPreferencesResponse.md)
589
598
  - [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
599
+ - [UltracartClient::ChannelPartnersResponse](docs/ChannelPartnersResponse.md)
590
600
  - [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
591
601
  - [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
592
602
  - [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
@@ -1271,6 +1281,7 @@ Not every change is committed to every SDK.
1271
1281
 
1272
1282
  | Version | Date | Comments |
1273
1283
  | --: | :-: | --- |
1284
+ | 3.10.95 | 01/13/2023 | channel - ops to manage ship to prefs |
1274
1285
  | 3.10.94 | 01/11/2023 | conversations - adjust search results to return multiple convo summaries |
1275
1286
  | 3.10.93 | 01/10/2023 | add method to query integration log record by oid |
1276
1287
  | 3.10.92 | 01/10/2023 | bug fix for typescript enum error due to apost |
@@ -6,9 +6,15 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**cancel_order_by_channel_partner_order_id**](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
8
8
  [**cancel_order_by_ultra_cart_order_id**](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
9
+ [**delete_channel_partner_ship_to_preference**](ChannelPartnerApi.md#delete_channel_partner_ship_to_preference) | **DELETE** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Delete a ship to preference record for the channel partner.
9
10
  [**estimate_shipping_for_channel_partner_order**](ChannelPartnerApi.md#estimate_shipping_for_channel_partner_order) | **POST** /channel_partner/estimate_shipping | Estimate shipping for channel partner order
10
11
  [**estimate_tax_for_channel_partner_order**](ChannelPartnerApi.md#estimate_tax_for_channel_partner_order) | **POST** /channel_partner/estimate_tax | Estimate tax for channel partner order
12
+ [**get_channel_partner_ship_to_preference**](ChannelPartnerApi.md#get_channel_partner_ship_to_preference) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Retrieve the ship to preference associated with the channel partner and the specific id.
13
+ [**get_channel_partner_ship_to_preferences**](ChannelPartnerApi.md#get_channel_partner_ship_to_preferences) | **GET** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Retrieve the ship to preferences associated with the channel partner.
14
+ [**get_channel_partners**](ChannelPartnerApi.md#get_channel_partners) | **GET** /channel_partner/channel_partners | Retrieve the channel partners configured on the account.
11
15
  [**import_channel_partner_order**](ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
16
+ [**insert_channel_partner_ship_to_preference**](ChannelPartnerApi.md#insert_channel_partner_ship_to_preference) | **POST** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences | Insert a ship to preference record for the channel partner.
17
+ [**update_channel_partner_ship_to_preference**](ChannelPartnerApi.md#update_channel_partner_ship_to_preference) | **PUT** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Update a ship to preference record for the channel partner.
12
18
 
13
19
 
14
20
  # **cancel_order_by_channel_partner_order_id**
@@ -111,6 +117,58 @@ Name | Type | Description | Notes
111
117
 
112
118
 
113
119
 
120
+ # **delete_channel_partner_ship_to_preference**
121
+ > delete_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
122
+
123
+ Delete a ship to preference record for the channel partner.
124
+
125
+ Delete a ship to preference record for the channel partner.
126
+
127
+ ### Example
128
+ ```ruby
129
+ # load the gem
130
+ require 'ultracart_api'
131
+
132
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
133
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
134
+ api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
135
+
136
+
137
+ channel_partner_oid = 56 # Integer |
138
+
139
+ channel_partner_ship_to_preference_oid = 56 # Integer |
140
+
141
+
142
+ begin
143
+ #Delete a ship to preference record for the channel partner.
144
+ api_instance.delete_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
145
+ rescue UltracartClient::ApiError => e
146
+ puts "Exception when calling ChannelPartnerApi->delete_channel_partner_ship_to_preference: #{e}"
147
+ end
148
+ ```
149
+
150
+ ### Parameters
151
+
152
+ Name | Type | Description | Notes
153
+ ------------- | ------------- | ------------- | -------------
154
+ **channel_partner_oid** | **Integer**| |
155
+ **channel_partner_ship_to_preference_oid** | **Integer**| |
156
+
157
+ ### Return type
158
+
159
+ nil (empty response body)
160
+
161
+ ### Authorization
162
+
163
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
164
+
165
+ ### HTTP request headers
166
+
167
+ - **Content-Type**: application/json
168
+ - **Accept**: application/json
169
+
170
+
171
+
114
172
  # **estimate_shipping_for_channel_partner_order**
115
173
  > ChannelPartnerEstimateShippingResponse estimate_shipping_for_channel_partner_order(channel_partner_order)
116
174
 
@@ -211,6 +269,154 @@ Name | Type | Description | Notes
211
269
 
212
270
 
213
271
 
272
+ # **get_channel_partner_ship_to_preference**
273
+ > ChannelPartnerShipToPreferenceResponse get_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
274
+
275
+ Retrieve the ship to preference associated with the channel partner and the specific id.
276
+
277
+ Retrieve the ship to preference associated with the channel partner and the specific id.
278
+
279
+ ### Example
280
+ ```ruby
281
+ # load the gem
282
+ require 'ultracart_api'
283
+
284
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
285
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
286
+ api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
287
+
288
+
289
+ channel_partner_oid = 56 # Integer |
290
+
291
+ channel_partner_ship_to_preference_oid = 56 # Integer |
292
+
293
+
294
+ begin
295
+ #Retrieve the ship to preference associated with the channel partner and the specific id.
296
+ result = api_instance.get_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
297
+ p result
298
+ rescue UltracartClient::ApiError => e
299
+ puts "Exception when calling ChannelPartnerApi->get_channel_partner_ship_to_preference: #{e}"
300
+ end
301
+ ```
302
+
303
+ ### Parameters
304
+
305
+ Name | Type | Description | Notes
306
+ ------------- | ------------- | ------------- | -------------
307
+ **channel_partner_oid** | **Integer**| |
308
+ **channel_partner_ship_to_preference_oid** | **Integer**| |
309
+
310
+ ### Return type
311
+
312
+ [**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.md)
313
+
314
+ ### Authorization
315
+
316
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
317
+
318
+ ### HTTP request headers
319
+
320
+ - **Content-Type**: application/json
321
+ - **Accept**: application/json
322
+
323
+
324
+
325
+ # **get_channel_partner_ship_to_preferences**
326
+ > ChannelPartnerShipToPreferencesResponse get_channel_partner_ship_to_preferences(channel_partner_oid)
327
+
328
+ Retrieve the ship to preferences associated with the channel partner.
329
+
330
+ Retrieve the ship to preferences associated with the channel partner.
331
+
332
+ ### Example
333
+ ```ruby
334
+ # load the gem
335
+ require 'ultracart_api'
336
+
337
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
338
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
339
+ api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
340
+
341
+
342
+ channel_partner_oid = 56 # Integer |
343
+
344
+
345
+ begin
346
+ #Retrieve the ship to preferences associated with the channel partner.
347
+ result = api_instance.get_channel_partner_ship_to_preferences(channel_partner_oid)
348
+ p result
349
+ rescue UltracartClient::ApiError => e
350
+ puts "Exception when calling ChannelPartnerApi->get_channel_partner_ship_to_preferences: #{e}"
351
+ end
352
+ ```
353
+
354
+ ### Parameters
355
+
356
+ Name | Type | Description | Notes
357
+ ------------- | ------------- | ------------- | -------------
358
+ **channel_partner_oid** | **Integer**| |
359
+
360
+ ### Return type
361
+
362
+ [**ChannelPartnerShipToPreferencesResponse**](ChannelPartnerShipToPreferencesResponse.md)
363
+
364
+ ### Authorization
365
+
366
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
367
+
368
+ ### HTTP request headers
369
+
370
+ - **Content-Type**: application/json
371
+ - **Accept**: application/json
372
+
373
+
374
+
375
+ # **get_channel_partners**
376
+ > ChannelPartnersResponse get_channel_partners
377
+
378
+ Retrieve the channel partners configured on the account.
379
+
380
+ Retrieve the channel partners configured on the account.
381
+
382
+ ### Example
383
+ ```ruby
384
+ # load the gem
385
+ require 'ultracart_api'
386
+
387
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
388
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
389
+ api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
390
+
391
+
392
+
393
+ begin
394
+ #Retrieve the channel partners configured on the account.
395
+ result = api_instance.get_channel_partners
396
+ p result
397
+ rescue UltracartClient::ApiError => e
398
+ puts "Exception when calling ChannelPartnerApi->get_channel_partners: #{e}"
399
+ end
400
+ ```
401
+
402
+ ### Parameters
403
+ This endpoint does not need any parameter.
404
+
405
+ ### Return type
406
+
407
+ [**ChannelPartnersResponse**](ChannelPartnersResponse.md)
408
+
409
+ ### Authorization
410
+
411
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
412
+
413
+ ### HTTP request headers
414
+
415
+ - **Content-Type**: application/json
416
+ - **Accept**: application/json
417
+
418
+
419
+
214
420
  # **import_channel_partner_order**
215
421
  > ChannelPartnerImportResponse import_channel_partner_order(channel_partner_order)
216
422
 
@@ -261,3 +467,112 @@ Name | Type | Description | Notes
261
467
 
262
468
 
263
469
 
470
+ # **insert_channel_partner_ship_to_preference**
471
+ > ChannelPartnerShipToPreferenceResponse insert_channel_partner_ship_to_preference(channel_partner_oid, ship_to_preference)
472
+
473
+ Insert a ship to preference record for the channel partner.
474
+
475
+ Insert a ship to preference record for the channel partner.
476
+
477
+ ### Example
478
+ ```ruby
479
+ # load the gem
480
+ require 'ultracart_api'
481
+
482
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
483
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
484
+ api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
485
+
486
+
487
+ channel_partner_oid = 56 # Integer |
488
+
489
+ ship_to_preference = UltracartClient::ChannelPartnerShipToPreference.new # ChannelPartnerShipToPreference | Ship to preference to create
490
+
491
+
492
+ begin
493
+ #Insert a ship to preference record for the channel partner.
494
+ result = api_instance.insert_channel_partner_ship_to_preference(channel_partner_oid, ship_to_preference)
495
+ p result
496
+ rescue UltracartClient::ApiError => e
497
+ puts "Exception when calling ChannelPartnerApi->insert_channel_partner_ship_to_preference: #{e}"
498
+ end
499
+ ```
500
+
501
+ ### Parameters
502
+
503
+ Name | Type | Description | Notes
504
+ ------------- | ------------- | ------------- | -------------
505
+ **channel_partner_oid** | **Integer**| |
506
+ **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md)| Ship to preference to create |
507
+
508
+ ### Return type
509
+
510
+ [**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.md)
511
+
512
+ ### Authorization
513
+
514
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
515
+
516
+ ### HTTP request headers
517
+
518
+ - **Content-Type**: application/json
519
+ - **Accept**: application/json
520
+
521
+
522
+
523
+ # **update_channel_partner_ship_to_preference**
524
+ > ChannelPartnerShipToPreferenceResponse update_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
525
+
526
+ Update a ship to preference record for the channel partner.
527
+
528
+ Update a ship to preference record for the channel partner.
529
+
530
+ ### Example
531
+ ```ruby
532
+ # load the gem
533
+ require 'ultracart_api'
534
+
535
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
536
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
537
+ api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
538
+
539
+
540
+ channel_partner_oid = 56 # Integer |
541
+
542
+ channel_partner_ship_to_preference_oid = 56 # Integer |
543
+
544
+ ship_to_preference = UltracartClient::ChannelPartnerShipToPreference.new # ChannelPartnerShipToPreference | Ship to preference to create
545
+
546
+
547
+ begin
548
+ #Update a ship to preference record for the channel partner.
549
+ result = api_instance.update_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
550
+ p result
551
+ rescue UltracartClient::ApiError => e
552
+ puts "Exception when calling ChannelPartnerApi->update_channel_partner_ship_to_preference: #{e}"
553
+ end
554
+ ```
555
+
556
+ ### Parameters
557
+
558
+ Name | Type | Description | Notes
559
+ ------------- | ------------- | ------------- | -------------
560
+ **channel_partner_oid** | **Integer**| |
561
+ **channel_partner_ship_to_preference_oid** | **Integer**| |
562
+ **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md)| Ship to preference to create |
563
+
564
+ ### Return type
565
+
566
+ [**ChannelPartnerShipToPreferenceResponse**](ChannelPartnerShipToPreferenceResponse.md)
567
+
568
+ ### Authorization
569
+
570
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
571
+
572
+ ### HTTP request headers
573
+
574
+ - **Content-Type**: application/json
575
+ - **Accept**: application/json
576
+
577
+
578
+
@@ -0,0 +1,13 @@
1
+ # UltracartClient::ChannelPartnerShipToPreference
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **additional_kit_component_item_ids** | **Array<String>** | Additional item ids to add as kit components to the order with a zero price. | [optional]
7
+ **channel_partner_oid** | **Integer** | The channel partner object identifier this preference is associated with | [optional]
8
+ **channel_partner_ship_to_preference_oid** | **Integer** | Object identifier for the ship to preference | [optional]
9
+ **merchant_id** | **String** | The merchant id that owns the channel partner | [optional]
10
+ **return_policy** | **String** | Alternate return policy to print on the packing slip. | [optional]
11
+ **ship_to_edi_code** | **String** | The ship to EDI code that the preferences are for | [optional]
12
+
13
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ChannelPartnerShipToPreferenceResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **ship_to_preference** | [**ChannelPartnerShipToPreference**](ChannelPartnerShipToPreference.md) | | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ChannelPartnerShipToPreferencesResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **error** | [**Error**](Error.md) | | [optional]
7
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
8
+ **ship_to_preferences** | [**Array<ChannelPartnerShipToPreference>**](ChannelPartnerShipToPreference.md) | ship_to_preferences | [optional]
9
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
10
+ **warning** | [**Warning**](Warning.md) | | [optional]
11
+
12
+
@@ -0,0 +1,12 @@
1
+ # UltracartClient::ChannelPartnersResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **channel_partners** | [**Array<ChannelPartner>**](ChannelPartner.md) | channel_partners | [optional]
7
+ **error** | [**Error**](Error.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
+