ultracart_api 4.0.238 → 4.0.241
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 +11 -4
- data/docs/ChannelPartnerApi.md +244 -0
- data/docs/ChannelPartnerOrder.md +2 -0
- data/docs/CustomerAttachment.md +1 -1
- data/docs/CustomerQuery.md +2 -0
- data/docs/ItemReview.md +2 -0
- data/docs/Order.md +2 -0
- data/docs/OrderCurrentStageHistory.md +22 -0
- data/docs/OrderItem.md +2 -0
- data/docs/OrderSummary.md +8 -0
- data/lib/ultracart_api/api/channel_partner_api.rb +233 -0
- data/lib/ultracart_api/models/channel_partner_order.rb +11 -1
- data/lib/ultracart_api/models/customer_attachment.rb +1 -1
- data/lib/ultracart_api/models/customer_query.rb +13 -1
- data/lib/ultracart_api/models/item_review.rb +26 -1
- data/lib/ultracart_api/models/order.rb +13 -1
- data/lib/ultracart_api/models/order_current_stage_history.rb +286 -0
- data/lib/ultracart_api/models/order_item.rb +10 -1
- data/lib/ultracart_api/models/order_summary.rb +39 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +1 -0
- metadata +4 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7bd728cffe0756062860c32b59d2c27fc8bc8e0e168ad83c352af07503299a57
|
4
|
+
data.tar.gz: e2f1a97b285f756bbc878a77038b6fe495d177316974dad8d68897bc5432f27d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6c71747f764534df88e9537a6e2fbb841d335991978355fa699d74a6cadc4ffbce0d860257b604a9c57eeb10931a9c06c209f2d7e6d5fbf9439c1faf8c23bf37
|
7
|
+
data.tar.gz: 425748a8c96690e4d14b11243daf704348a54260efbafe8ada682d01cc28a7c23b2727ccfd0a047405db1f9b6ca1c13988b62499109a01fb891026cfea1f29b3
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.241
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.241.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.241.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.241'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -109,11 +109,14 @@ Class | Method | HTTP request | Description
|
|
109
109
|
*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.
|
110
110
|
*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
|
111
111
|
*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
|
112
|
+
*UltracartClient::ChannelPartnerApi* | [**get_channel_partner_order**](docs/ChannelPartnerApi.md#get_channel_partner_order) | **GET** /channel_partner/orders/{order_id} | Retrieve a channel partner order
|
113
|
+
*UltracartClient::ChannelPartnerApi* | [**get_channel_partner_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#get_channel_partner_order_by_channel_partner_order_id) | **GET** /channel_partner/orders/by_channel_partner_order_id/{order_id} | Retrieve a channel partner order by the channel partner order id
|
112
114
|
*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.
|
113
115
|
*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.
|
114
116
|
*UltracartClient::ChannelPartnerApi* | [**get_channel_partners**](docs/ChannelPartnerApi.md#get_channel_partners) | **GET** /channel_partner/channel_partners | Retrieve the channel partners configured on the account.
|
115
117
|
*UltracartClient::ChannelPartnerApi* | [**import_channel_partner_order**](docs/ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
|
116
118
|
*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.
|
119
|
+
*UltracartClient::ChannelPartnerApi* | [**refund_channel_partner_order**](docs/ChannelPartnerApi.md#refund_channel_partner_order) | **PUT** /channel_partner/orders/{order_id}/refund | Refund a channel partner order
|
117
120
|
*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.
|
118
121
|
*UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
|
119
122
|
*UltracartClient::ChargebackApi* | [**get_chargeback_dispute**](docs/ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
|
@@ -1208,6 +1211,7 @@ Class | Method | HTTP request | Description
|
|
1208
1211
|
- [UltracartClient::OrderChannelPartner](docs/OrderChannelPartner.md)
|
1209
1212
|
- [UltracartClient::OrderCheckout](docs/OrderCheckout.md)
|
1210
1213
|
- [UltracartClient::OrderCoupon](docs/OrderCoupon.md)
|
1214
|
+
- [UltracartClient::OrderCurrentStageHistory](docs/OrderCurrentStageHistory.md)
|
1211
1215
|
- [UltracartClient::OrderDigitalItem](docs/OrderDigitalItem.md)
|
1212
1216
|
- [UltracartClient::OrderDigitalOrder](docs/OrderDigitalOrder.md)
|
1213
1217
|
- [UltracartClient::OrderEdi](docs/OrderEdi.md)
|
@@ -1520,6 +1524,9 @@ Not every change is committed to every SDK.
|
|
1520
1524
|
|
1521
1525
|
| Version | Date | Comments |
|
1522
1526
|
| --: | :-: | --- |
|
1527
|
+
| 4.0.241 | 02/06/2025 | added storefront_host_name to channel partner order object |
|
1528
|
+
| 4.0.240 | 01/09/2025 | fix for broken 4.0.39 due to incorrect query sig on getCustomers |
|
1529
|
+
| 4.0.239 | 01/09/2025 | added emails parameter to customer queries, refundOrder added to Channel partner |
|
1523
1530
|
| 4.0.238 | 12/13/2024 | added user and group ids to conversation agent auth object |
|
1524
1531
|
| 4.0.237 | 11/11/2024 | added seo properties to item.content object |
|
1525
1532
|
| 4.0.236 | 11/07/2024 | Coupon - PercentOffWithItemsQuantityPurchase - added support for tags |
|
data/docs/ChannelPartnerApi.md
CHANGED
@@ -9,11 +9,14 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
9
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. |
|
10
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 |
|
11
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_order**](ChannelPartnerApi.md#get_channel_partner_order) | **GET** /channel_partner/orders/{order_id} | Retrieve a channel partner order |
|
13
|
+
| [**get_channel_partner_order_by_channel_partner_order_id**](ChannelPartnerApi.md#get_channel_partner_order_by_channel_partner_order_id) | **GET** /channel_partner/orders/by_channel_partner_order_id/{order_id} | Retrieve a channel partner order by the channel partner order id |
|
12
14
|
| [**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
15
|
| [**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
16
|
| [**get_channel_partners**](ChannelPartnerApi.md#get_channel_partners) | **GET** /channel_partner/channel_partners | Retrieve the channel partners configured on the account. |
|
15
17
|
| [**import_channel_partner_order**](ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order |
|
16
18
|
| [**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. |
|
19
|
+
| [**refund_channel_partner_order**](ChannelPartnerApi.md#refund_channel_partner_order) | **PUT** /channel_partner/orders/{order_id}/refund | Refund a channel partner order |
|
17
20
|
| [**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. |
|
18
21
|
|
19
22
|
|
@@ -373,6 +376,156 @@ end
|
|
373
376
|
- **Accept**: application/json
|
374
377
|
|
375
378
|
|
379
|
+
## get_channel_partner_order
|
380
|
+
|
381
|
+
> <OrderResponse> get_channel_partner_order(order_id, opts)
|
382
|
+
|
383
|
+
Retrieve a channel partner order
|
384
|
+
|
385
|
+
Retrieves a single order using the specified order id. Only orders belonging to this channel partner may be retrieved.
|
386
|
+
|
387
|
+
### Examples
|
388
|
+
|
389
|
+
```ruby
|
390
|
+
require 'time'
|
391
|
+
require 'ultracart_api'
|
392
|
+
require 'json'
|
393
|
+
require 'yaml'
|
394
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
395
|
+
|
396
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
397
|
+
# As such, this might not be the best way to use this object.
|
398
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
399
|
+
|
400
|
+
api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
401
|
+
order_id = 'order_id_example' # String | The order id to retrieve.
|
402
|
+
opts = {
|
403
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
404
|
+
}
|
405
|
+
|
406
|
+
begin
|
407
|
+
# Retrieve a channel partner order
|
408
|
+
result = api_instance.get_channel_partner_order(order_id, opts)
|
409
|
+
p result
|
410
|
+
rescue UltracartClient::ApiError => e
|
411
|
+
puts "Error when calling ChannelPartnerApi->get_channel_partner_order: #{e}"
|
412
|
+
end
|
413
|
+
```
|
414
|
+
|
415
|
+
#### Using the get_channel_partner_order_with_http_info variant
|
416
|
+
|
417
|
+
This returns an Array which contains the response data, status code and headers.
|
418
|
+
|
419
|
+
> <Array(<OrderResponse>, Integer, Hash)> get_channel_partner_order_with_http_info(order_id, opts)
|
420
|
+
|
421
|
+
```ruby
|
422
|
+
begin
|
423
|
+
# Retrieve a channel partner order
|
424
|
+
data, status_code, headers = api_instance.get_channel_partner_order_with_http_info(order_id, opts)
|
425
|
+
p status_code # => 2xx
|
426
|
+
p headers # => { ... }
|
427
|
+
p data # => <OrderResponse>
|
428
|
+
rescue UltracartClient::ApiError => e
|
429
|
+
puts "Error when calling ChannelPartnerApi->get_channel_partner_order_with_http_info: #{e}"
|
430
|
+
end
|
431
|
+
```
|
432
|
+
|
433
|
+
### Parameters
|
434
|
+
|
435
|
+
| Name | Type | Description | Notes |
|
436
|
+
| ---- | ---- | ----------- | ----- |
|
437
|
+
| **order_id** | **String** | The order id to retrieve. | |
|
438
|
+
| **_expand** | **String** | The object expansion to perform on the result. See OrderApi.getOrder documentation for examples | [optional] |
|
439
|
+
|
440
|
+
### Return type
|
441
|
+
|
442
|
+
[**OrderResponse**](OrderResponse.md)
|
443
|
+
|
444
|
+
### Authorization
|
445
|
+
|
446
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
447
|
+
|
448
|
+
### HTTP request headers
|
449
|
+
|
450
|
+
- **Content-Type**: Not defined
|
451
|
+
- **Accept**: application/json
|
452
|
+
|
453
|
+
|
454
|
+
## get_channel_partner_order_by_channel_partner_order_id
|
455
|
+
|
456
|
+
> <OrderResponse> get_channel_partner_order_by_channel_partner_order_id(order_id, opts)
|
457
|
+
|
458
|
+
Retrieve a channel partner order by the channel partner order id
|
459
|
+
|
460
|
+
Retrieves a single order using the channel partner order id, not the ultracart order id. Only orders belonging to this channel partner may be retrieved.
|
461
|
+
|
462
|
+
### Examples
|
463
|
+
|
464
|
+
```ruby
|
465
|
+
require 'time'
|
466
|
+
require 'ultracart_api'
|
467
|
+
require 'json'
|
468
|
+
require 'yaml'
|
469
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
470
|
+
|
471
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
472
|
+
# As such, this might not be the best way to use this object.
|
473
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
474
|
+
|
475
|
+
api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
476
|
+
order_id = 'order_id_example' # String | The channel partner order id to retrieve.
|
477
|
+
opts = {
|
478
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See OrderApi.getOrder documentation for examples
|
479
|
+
}
|
480
|
+
|
481
|
+
begin
|
482
|
+
# Retrieve a channel partner order by the channel partner order id
|
483
|
+
result = api_instance.get_channel_partner_order_by_channel_partner_order_id(order_id, opts)
|
484
|
+
p result
|
485
|
+
rescue UltracartClient::ApiError => e
|
486
|
+
puts "Error when calling ChannelPartnerApi->get_channel_partner_order_by_channel_partner_order_id: #{e}"
|
487
|
+
end
|
488
|
+
```
|
489
|
+
|
490
|
+
#### Using the get_channel_partner_order_by_channel_partner_order_id_with_http_info variant
|
491
|
+
|
492
|
+
This returns an Array which contains the response data, status code and headers.
|
493
|
+
|
494
|
+
> <Array(<OrderResponse>, Integer, Hash)> get_channel_partner_order_by_channel_partner_order_id_with_http_info(order_id, opts)
|
495
|
+
|
496
|
+
```ruby
|
497
|
+
begin
|
498
|
+
# Retrieve a channel partner order by the channel partner order id
|
499
|
+
data, status_code, headers = api_instance.get_channel_partner_order_by_channel_partner_order_id_with_http_info(order_id, opts)
|
500
|
+
p status_code # => 2xx
|
501
|
+
p headers # => { ... }
|
502
|
+
p data # => <OrderResponse>
|
503
|
+
rescue UltracartClient::ApiError => e
|
504
|
+
puts "Error when calling ChannelPartnerApi->get_channel_partner_order_by_channel_partner_order_id_with_http_info: #{e}"
|
505
|
+
end
|
506
|
+
```
|
507
|
+
|
508
|
+
### Parameters
|
509
|
+
|
510
|
+
| Name | Type | Description | Notes |
|
511
|
+
| ---- | ---- | ----------- | ----- |
|
512
|
+
| **order_id** | **String** | The channel partner order id to retrieve. | |
|
513
|
+
| **_expand** | **String** | The object expansion to perform on the result. See OrderApi.getOrder documentation for examples | [optional] |
|
514
|
+
|
515
|
+
### Return type
|
516
|
+
|
517
|
+
[**OrderResponse**](OrderResponse.md)
|
518
|
+
|
519
|
+
### Authorization
|
520
|
+
|
521
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
522
|
+
|
523
|
+
### HTTP request headers
|
524
|
+
|
525
|
+
- **Content-Type**: Not defined
|
526
|
+
- **Accept**: application/json
|
527
|
+
|
528
|
+
|
376
529
|
## get_channel_partner_ship_to_preference
|
377
530
|
|
378
531
|
> <ChannelPartnerShipToPreferenceResponse> get_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid)
|
@@ -729,6 +882,97 @@ end
|
|
729
882
|
- **Accept**: application/json
|
730
883
|
|
731
884
|
|
885
|
+
## refund_channel_partner_order
|
886
|
+
|
887
|
+
> <OrderResponse> refund_channel_partner_order(order_id, order, opts)
|
888
|
+
|
889
|
+
Refund a channel partner order
|
890
|
+
|
891
|
+
Perform a refund operation on a channel partner order and then update the order if successful. All of the object properties ending in _refunded should be the TOTAL amount that should end up being refunded. UltraCart will calculate the actual amount to refund based upon the prior refunds.
|
892
|
+
|
893
|
+
### Examples
|
894
|
+
|
895
|
+
```ruby
|
896
|
+
require 'time'
|
897
|
+
require 'ultracart_api'
|
898
|
+
require 'json'
|
899
|
+
require 'yaml'
|
900
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
901
|
+
|
902
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
903
|
+
# As such, this might not be the best way to use this object.
|
904
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
905
|
+
|
906
|
+
api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
907
|
+
order_id = 'order_id_example' # String | The order id to refund.
|
908
|
+
order = UltracartClient::Order.new # Order | Order to refund
|
909
|
+
opts = {
|
910
|
+
reject_after_refund: true, # Boolean | Reject order after refund
|
911
|
+
skip_customer_notification: true, # Boolean | Skip customer email notification
|
912
|
+
auto_order_cancel: true, # Boolean | Cancel associated auto orders
|
913
|
+
manual_refund: true, # Boolean | Consider a manual refund done externally
|
914
|
+
reverse_affiliate_transactions: true, # Boolean | Reverse affiliate transactions
|
915
|
+
issue_store_credit: true, # Boolean | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account
|
916
|
+
auto_order_cancel_reason: 'auto_order_cancel_reason_example', # String | Reason for auto orders cancellation
|
917
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples
|
918
|
+
}
|
919
|
+
|
920
|
+
begin
|
921
|
+
# Refund a channel partner order
|
922
|
+
result = api_instance.refund_channel_partner_order(order_id, order, opts)
|
923
|
+
p result
|
924
|
+
rescue UltracartClient::ApiError => e
|
925
|
+
puts "Error when calling ChannelPartnerApi->refund_channel_partner_order: #{e}"
|
926
|
+
end
|
927
|
+
```
|
928
|
+
|
929
|
+
#### Using the refund_channel_partner_order_with_http_info variant
|
930
|
+
|
931
|
+
This returns an Array which contains the response data, status code and headers.
|
932
|
+
|
933
|
+
> <Array(<OrderResponse>, Integer, Hash)> refund_channel_partner_order_with_http_info(order_id, order, opts)
|
934
|
+
|
935
|
+
```ruby
|
936
|
+
begin
|
937
|
+
# Refund a channel partner order
|
938
|
+
data, status_code, headers = api_instance.refund_channel_partner_order_with_http_info(order_id, order, opts)
|
939
|
+
p status_code # => 2xx
|
940
|
+
p headers # => { ... }
|
941
|
+
p data # => <OrderResponse>
|
942
|
+
rescue UltracartClient::ApiError => e
|
943
|
+
puts "Error when calling ChannelPartnerApi->refund_channel_partner_order_with_http_info: #{e}"
|
944
|
+
end
|
945
|
+
```
|
946
|
+
|
947
|
+
### Parameters
|
948
|
+
|
949
|
+
| Name | Type | Description | Notes |
|
950
|
+
| ---- | ---- | ----------- | ----- |
|
951
|
+
| **order_id** | **String** | The order id to refund. | |
|
952
|
+
| **order** | [**Order**](Order.md) | Order to refund | |
|
953
|
+
| **reject_after_refund** | **Boolean** | Reject order after refund | [optional][default to false] |
|
954
|
+
| **skip_customer_notification** | **Boolean** | Skip customer email notification | [optional][default to false] |
|
955
|
+
| **auto_order_cancel** | **Boolean** | Cancel associated auto orders | [optional][default to false] |
|
956
|
+
| **manual_refund** | **Boolean** | Consider a manual refund done externally | [optional][default to false] |
|
957
|
+
| **reverse_affiliate_transactions** | **Boolean** | Reverse affiliate transactions | [optional][default to true] |
|
958
|
+
| **issue_store_credit** | **Boolean** | Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account | [optional][default to false] |
|
959
|
+
| **auto_order_cancel_reason** | **String** | Reason for auto orders cancellation | [optional] |
|
960
|
+
| **_expand** | **String** | The object expansion to perform on the result. See OrderApi.refundOrder documentation for examples | [optional] |
|
961
|
+
|
962
|
+
### Return type
|
963
|
+
|
964
|
+
[**OrderResponse**](OrderResponse.md)
|
965
|
+
|
966
|
+
### Authorization
|
967
|
+
|
968
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
969
|
+
|
970
|
+
### HTTP request headers
|
971
|
+
|
972
|
+
- **Content-Type**: application/json; charset=UTF-8
|
973
|
+
- **Accept**: application/json
|
974
|
+
|
975
|
+
|
732
976
|
## update_channel_partner_ship_to_preference
|
733
977
|
|
734
978
|
> <ChannelPartnerShipToPreferenceResponse> update_channel_partner_ship_to_preference(channel_partner_oid, channel_partner_ship_to_preference_oid, ship_to_preference)
|
data/docs/ChannelPartnerOrder.md
CHANGED
@@ -91,6 +91,7 @@
|
|
91
91
|
| **special_instructions** | **String** | Special instructions from the customer regarding shipping | [optional] |
|
92
92
|
| **store_completed** | **Boolean** | If true the order bypasses shipping and is marked completed | [optional] |
|
93
93
|
| **store_if_payment_declines** | **Boolean** | If true any failed payments are placed into Accounts Receivable. If false any failed payments result in a rejected order resulting in errors thrown during the insert routine | [optional] |
|
94
|
+
| **storefront_host_name** | **String** | StoreFront host name associated with the order | [optional] |
|
94
95
|
| **tax_county** | **String** | The optional shipping county used to determine exact taxes | [optional] |
|
95
96
|
| **tax_exempt** | **Boolean** | If true this order is marked as being tax exempt | [optional] |
|
96
97
|
| **transaction** | [**ChannelPartnerOrderTransaction**](ChannelPartnerOrderTransaction.md) | | [optional] |
|
@@ -189,6 +190,7 @@ instance = UltracartClient::ChannelPartnerOrder.new(
|
|
189
190
|
special_instructions: null,
|
190
191
|
store_completed: null,
|
191
192
|
store_if_payment_declines: null,
|
193
|
+
storefront_host_name: null,
|
192
194
|
tax_county: null,
|
193
195
|
tax_exempt: null,
|
194
196
|
transaction: null,
|
data/docs/CustomerAttachment.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **customer_profile_attachment_oid** | **Integer** | Attachment identifier | [optional] |
|
8
8
|
| **description** | **String** | Description | [optional] |
|
9
9
|
| **file_name** | **String** | File name | [optional] |
|
10
|
-
| **mime_type** | **String** | Mime
|
10
|
+
| **mime_type** | **String** | Mime type | [optional] |
|
11
11
|
| **upload_dts** | **String** | Upload date/time | [optional] |
|
12
12
|
|
13
13
|
## Example
|
data/docs/CustomerQuery.md
CHANGED
@@ -16,6 +16,7 @@
|
|
16
16
|
| **billing_postal_code** | **String** | Billing postal code | [optional] |
|
17
17
|
| **billing_state** | **String** | Billing state | [optional] |
|
18
18
|
| **email** | **String** | Email address of this customer profile | [optional] |
|
19
|
+
| **emails** | **Array<String>** | Emails allows for searching on multiple email addresses and work with our without the single email variable. You may specify a single email address here or use the email property. | [optional] |
|
19
20
|
| **last_modified_dts_end** | **String** | Last modified date end | [optional] |
|
20
21
|
| **last_modified_dts_start** | **String** | Last modified date start | [optional] |
|
21
22
|
| **pricing_tier_name** | **String** | Pricing tier name | [optional] |
|
@@ -52,6 +53,7 @@ instance = UltracartClient::CustomerQuery.new(
|
|
52
53
|
billing_postal_code: null,
|
53
54
|
billing_state: null,
|
54
55
|
email: null,
|
56
|
+
emails: null,
|
55
57
|
last_modified_dts_end: null,
|
56
58
|
last_modified_dts_start: null,
|
57
59
|
pricing_tier_name: null,
|
data/docs/ItemReview.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **featured** | **Boolean** | | [optional] |
|
9
9
|
| **helperful_no_votes** | **Integer** | | [optional] |
|
10
10
|
| **helpful_yes_votes** | **Integer** | | [optional] |
|
11
|
+
| **merchant_reply** | **String** | Merchant Reply (set to an empty string to remove) | [optional] |
|
11
12
|
| **order_id** | **String** | | [optional] |
|
12
13
|
| **overall** | **Float** | | [optional] |
|
13
14
|
| **rating_name1** | **String** | Rating Name 1 | [optional] |
|
@@ -52,6 +53,7 @@ instance = UltracartClient::ItemReview.new(
|
|
52
53
|
featured: null,
|
53
54
|
helperful_no_votes: null,
|
54
55
|
helpful_yes_votes: null,
|
56
|
+
merchant_reply: null,
|
55
57
|
order_id: null,
|
56
58
|
overall: null,
|
57
59
|
rating_name1: null,
|
data/docs/Order.md
CHANGED
@@ -14,6 +14,7 @@
|
|
14
14
|
| **creation_dts** | **String** | Date/time that the order was created | [optional] |
|
15
15
|
| **currency_code** | **String** | Currency code that the customer used if different than the merchant's base currency code | [optional] |
|
16
16
|
| **current_stage** | **String** | Current stage that the order is in. | [optional] |
|
17
|
+
| **current_stage_histories** | [**Array<OrderCurrentStageHistory>**](OrderCurrentStageHistory.md) | History of the changes to the current_stage field | [optional] |
|
17
18
|
| **customer_profile** | [**Customer**](Customer.md) | | [optional] |
|
18
19
|
| **digital_order** | [**OrderDigitalOrder**](OrderDigitalOrder.md) | | [optional] |
|
19
20
|
| **edi** | [**OrderEdi**](OrderEdi.md) | | [optional] |
|
@@ -59,6 +60,7 @@ instance = UltracartClient::Order.new(
|
|
59
60
|
creation_dts: null,
|
60
61
|
currency_code: null,
|
61
62
|
current_stage: null,
|
63
|
+
current_stage_histories: null,
|
62
64
|
customer_profile: null,
|
63
65
|
digital_order: null,
|
64
66
|
edi: null,
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# UltracartClient::OrderCurrentStageHistory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **after_stage** | **String** | New stage that the order is in. | [optional] |
|
8
|
+
| **before_stage** | **String** | Previous stage that the order was in. | [optional] |
|
9
|
+
| **transition_dts** | **String** | Date/time that the stage transitioned | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'ultracart_api'
|
15
|
+
|
16
|
+
instance = UltracartClient::OrderCurrentStageHistory.new(
|
17
|
+
after_stage: null,
|
18
|
+
before_stage: null,
|
19
|
+
transition_dts: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
data/docs/OrderItem.md
CHANGED
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **accounting_code** | **String** | QuickBooks code | [optional] |
|
8
8
|
| **activation_codes** | **Array<String>** | Activation codes assigned to this item | [optional] |
|
9
|
+
| **actual_cogs** | [**Currency**](Currency.md) | | [optional] |
|
9
10
|
| **arbitrary_unit_cost** | [**Currency**](Currency.md) | | [optional] |
|
10
11
|
| **auto_order_last_rebill_dts** | **String** | Date/time of the last rebill, used only during order insert to help project future rebills | [optional] |
|
11
12
|
| **auto_order_schedule** | **String** | Auto order schedule, used only during inserts supplying the recurring schedule | [optional] |
|
@@ -78,6 +79,7 @@ require 'ultracart_api'
|
|
78
79
|
instance = UltracartClient::OrderItem.new(
|
79
80
|
accounting_code: null,
|
80
81
|
activation_codes: null,
|
82
|
+
actual_cogs: null,
|
81
83
|
arbitrary_unit_cost: null,
|
82
84
|
auto_order_last_rebill_dts: null,
|
83
85
|
auto_order_schedule: null,
|
data/docs/OrderSummary.md
CHANGED
@@ -5,7 +5,11 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **actual_fulfillment** | [**Currency**](Currency.md) | | [optional] |
|
8
|
+
| **actual_other_cost** | [**Currency**](Currency.md) | | [optional] |
|
8
9
|
| **actual_payment_processing** | [**Currency**](Currency.md) | | [optional] |
|
10
|
+
| **actual_profit** | [**Currency**](Currency.md) | | [optional] |
|
11
|
+
| **actual_profit_analyzed** | **Boolean** | Actual profit has been analyzed | [optional] |
|
12
|
+
| **actual_profit_review** | **Boolean** | Actual profit needs review | [optional] |
|
9
13
|
| **actual_shipping** | [**Currency**](Currency.md) | | [optional] |
|
10
14
|
| **arbitrary_shipping_handling_total** | [**Currency**](Currency.md) | | [optional] |
|
11
15
|
| **health_benefit_card_amount** | [**Currency**](Currency.md) | | [optional] |
|
@@ -34,7 +38,11 @@ require 'ultracart_api'
|
|
34
38
|
|
35
39
|
instance = UltracartClient::OrderSummary.new(
|
36
40
|
actual_fulfillment: null,
|
41
|
+
actual_other_cost: null,
|
37
42
|
actual_payment_processing: null,
|
43
|
+
actual_profit: null,
|
44
|
+
actual_profit_analyzed: null,
|
45
|
+
actual_profit_review: null,
|
38
46
|
actual_shipping: null,
|
39
47
|
arbitrary_shipping_handling_total: null,
|
40
48
|
health_benefit_card_amount: null,
|