ultracart_api 3.9.8 → 3.10.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +22 -4
- data/docs/CartSettingsShippingEstimate.md +1 -0
- data/docs/ChannelPartnerApi.md +212 -0
- data/docs/ChannelPartnerCancelResponse.md +12 -0
- data/docs/ChannelPartnerEstimateShippingResponse.md +12 -0
- data/docs/ChannelPartnerImportResponse.md +14 -0
- data/docs/ChannelPartnerOrder.md +87 -0
- data/docs/ChannelPartnerOrderItem.md +14 -0
- data/docs/ChannelPartnerOrderItemOption.md +9 -0
- data/docs/ChannelPartnerOrderTransaction.md +9 -0
- data/docs/ChannelPartnerOrderTransactionDetail.md +9 -0
- data/docs/ChannelPartnerShippingEstimate.md +9 -0
- data/lib/ultracart_api/api/channel_partner_api.rb +256 -0
- data/lib/ultracart_api/models/cart_settings_shipping_estimate.rb +11 -1
- data/lib/ultracart_api/models/channel_partner_cancel_response.rb +224 -0
- data/lib/ultracart_api/models/channel_partner_estimate_shipping_response.rb +224 -0
- data/lib/ultracart_api/models/channel_partner_import_response.rb +246 -0
- data/lib/ultracart_api/models/channel_partner_order.rb +1569 -0
- data/lib/ultracart_api/models/channel_partner_order_item.rb +296 -0
- data/lib/ultracart_api/models/channel_partner_order_item_option.rb +195 -0
- data/lib/ultracart_api/models/channel_partner_order_transaction.rb +197 -0
- data/lib/ultracart_api/models/channel_partner_order_transaction_detail.rb +195 -0
- data/lib/ultracart_api/models/channel_partner_shipping_estimate.rb +195 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +10 -0
- metadata +22 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 34bbd70216e98daa2209f4b2cf85de0e9034482f9bc65ff00488f10435e72933
|
4
|
+
data.tar.gz: 36e28b94f0fde952b86e0e19e3f08831642fcb400a44affbe34ae06a4aa2b472
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 40d48c0b1c0eea36f2dc5306aad00d997e4512be13fbe3474eaf019e018aa032dacf09aa77585639abcce0601f97201a645ae00e427a91d83f003e60810a9c83
|
7
|
+
data.tar.gz: c9cfe04c91bf887846eb29ecc3daff4ee461393f69366bf3d2b3b62b11e9e72a6e4dcbb3100bdd6be8981ac2dd78356e06b3adf01640a5ae692ebe617216af40
|
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
|
+
- Package version: 3.10.2
|
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.
|
27
|
+
gem install ./ultracart_api-3.10.2.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.2.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.
|
35
|
+
gem 'ultracart_api', '~> 3.10.2'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -96,6 +96,10 @@ Class | Method | HTTP request | Description
|
|
96
96
|
*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
|
97
97
|
*UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
|
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
|
+
*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
|
+
*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* | [**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
|
+
*UltracartClient::ChannelPartnerApi* | [**import_channel_partner_order**](docs/ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
|
99
103
|
*UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
|
100
104
|
*UltracartClient::ChargebackApi* | [**get_chargeback_dispute**](docs/ChargebackApi.md#get_chargeback_dispute) | **GET** /chargeback/chargebacks/{chargeback_dispute_oid} | Retrieve a chargeback
|
101
105
|
*UltracartClient::ChargebackApi* | [**get_chargeback_disputes**](docs/ChargebackApi.md#get_chargeback_disputes) | **GET** /chargeback/chargebacks | Retrieve chargebacks
|
@@ -532,6 +536,15 @@ Class | Method | HTTP request | Description
|
|
532
536
|
- [UltracartClient::CartUpsellAfter](docs/CartUpsellAfter.md)
|
533
537
|
- [UltracartClient::CartValidationRequest](docs/CartValidationRequest.md)
|
534
538
|
- [UltracartClient::CartValidationResponse](docs/CartValidationResponse.md)
|
539
|
+
- [UltracartClient::ChannelPartnerCancelResponse](docs/ChannelPartnerCancelResponse.md)
|
540
|
+
- [UltracartClient::ChannelPartnerEstimateShippingResponse](docs/ChannelPartnerEstimateShippingResponse.md)
|
541
|
+
- [UltracartClient::ChannelPartnerImportResponse](docs/ChannelPartnerImportResponse.md)
|
542
|
+
- [UltracartClient::ChannelPartnerOrder](docs/ChannelPartnerOrder.md)
|
543
|
+
- [UltracartClient::ChannelPartnerOrderItem](docs/ChannelPartnerOrderItem.md)
|
544
|
+
- [UltracartClient::ChannelPartnerOrderItemOption](docs/ChannelPartnerOrderItemOption.md)
|
545
|
+
- [UltracartClient::ChannelPartnerOrderTransaction](docs/ChannelPartnerOrderTransaction.md)
|
546
|
+
- [UltracartClient::ChannelPartnerOrderTransactionDetail](docs/ChannelPartnerOrderTransactionDetail.md)
|
547
|
+
- [UltracartClient::ChannelPartnerShippingEstimate](docs/ChannelPartnerShippingEstimate.md)
|
535
548
|
- [UltracartClient::ChargebackDispute](docs/ChargebackDispute.md)
|
536
549
|
- [UltracartClient::ChargebackDisputeResponse](docs/ChargebackDisputeResponse.md)
|
537
550
|
- [UltracartClient::ChargebackDisputesResponse](docs/ChargebackDisputesResponse.md)
|
@@ -1113,6 +1126,8 @@ Class | Method | HTTP request | Description
|
|
1113
1126
|
- auto_order_write: Allows you to write auto order information.
|
1114
1127
|
- chargeback_read: Allows you to read chargeback information.
|
1115
1128
|
- chargeback_write: Allows you to write chargeback information.
|
1129
|
+
- channel_partner_read: Allows you to read channel partner information.
|
1130
|
+
- channel_partner_write: Allows you to write channel partner information.
|
1116
1131
|
- checkout_read: Allows you to read checkout information.
|
1117
1132
|
- checkout_write: Allows you to write checkout information.
|
1118
1133
|
- configuration_read: Allows you to read configuration information.
|
@@ -1156,6 +1171,9 @@ Not every change is committed to every SDK.
|
|
1156
1171
|
|
1157
1172
|
| Version | Date | Comments |
|
1158
1173
|
| --: | :-: | --- |
|
1174
|
+
| 3.10.2 | 05/12/2022 | ChannelPartnerApi renamed one of the delete methods |
|
1175
|
+
| 3.10.1 | 05/12/2022 | ChannelPartnerApi added orderId to import response obj |
|
1176
|
+
| 3.10.0 | 05/10/2022 | beta release of ChannelPartnerApi |
|
1159
1177
|
| 3.9.8 | 04/26/2022 | OrderApi.duplicateOrder |
|
1160
1178
|
| 3.9.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
|
1161
1179
|
| 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
14
14
|
**estimated_delivery** | **String** | Date of the estimated delivery (or range) | [optional]
|
15
15
|
**lift_gate_option** | **BOOLEAN** | True if a lift gate option for this method should be offered to the customer | [optional]
|
16
16
|
**name** | **String** | Shipping method name | [optional]
|
17
|
+
**pickup** | **BOOLEAN** | True if this shipping method requires customers to physically pickup product themselves | [optional]
|
17
18
|
**tax** | [**Currency**](Currency.md) | | [optional]
|
18
19
|
**total_tax** | [**Currency**](Currency.md) | | [optional]
|
19
20
|
|
@@ -0,0 +1,212 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
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
|
+
[**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
|
+
[**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
|
+
[**import_channel_partner_order**](ChannelPartnerApi.md#import_channel_partner_order) | **POST** /channel_partner/import | Insert channel partner order
|
11
|
+
|
12
|
+
|
13
|
+
# **cancel_order_by_channel_partner_order_id**
|
14
|
+
> ChannelPartnerCancelResponse cancel_order_by_channel_partner_order_id(order_id)
|
15
|
+
|
16
|
+
Cancel channel partner order by channel partner order id
|
17
|
+
|
18
|
+
Cancel channel partner order by channel partner order id
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'ultracart_api'
|
24
|
+
|
25
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
26
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
27
|
+
api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
|
28
|
+
|
29
|
+
|
30
|
+
order_id = 'order_id_example' # String | The channel partner order id to delete.
|
31
|
+
|
32
|
+
|
33
|
+
begin
|
34
|
+
#Cancel channel partner order by channel partner order id
|
35
|
+
result = api_instance.cancel_order_by_channel_partner_order_id(order_id)
|
36
|
+
p result
|
37
|
+
rescue UltracartClient::ApiError => e
|
38
|
+
puts "Exception when calling ChannelPartnerApi->cancel_order_by_channel_partner_order_id: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
Name | Type | Description | Notes
|
45
|
+
------------- | ------------- | ------------- | -------------
|
46
|
+
**order_id** | **String**| The channel partner order id to delete. |
|
47
|
+
|
48
|
+
### Return type
|
49
|
+
|
50
|
+
[**ChannelPartnerCancelResponse**](ChannelPartnerCancelResponse.md)
|
51
|
+
|
52
|
+
### Authorization
|
53
|
+
|
54
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
55
|
+
|
56
|
+
### HTTP request headers
|
57
|
+
|
58
|
+
- **Content-Type**: application/json; charset=UTF-8
|
59
|
+
- **Accept**: application/json
|
60
|
+
|
61
|
+
|
62
|
+
|
63
|
+
# **cancel_order_by_ultra_cart_order_id**
|
64
|
+
> ChannelPartnerCancelResponse cancel_order_by_ultra_cart_order_id(order_id)
|
65
|
+
|
66
|
+
Cancel channel partner order by UltraCart order id
|
67
|
+
|
68
|
+
Cancel channel partner order by UltraCart order id
|
69
|
+
|
70
|
+
### Example
|
71
|
+
```ruby
|
72
|
+
# load the gem
|
73
|
+
require 'ultracart_api'
|
74
|
+
|
75
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
76
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
77
|
+
api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
|
78
|
+
|
79
|
+
|
80
|
+
order_id = 'order_id_example' # String | The UltraCart order id to delete.
|
81
|
+
|
82
|
+
|
83
|
+
begin
|
84
|
+
#Cancel channel partner order by UltraCart order id
|
85
|
+
result = api_instance.cancel_order_by_ultra_cart_order_id(order_id)
|
86
|
+
p result
|
87
|
+
rescue UltracartClient::ApiError => e
|
88
|
+
puts "Exception when calling ChannelPartnerApi->cancel_order_by_ultra_cart_order_id: #{e}"
|
89
|
+
end
|
90
|
+
```
|
91
|
+
|
92
|
+
### Parameters
|
93
|
+
|
94
|
+
Name | Type | Description | Notes
|
95
|
+
------------- | ------------- | ------------- | -------------
|
96
|
+
**order_id** | **String**| The UltraCart order id to delete. |
|
97
|
+
|
98
|
+
### Return type
|
99
|
+
|
100
|
+
[**ChannelPartnerCancelResponse**](ChannelPartnerCancelResponse.md)
|
101
|
+
|
102
|
+
### Authorization
|
103
|
+
|
104
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
105
|
+
|
106
|
+
### HTTP request headers
|
107
|
+
|
108
|
+
- **Content-Type**: application/json; charset=UTF-8
|
109
|
+
- **Accept**: application/json
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
# **estimate_shipping_for_channel_partner_order**
|
114
|
+
> ChannelPartnerEstimateShippingResponse estimate_shipping_for_channel_partner_order(channel_partner_order)
|
115
|
+
|
116
|
+
Estimate shipping for channel partner order
|
117
|
+
|
118
|
+
Estimate shipping for order from a channel partner.
|
119
|
+
|
120
|
+
### Example
|
121
|
+
```ruby
|
122
|
+
# load the gem
|
123
|
+
require 'ultracart_api'
|
124
|
+
|
125
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
126
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
127
|
+
api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
|
128
|
+
|
129
|
+
|
130
|
+
channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order needing shipping estimate
|
131
|
+
|
132
|
+
|
133
|
+
begin
|
134
|
+
#Estimate shipping for channel partner order
|
135
|
+
result = api_instance.estimate_shipping_for_channel_partner_order(channel_partner_order)
|
136
|
+
p result
|
137
|
+
rescue UltracartClient::ApiError => e
|
138
|
+
puts "Exception when calling ChannelPartnerApi->estimate_shipping_for_channel_partner_order: #{e}"
|
139
|
+
end
|
140
|
+
```
|
141
|
+
|
142
|
+
### Parameters
|
143
|
+
|
144
|
+
Name | Type | Description | Notes
|
145
|
+
------------- | ------------- | ------------- | -------------
|
146
|
+
**channel_partner_order** | [**ChannelPartnerOrder**](ChannelPartnerOrder.md)| Order needing shipping estimate |
|
147
|
+
|
148
|
+
### Return type
|
149
|
+
|
150
|
+
[**ChannelPartnerEstimateShippingResponse**](ChannelPartnerEstimateShippingResponse.md)
|
151
|
+
|
152
|
+
### Authorization
|
153
|
+
|
154
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
155
|
+
|
156
|
+
### HTTP request headers
|
157
|
+
|
158
|
+
- **Content-Type**: application/json; charset=UTF-8
|
159
|
+
- **Accept**: application/json
|
160
|
+
|
161
|
+
|
162
|
+
|
163
|
+
# **import_channel_partner_order**
|
164
|
+
> ChannelPartnerImportResponse import_channel_partner_order(channel_partner_order)
|
165
|
+
|
166
|
+
Insert channel partner order
|
167
|
+
|
168
|
+
Insert order from a channel partner.
|
169
|
+
|
170
|
+
### Example
|
171
|
+
```ruby
|
172
|
+
# load the gem
|
173
|
+
require 'ultracart_api'
|
174
|
+
|
175
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
176
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
177
|
+
api_instance = UltracartClient::ChannelPartnerApi.new_using_api_key(simple_key, false, false)
|
178
|
+
|
179
|
+
|
180
|
+
channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order to insert
|
181
|
+
|
182
|
+
|
183
|
+
begin
|
184
|
+
#Insert channel partner order
|
185
|
+
result = api_instance.import_channel_partner_order(channel_partner_order)
|
186
|
+
p result
|
187
|
+
rescue UltracartClient::ApiError => e
|
188
|
+
puts "Exception when calling ChannelPartnerApi->import_channel_partner_order: #{e}"
|
189
|
+
end
|
190
|
+
```
|
191
|
+
|
192
|
+
### Parameters
|
193
|
+
|
194
|
+
Name | Type | Description | Notes
|
195
|
+
------------- | ------------- | ------------- | -------------
|
196
|
+
**channel_partner_order** | [**ChannelPartnerOrder**](ChannelPartnerOrder.md)| Order to insert |
|
197
|
+
|
198
|
+
### Return type
|
199
|
+
|
200
|
+
[**ChannelPartnerImportResponse**](ChannelPartnerImportResponse.md)
|
201
|
+
|
202
|
+
### Authorization
|
203
|
+
|
204
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
205
|
+
|
206
|
+
### HTTP request headers
|
207
|
+
|
208
|
+
- **Content-Type**: application/json; charset=UTF-8
|
209
|
+
- **Accept**: application/json
|
210
|
+
|
211
|
+
|
212
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerCancelResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**cancel_errors** | **Array<String>** | Array of errors if errors occurred | [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
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerEstimateShippingResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**estimates** | [**Array<ChannelPartnerShippingEstimate>**](ChannelPartnerShippingEstimate.md) | An array of shipping methods and their costs | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerImportResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**import_errors** | **Array<String>** | Array of errors if errors occurred | [optional]
|
8
|
+
**import_warnings** | **Array<String>** | Array of warnings if warnings occurred | [optional]
|
9
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
10
|
+
**order_id** | **String** | The order id of the newly imported order if successful | [optional]
|
11
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
12
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,87 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerOrder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**advertising_source** | **String** | advertising_source | [optional]
|
7
|
+
**affiliate_id** | **String** | Affiliate Id | [optional]
|
8
|
+
**affiliate_sub_id** | **String** | Affiliate Sub Id | [optional]
|
9
|
+
**arbitrary_shipping_handling_total** | **Float** | Arbitrary shipping handling total | [optional]
|
10
|
+
**arbitrary_tax** | **Float** | Arbitrary tax for overriding calculated taxes | [optional]
|
11
|
+
**arbitrary_tax_rate** | **Float** | Arbitrary tax rate | [optional]
|
12
|
+
**arbitrary_taxable_subtotal** | **Float** | Arbitrary taxable subtotal | [optional]
|
13
|
+
**associate_with_customer_profile_if_present** | **BOOLEAN** | If true any matching customer profile based on email is associated with this order | [optional]
|
14
|
+
**auto_approve_purchase_order** | **BOOLEAN** | If true any purchase orders are automatically approved | [optional]
|
15
|
+
**billto_address1** | **String** | Billing Address line 1 | [optional]
|
16
|
+
**billto_address2** | **String** | Billing Address line 2 | [optional]
|
17
|
+
**billto_city** | **String** | Billing City | [optional]
|
18
|
+
**billto_company** | **String** | Billing Company | [optional]
|
19
|
+
**billto_country_code** | **String** | Billing ISO-3166 two letter country code | [optional]
|
20
|
+
**billto_day_phone** | **String** | Billing Day phone | [optional]
|
21
|
+
**billto_evening_phone** | **String** | Billing Evening phone | [optional]
|
22
|
+
**billto_first_name** | **String** | Billing First name | [optional]
|
23
|
+
**billto_last_name** | **String** | Billing Last name | [optional]
|
24
|
+
**billto_postal_code** | **String** | Billing Postal code | [optional]
|
25
|
+
**billto_state_region** | **String** | Billing State for United States otherwise region or province for other countries | [optional]
|
26
|
+
**billto_title** | **String** | Billing Title | [optional]
|
27
|
+
**cc_email** | **String** | CC email. | [optional]
|
28
|
+
**channel_partner_order_id** | **String** | The id for this order within the channel partner system. | [optional]
|
29
|
+
**consider_recurring** | **BOOLEAN** | If true this order is marked as an auto order (recurring) | [optional]
|
30
|
+
**coupons** | **Array<String>** | Array of coupon codes | [optional]
|
31
|
+
**credit_card_authorization_amount** | **Float** | The amount authorized externally | [optional]
|
32
|
+
**credit_card_authorization_dts** | **String** | Date/Time of credit card authorization in ISO8601 format | [optional]
|
33
|
+
**credit_card_authorization_number** | **String** | The reference number provided by an externally processed transaction | [optional]
|
34
|
+
**credit_card_expiration_month** | **Integer** | Credit card expiration month | [optional]
|
35
|
+
**credit_card_expiration_year** | **Integer** | Credit card expiration year | [optional]
|
36
|
+
**credit_card_type** | **String** | Credit card type | [optional]
|
37
|
+
**custom_field1** | **String** | Custom field 1 | [optional]
|
38
|
+
**custom_field2** | **String** | Custom field 2 | [optional]
|
39
|
+
**custom_field3** | **String** | Custom field 3 | [optional]
|
40
|
+
**custom_field4** | **String** | Custom field 4 | [optional]
|
41
|
+
**custom_field5** | **String** | Custom field 5 | [optional]
|
42
|
+
**custom_field6** | **String** | Custom field 6 | [optional]
|
43
|
+
**custom_field7** | **String** | Custom field 7 | [optional]
|
44
|
+
**delivery_date** | **String** | Date the customer is requesting delivery on. Typically used for perishable product delivery. | [optional]
|
45
|
+
**email** | **String** | Email | [optional]
|
46
|
+
**gift** | **BOOLEAN** | True if this order is a gift | [optional]
|
47
|
+
**gift_email** | **String** | Email address of the gift recipient | [optional]
|
48
|
+
**gift_message** | **String** | Message to the gift recipient | [optional]
|
49
|
+
**hosted_fields_card_token** | **String** | The token provided by UltraCart hosted fields when a credit card number is uploaded into the system. This is the only way to provide a credit card number. | [optional]
|
50
|
+
**hosted_fields_cvv_token** | **String** | The token provided by UltraCart hosted fields when a credit card cvv is uploaded into the system. This is the only way to provide a cvv number. | [optional]
|
51
|
+
**insurance_application_id** | **String** | Insurance application id | [optional]
|
52
|
+
**insurance_claim_id** | **String** | Insurance claim id | [optional]
|
53
|
+
**ip_address** | **String** | IP Address of the customer | [optional]
|
54
|
+
**items** | [**Array<ChannelPartnerOrderItem>**](ChannelPartnerOrderItem.md) | Items | [optional]
|
55
|
+
**least_cost_route** | **BOOLEAN** | If true the least expensive shipping method is automatically chosen during the order import | [optional]
|
56
|
+
**least_cost_route_shipping_methods** | **Array<String>** | An optional array of shipping methods to restict choices if least_cost_route is true | [optional]
|
57
|
+
**mailing_list_opt_in** | **BOOLEAN** | If true the customer is subscribed to any configured mailing lists | [optional]
|
58
|
+
**no_realtime_payment_processing** | **BOOLEAN** | If true no payment processing is done and the order is placed into Accounts Receivable | [optional]
|
59
|
+
**payment_method** | **String** | Payment method | [optional]
|
60
|
+
**purchase_order_number** | **String** | Purchase order number | [optional]
|
61
|
+
**rotating_transaction_gateway_code** | **String** | The rotating transaction gateway code for the gateway used to charge this order | [optional]
|
62
|
+
**screen_branding_theme_code** | **String** | Screen branding theme code | [optional]
|
63
|
+
**ship_on_date** | **String** | Date the customer is requesting that the order ship on. Typically used for perishable product delivery. | [optional]
|
64
|
+
**ship_to_residential** | **BOOLEAN** | True if the shipping adress is residential. Effects the methods that are available to the customer as well as the price of the shipping method. | [optional]
|
65
|
+
**shipping_method** | **String** | Shipping method | [optional]
|
66
|
+
**shipto_address1** | **String** | Shipping Address line 1 | [optional]
|
67
|
+
**shipto_address2** | **String** | Shipping Address line 2 | [optional]
|
68
|
+
**shipto_city** | **String** | Shipping City | [optional]
|
69
|
+
**shipto_company** | **String** | Shipping Company | [optional]
|
70
|
+
**shipto_country_code** | **String** | Shipping ISO-3166 two letter country code | [optional]
|
71
|
+
**shipto_day_phone** | **String** | Shipping Day phone | [optional]
|
72
|
+
**shipto_evening_phone** | **String** | Shipping Evening phone | [optional]
|
73
|
+
**shipto_first_name** | **String** | Shipping First name | [optional]
|
74
|
+
**shipto_last_name** | **String** | Shipping Last name | [optional]
|
75
|
+
**shipto_postal_code** | **String** | Shipping Postal code | [optional]
|
76
|
+
**shipto_state_region** | **String** | Shipping State for United States otherwise region or province for other countries | [optional]
|
77
|
+
**shipto_title** | **String** | Shipping Title | [optional]
|
78
|
+
**skip_payment_processing** | **BOOLEAN** | If true the order is placed directly into the shipping department | [optional]
|
79
|
+
**special_instructions** | **String** | Special instructions from the customer regarding shipping | [optional]
|
80
|
+
**store_completed** | **BOOLEAN** | If true the order bypasses shipping and is marked completed | [optional]
|
81
|
+
**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]
|
82
|
+
**tax_county** | **String** | The optional shipping county used to determine exact taxes | [optional]
|
83
|
+
**tax_exempt** | **BOOLEAN** | If true this order is marked as being tax exempt | [optional]
|
84
|
+
**transaction** | [**ChannelPartnerOrderTransaction**](ChannelPartnerOrderTransaction.md) | | [optional]
|
85
|
+
**treat_warnings_as_errors** | **BOOLEAN** | If true all warnings are considered errors, this is true by default | [optional]
|
86
|
+
|
87
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerOrderItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**arbitrary_unit_cost** | **Float** | Arbitrary unit cost for this item that differs from the listed price | [optional]
|
7
|
+
**auto_order_last_rebill_dts** | **String** | Optional date/time of the last rebill if this item is part of an auto (recurring) order | [optional]
|
8
|
+
**auto_order_schedule** | **String** | The frequency schedule for this item if this item is part of an auto (recurring) order | [optional]
|
9
|
+
**merchant_item_id** | **String** | Item ID | [optional]
|
10
|
+
**options** | [**Array<ChannelPartnerOrderItemOption>**](ChannelPartnerOrderItemOption.md) | Item options | [optional]
|
11
|
+
**quantity** | **Float** | Quantity | [optional]
|
12
|
+
**upsell** | **BOOLEAN** | True if this item was an upsell item. | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerOrderItemOption
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | The name of the item option. | [optional]
|
7
|
+
**value** | **String** | The value of the item option. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerOrderTransaction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**details** | [**Array<ChannelPartnerOrderTransactionDetail>**](ChannelPartnerOrderTransactionDetail.md) | Transaction gateway details | [optional]
|
7
|
+
**successful** | **BOOLEAN** | True if the transaction was successfully charged | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerOrderTransactionDetail
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | The name of the item option. | [optional]
|
7
|
+
**value** | **String** | The value of the item option. | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# UltracartClient::ChannelPartnerShippingEstimate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**shipping_handling_total** | **Float** | The total estimate for this shipping method based on the provided order. | [optional]
|
7
|
+
**shipping_method** | **String** | The name of the shipping method | [optional]
|
8
|
+
|
9
|
+
|