ultracart_api 3.0.76 → 3.1.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +23 -18
- data/docs/AffiliateApi.md +8 -22
- data/docs/AutoOrderApi.md +44 -100
- data/docs/ChargebackApi.md +20 -55
- data/docs/CheckoutApi.md +78 -295
- data/docs/CouponApi.md +80 -211
- data/docs/CouponTieredAmountOffItem.md +1 -1
- data/docs/CouponTieredPercentOffItems.md +1 -1
- data/docs/CustomerApi.md +199 -110
- data/docs/EmailPlanAdditional.md +1 -0
- data/docs/EmailVerifyTokenRequest.md +9 -0
- data/docs/EmailVerifyTokenResponse.md +12 -0
- data/docs/EmailVerifyTokenValidateRequest.md +8 -0
- data/docs/EmailVerifyTokenValidateResponse.md +11 -0
- data/docs/FulfillmentApi.md +21 -55
- data/docs/ItemApi.md +36 -99
- data/docs/OauthApi.md +8 -32
- data/docs/OrderApi.md +84 -223
- data/docs/ScreenRecording.md +2 -1
- data/docs/StorefrontApi.md +429 -2077
- data/docs/TaxApi.md +121 -308
- data/docs/UserApi.md +46 -121
- data/docs/WebhookApi.md +32 -88
- data/lib/ultracart_api.rb +4 -0
- data/lib/ultracart_api/api/affiliate_api.rb +13 -0
- data/lib/ultracart_api/api/auto_order_api.rb +21 -8
- data/lib/ultracart_api/api/chargeback_api.rb +13 -0
- data/lib/ultracart_api/api/checkout_api.rb +15 -2
- data/lib/ultracart_api/api/coupon_api.rb +15 -2
- data/lib/ultracart_api/api/customer_api.rb +181 -0
- data/lib/ultracart_api/api/fulfillment_api.rb +13 -0
- data/lib/ultracart_api/api/item_api.rb +13 -0
- data/lib/ultracart_api/api/oauth_api.rb +13 -0
- data/lib/ultracart_api/api/order_api.rb +15 -2
- data/lib/ultracart_api/api/storefront_api.rb +13 -0
- data/lib/ultracart_api/api/tax_api.rb +13 -0
- data/lib/ultracart_api/api/user_api.rb +13 -0
- data/lib/ultracart_api/api/webhook_api.rb +13 -0
- data/lib/ultracart_api/models/coupon_tiered_amount_off_item.rb +1 -1
- data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +1 -1
- data/lib/ultracart_api/models/email_plan_additional.rb +10 -1
- data/lib/ultracart_api/models/email_verify_token_request.rb +195 -0
- data/lib/ultracart_api/models/email_verify_token_response.rb +222 -0
- data/lib/ultracart_api/models/email_verify_token_validate_request.rb +185 -0
- data/lib/ultracart_api/models/email_verify_token_validate_response.rb +212 -0
- data/lib/ultracart_api/models/screen_recording.rb +12 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +10 -2
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::EmailVerifyTokenValidateResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
10
|
+
|
11
|
+
|
data/docs/FulfillmentApi.md
CHANGED
@@ -22,18 +22,11 @@ Acknowledge receipt of orders so that they are removed from the fulfillment queu
|
|
22
22
|
```ruby
|
23
23
|
# load the gem
|
24
24
|
require 'ultracart_api'
|
25
|
-
# setup authorization
|
26
|
-
UltracartClient.configure do |config|
|
27
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
28
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
29
|
-
|
30
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
31
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
32
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
33
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
34
|
-
end
|
35
25
|
|
36
|
-
|
26
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
27
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
28
|
+
api_instance = UltracartClient::FulfillmentApi.new_using_api_key(simple_key, false, false)
|
29
|
+
|
37
30
|
|
38
31
|
distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
|
39
32
|
|
@@ -81,18 +74,11 @@ Retrieves up to 100 orders that are queued up in this distribution center. You
|
|
81
74
|
```ruby
|
82
75
|
# load the gem
|
83
76
|
require 'ultracart_api'
|
84
|
-
# setup authorization
|
85
|
-
UltracartClient.configure do |config|
|
86
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
87
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
88
|
-
|
89
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
90
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
91
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
92
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
93
|
-
end
|
94
77
|
|
95
|
-
|
78
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
79
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
80
|
+
api_instance = UltracartClient::FulfillmentApi.new_using_api_key(simple_key, false, false)
|
81
|
+
|
96
82
|
|
97
83
|
distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
|
98
84
|
|
@@ -138,18 +124,12 @@ Retrieves the distribution centers that this user has access to.
|
|
138
124
|
```ruby
|
139
125
|
# load the gem
|
140
126
|
require 'ultracart_api'
|
141
|
-
# setup authorization
|
142
|
-
UltracartClient.configure do |config|
|
143
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
144
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
145
|
-
|
146
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
147
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
148
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
149
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
150
|
-
end
|
151
127
|
|
152
|
-
|
128
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
129
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
130
|
+
api_instance = UltracartClient::FulfillmentApi.new_using_api_key(simple_key, false, false)
|
131
|
+
|
132
|
+
|
153
133
|
|
154
134
|
begin
|
155
135
|
#Retrieve distribution centers
|
@@ -189,18 +169,11 @@ Store the tracking information and mark the order shipped for this distribution
|
|
189
169
|
```ruby
|
190
170
|
# load the gem
|
191
171
|
require 'ultracart_api'
|
192
|
-
# setup authorization
|
193
|
-
UltracartClient.configure do |config|
|
194
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
195
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
196
|
-
|
197
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
198
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
199
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
200
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
201
|
-
end
|
202
172
|
|
203
|
-
|
173
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
174
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
175
|
+
api_instance = UltracartClient::FulfillmentApi.new_using_api_key(simple_key, false, false)
|
176
|
+
|
204
177
|
|
205
178
|
distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
|
206
179
|
|
@@ -248,18 +221,11 @@ Update the inventory for items associated with this distribution center
|
|
248
221
|
```ruby
|
249
222
|
# load the gem
|
250
223
|
require 'ultracart_api'
|
251
|
-
# setup authorization
|
252
|
-
UltracartClient.configure do |config|
|
253
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
254
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
255
|
-
|
256
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
257
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
258
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
259
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
260
|
-
end
|
261
224
|
|
262
|
-
|
225
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
226
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
227
|
+
api_instance = UltracartClient::FulfillmentApi.new_using_api_key(simple_key, false, false)
|
228
|
+
|
263
229
|
|
264
230
|
distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
|
265
231
|
|
data/docs/ItemApi.md
CHANGED
@@ -26,18 +26,11 @@ Delete an item on the UltraCart account.
|
|
26
26
|
```ruby
|
27
27
|
# load the gem
|
28
28
|
require 'ultracart_api'
|
29
|
-
# setup authorization
|
30
|
-
UltracartClient.configure do |config|
|
31
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
32
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
33
|
-
|
34
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
35
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
36
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
37
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
38
|
-
end
|
39
29
|
|
40
|
-
|
30
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
31
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
32
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
33
|
+
|
41
34
|
|
42
35
|
merchant_item_oid = 56 # Integer | The item oid to delete.
|
43
36
|
|
@@ -82,18 +75,11 @@ Retrieves a single item using the specified item oid.
|
|
82
75
|
```ruby
|
83
76
|
# load the gem
|
84
77
|
require 'ultracart_api'
|
85
|
-
# setup authorization
|
86
|
-
UltracartClient.configure do |config|
|
87
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
88
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
89
|
-
|
90
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
91
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
92
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
93
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
94
|
-
end
|
95
78
|
|
96
|
-
|
79
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
80
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
81
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
82
|
+
|
97
83
|
|
98
84
|
merchant_item_oid = 56 # Integer | The item oid to retrieve.
|
99
85
|
|
@@ -145,18 +131,11 @@ Retrieves a single item using the specified item id.
|
|
145
131
|
```ruby
|
146
132
|
# load the gem
|
147
133
|
require 'ultracart_api'
|
148
|
-
# setup authorization
|
149
|
-
UltracartClient.configure do |config|
|
150
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
151
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
152
|
-
|
153
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
154
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
155
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
156
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
157
|
-
end
|
158
134
|
|
159
|
-
|
135
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
136
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
137
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
138
|
+
|
160
139
|
|
161
140
|
merchant_item_id = 'merchant_item_id_example' # String | The item id to retrieve.
|
162
141
|
|
@@ -208,18 +187,11 @@ Retrieves a group of items from the account. If no parameters are specified, al
|
|
208
187
|
```ruby
|
209
188
|
# load the gem
|
210
189
|
require 'ultracart_api'
|
211
|
-
# setup authorization
|
212
|
-
UltracartClient.configure do |config|
|
213
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
214
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
215
|
-
|
216
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
217
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
218
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
219
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
220
|
-
end
|
221
190
|
|
222
|
-
|
191
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
192
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
193
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
194
|
+
|
223
195
|
|
224
196
|
opts = {
|
225
197
|
parent_category_id: 56, # Integer | The parent category object id to retrieve items for. Unspecified means all items on the account. 0 = root
|
@@ -280,18 +252,11 @@ Retrieves the pricing tiers
|
|
280
252
|
```ruby
|
281
253
|
# load the gem
|
282
254
|
require 'ultracart_api'
|
283
|
-
# setup authorization
|
284
|
-
UltracartClient.configure do |config|
|
285
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
286
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
287
|
-
|
288
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
289
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
290
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
291
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
292
|
-
end
|
293
255
|
|
294
|
-
|
256
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
257
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
258
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
259
|
+
|
295
260
|
|
296
261
|
opts = {
|
297
262
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
@@ -338,18 +303,11 @@ Create a new item on the UltraCart account.
|
|
338
303
|
```ruby
|
339
304
|
# load the gem
|
340
305
|
require 'ultracart_api'
|
341
|
-
# setup authorization
|
342
|
-
UltracartClient.configure do |config|
|
343
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
344
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
345
|
-
|
346
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
347
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
348
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
349
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
350
|
-
end
|
351
306
|
|
352
|
-
|
307
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
308
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
309
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
310
|
+
|
353
311
|
|
354
312
|
item = UltracartClient::Item.new # Item | Item to create
|
355
313
|
|
@@ -401,18 +359,11 @@ Update a new item on the UltraCart account.
|
|
401
359
|
```ruby
|
402
360
|
# load the gem
|
403
361
|
require 'ultracart_api'
|
404
|
-
# setup authorization
|
405
|
-
UltracartClient.configure do |config|
|
406
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
407
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
408
|
-
|
409
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
410
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
411
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
412
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
413
|
-
end
|
414
362
|
|
415
|
-
|
363
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
364
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
365
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
366
|
+
|
416
367
|
|
417
368
|
item = UltracartClient::Item.new # Item | Item to update
|
418
369
|
|
@@ -467,18 +418,11 @@ Update multiple item on the UltraCart account.
|
|
467
418
|
```ruby
|
468
419
|
# load the gem
|
469
420
|
require 'ultracart_api'
|
470
|
-
# setup authorization
|
471
|
-
UltracartClient.configure do |config|
|
472
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
473
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
474
|
-
|
475
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
476
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
477
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
478
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
479
|
-
end
|
480
421
|
|
481
|
-
|
422
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
423
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
424
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
425
|
+
|
482
426
|
|
483
427
|
items_request = UltracartClient::ItemsRequest.new # ItemsRequest | Items to update (synchronous maximum 20 / asynchronous maximum 100)
|
484
428
|
|
@@ -532,18 +476,11 @@ Uploads an image and returns back meta information about the image as well as th
|
|
532
476
|
```ruby
|
533
477
|
# load the gem
|
534
478
|
require 'ultracart_api'
|
535
|
-
# setup authorization
|
536
|
-
UltracartClient.configure do |config|
|
537
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
538
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
539
|
-
|
540
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
541
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
542
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
543
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
544
|
-
end
|
545
479
|
|
546
|
-
|
480
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
481
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
482
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
483
|
+
|
547
484
|
|
548
485
|
file = File.new('/path/to/file.txt') # File | File to upload
|
549
486
|
|
data/docs/OauthApi.md
CHANGED
@@ -19,23 +19,11 @@ The final leg in the OAuth process which exchanges the specified access token fo
|
|
19
19
|
```ruby
|
20
20
|
# load the gem
|
21
21
|
require 'ultracart_api'
|
22
|
-
# setup authorization
|
23
|
-
UltracartClient.configure do |config|
|
24
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
25
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
26
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
28
|
-
|
29
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
30
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
31
|
-
|
32
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
33
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
34
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
35
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
36
|
-
end
|
37
22
|
|
38
|
-
|
23
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
24
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
25
|
+
api_instance = UltracartClient::OauthApi.new_using_api_key(simple_key, false, false)
|
26
|
+
|
39
27
|
|
40
28
|
client_id = 'client_id_example' # String | The OAuth application client_id.
|
41
29
|
|
@@ -92,23 +80,11 @@ Revokes the OAuth application associated with the specified client_id and token.
|
|
92
80
|
```ruby
|
93
81
|
# load the gem
|
94
82
|
require 'ultracart_api'
|
95
|
-
# setup authorization
|
96
|
-
UltracartClient.configure do |config|
|
97
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
98
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
99
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
100
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
101
|
-
|
102
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
103
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
104
|
-
|
105
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
106
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
107
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
108
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
109
|
-
end
|
110
83
|
|
111
|
-
|
84
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
85
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
86
|
+
api_instance = UltracartClient::OauthApi.new_using_api_key(simple_key, false, false)
|
87
|
+
|
112
88
|
|
113
89
|
client_id = 'client_id_example' # String | The OAuth application client_id.
|
114
90
|
|
data/docs/OrderApi.md
CHANGED
@@ -15,7 +15,7 @@ Method | HTTP request | Description
|
|
15
15
|
[**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
|
16
16
|
[**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
|
17
17
|
[**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
|
18
|
-
[**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders
|
18
|
+
[**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
|
19
19
|
[**insert_order**](OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
|
20
20
|
[**process_payment**](OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
21
21
|
[**refund_order**](OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
|
@@ -37,18 +37,11 @@ Adjusts an order total. Adjusts individual items appropriately and considers ta
|
|
37
37
|
```ruby
|
38
38
|
# load the gem
|
39
39
|
require 'ultracart_api'
|
40
|
-
# setup authorization
|
41
|
-
UltracartClient.configure do |config|
|
42
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
43
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
44
|
-
|
45
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
46
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
47
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
48
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
49
|
-
end
|
50
40
|
|
51
|
-
|
41
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
42
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
43
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
44
|
+
|
52
45
|
|
53
46
|
order_id = 'order_id_example' # String | The order id to cancel.
|
54
47
|
|
@@ -97,18 +90,11 @@ Cancel an order on the UltraCart account. If the success flag is false, then co
|
|
97
90
|
```ruby
|
98
91
|
# load the gem
|
99
92
|
require 'ultracart_api'
|
100
|
-
# setup authorization
|
101
|
-
UltracartClient.configure do |config|
|
102
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
103
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
104
|
-
|
105
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
106
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
107
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
108
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
109
|
-
end
|
110
93
|
|
111
|
-
|
94
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
95
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
96
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
97
|
+
|
112
98
|
|
113
99
|
order_id = 'order_id_example' # String | The order id to cancel.
|
114
100
|
|
@@ -154,18 +140,11 @@ Delete an order on the UltraCart account.
|
|
154
140
|
```ruby
|
155
141
|
# load the gem
|
156
142
|
require 'ultracart_api'
|
157
|
-
# setup authorization
|
158
|
-
UltracartClient.configure do |config|
|
159
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
160
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
161
|
-
|
162
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
163
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
164
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
165
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
166
|
-
end
|
167
143
|
|
168
|
-
|
144
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
145
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
146
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
147
|
+
|
169
148
|
|
170
149
|
order_id = 'order_id_example' # String | The order id to delete.
|
171
150
|
|
@@ -210,18 +189,11 @@ Format the order for display at text or html
|
|
210
189
|
```ruby
|
211
190
|
# load the gem
|
212
191
|
require 'ultracart_api'
|
213
|
-
# setup authorization
|
214
|
-
UltracartClient.configure do |config|
|
215
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
216
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
217
|
-
|
218
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
219
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
220
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
221
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
222
|
-
end
|
223
192
|
|
224
|
-
|
193
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
194
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
195
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
196
|
+
|
225
197
|
|
226
198
|
order_id = 'order_id_example' # String | The order id to format
|
227
199
|
|
@@ -270,18 +242,11 @@ Retrieves a single order token for a given order id. The token can be used with
|
|
270
242
|
```ruby
|
271
243
|
# load the gem
|
272
244
|
require 'ultracart_api'
|
273
|
-
# setup authorization
|
274
|
-
UltracartClient.configure do |config|
|
275
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
276
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
277
|
-
|
278
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
279
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
280
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
281
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
282
|
-
end
|
283
245
|
|
284
|
-
|
246
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
247
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
248
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
249
|
+
|
285
250
|
|
286
251
|
order_id = 'order_id_example' # String | The order id to generate a token for.
|
287
252
|
|
@@ -327,18 +292,12 @@ Retrieve A/R Retry Configuration. This is primarily an internal API call. It is
|
|
327
292
|
```ruby
|
328
293
|
# load the gem
|
329
294
|
require 'ultracart_api'
|
330
|
-
# setup authorization
|
331
|
-
UltracartClient.configure do |config|
|
332
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
333
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
334
|
-
|
335
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
336
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
337
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
338
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
339
|
-
end
|
340
295
|
|
341
|
-
|
296
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
297
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
298
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
299
|
+
|
300
|
+
|
342
301
|
|
343
302
|
begin
|
344
303
|
#Retrieve A/R Retry Configuration
|
@@ -378,18 +337,11 @@ Retrieve A/R Retry Statistics. This is primarily an internal API call. It is do
|
|
378
337
|
```ruby
|
379
338
|
# load the gem
|
380
339
|
require 'ultracart_api'
|
381
|
-
# setup authorization
|
382
|
-
UltracartClient.configure do |config|
|
383
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
384
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
385
|
-
|
386
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
387
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
388
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
389
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
390
|
-
end
|
391
340
|
|
392
|
-
|
341
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
342
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
343
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
344
|
+
|
393
345
|
|
394
346
|
opts = {
|
395
347
|
from: 'from_example', # String |
|
@@ -438,18 +390,11 @@ Retrieves a single order using the specified order id.
|
|
438
390
|
```ruby
|
439
391
|
# load the gem
|
440
392
|
require 'ultracart_api'
|
441
|
-
# setup authorization
|
442
|
-
UltracartClient.configure do |config|
|
443
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
444
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
445
|
-
|
446
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
447
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
448
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
449
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
450
|
-
end
|
451
393
|
|
452
|
-
|
394
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
395
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
396
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
397
|
+
|
453
398
|
|
454
399
|
order_id = 'order_id_example' # String | The order id to retrieve.
|
455
400
|
|
@@ -499,18 +444,11 @@ Retrieves a single order using the specified order token.
|
|
499
444
|
```ruby
|
500
445
|
# load the gem
|
501
446
|
require 'ultracart_api'
|
502
|
-
# setup authorization
|
503
|
-
UltracartClient.configure do |config|
|
504
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
505
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
506
|
-
|
507
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
508
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
509
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
510
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
511
|
-
end
|
512
447
|
|
513
|
-
|
448
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
449
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
450
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
451
|
+
|
514
452
|
|
515
453
|
order_by_token_query = UltracartClient::OrderByTokenQuery.new # OrderByTokenQuery | Order by token query
|
516
454
|
|
@@ -560,18 +498,11 @@ Retrieves a group of orders from the account. If no parameters are specified, t
|
|
560
498
|
```ruby
|
561
499
|
# load the gem
|
562
500
|
require 'ultracart_api'
|
563
|
-
# setup authorization
|
564
|
-
UltracartClient.configure do |config|
|
565
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
566
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
567
|
-
|
568
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
569
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
570
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
571
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
572
|
-
end
|
573
501
|
|
574
|
-
|
502
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
503
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
504
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
505
|
+
|
575
506
|
|
576
507
|
opts = {
|
577
508
|
order_id: 'order_id_example', # String | Order Id
|
@@ -684,18 +615,11 @@ Retrieves a group of orders from the account based on an array of order ids. If
|
|
684
615
|
```ruby
|
685
616
|
# load the gem
|
686
617
|
require 'ultracart_api'
|
687
|
-
# setup authorization
|
688
|
-
UltracartClient.configure do |config|
|
689
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
690
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
691
|
-
|
692
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
693
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
694
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
695
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
696
|
-
end
|
697
618
|
|
698
|
-
|
619
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
620
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
621
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
622
|
+
|
699
623
|
|
700
624
|
order_batch = UltracartClient::OrderQueryBatch.new # OrderQueryBatch | Order batch
|
701
625
|
|
@@ -737,7 +661,7 @@ Name | Type | Description | Notes
|
|
737
661
|
# **get_orders_by_query**
|
738
662
|
> OrdersResponse get_orders_by_query(order_query, opts)
|
739
663
|
|
740
|
-
Retrieve orders
|
664
|
+
Retrieve orders by query
|
741
665
|
|
742
666
|
Retrieves a group of orders from the account based on a query object. If no parameters are specified, the API call will fail with a bad request error. Always specify some parameters to limit the scope of the orders returned to ones you are truly interested in. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
743
667
|
|
@@ -745,18 +669,11 @@ Retrieves a group of orders from the account based on a query object. If no par
|
|
745
669
|
```ruby
|
746
670
|
# load the gem
|
747
671
|
require 'ultracart_api'
|
748
|
-
# setup authorization
|
749
|
-
UltracartClient.configure do |config|
|
750
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
751
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
752
|
-
|
753
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
754
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
755
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
756
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
757
|
-
end
|
758
672
|
|
759
|
-
|
673
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
674
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
675
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
676
|
+
|
760
677
|
|
761
678
|
order_query = UltracartClient::OrderQuery.new # OrderQuery | Order query
|
762
679
|
|
@@ -768,7 +685,7 @@ opts = {
|
|
768
685
|
}
|
769
686
|
|
770
687
|
begin
|
771
|
-
#Retrieve orders
|
688
|
+
#Retrieve orders by query
|
772
689
|
result = api_instance.get_orders_by_query(order_query, opts)
|
773
690
|
p result
|
774
691
|
rescue UltracartClient::ApiError => e
|
@@ -812,18 +729,11 @@ Inserts a new order on the UltraCart account. This is probably NOT the method y
|
|
812
729
|
```ruby
|
813
730
|
# load the gem
|
814
731
|
require 'ultracart_api'
|
815
|
-
# setup authorization
|
816
|
-
UltracartClient.configure do |config|
|
817
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
818
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
819
|
-
|
820
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
821
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
822
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
823
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
824
|
-
end
|
825
732
|
|
826
|
-
|
733
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
734
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
735
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
736
|
+
|
827
737
|
|
828
738
|
order = UltracartClient::Order.new # Order | Order to insert
|
829
739
|
|
@@ -873,18 +783,11 @@ Process payment on order
|
|
873
783
|
```ruby
|
874
784
|
# load the gem
|
875
785
|
require 'ultracart_api'
|
876
|
-
# setup authorization
|
877
|
-
UltracartClient.configure do |config|
|
878
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
879
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
880
|
-
|
881
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
882
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
883
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
884
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
885
|
-
end
|
886
786
|
|
887
|
-
|
787
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
788
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
789
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
790
|
+
|
888
791
|
|
889
792
|
order_id = 'order_id_example' # String | The order id to process payment on
|
890
793
|
|
@@ -933,18 +836,11 @@ Perform a refund operation on an order and then update the order if successful
|
|
933
836
|
```ruby
|
934
837
|
# load the gem
|
935
838
|
require 'ultracart_api'
|
936
|
-
# setup authorization
|
937
|
-
UltracartClient.configure do |config|
|
938
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
939
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
940
|
-
|
941
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
942
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
943
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
944
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
945
|
-
end
|
946
839
|
|
947
|
-
|
840
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
841
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
842
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
843
|
+
|
948
844
|
|
949
845
|
order = UltracartClient::Order.new # Order | Order to refund
|
950
846
|
|
@@ -1007,18 +903,11 @@ Create a replacement order based upon a previous order
|
|
1007
903
|
```ruby
|
1008
904
|
# load the gem
|
1009
905
|
require 'ultracart_api'
|
1010
|
-
# setup authorization
|
1011
|
-
UltracartClient.configure do |config|
|
1012
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
1013
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
1014
|
-
|
1015
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
1016
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
1017
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1018
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
1019
|
-
end
|
1020
906
|
|
1021
|
-
|
907
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
908
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
909
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
910
|
+
|
1022
911
|
|
1023
912
|
order_id = 'order_id_example' # String | The order id to generate a replacement for.
|
1024
913
|
|
@@ -1067,18 +956,11 @@ Resend the receipt for an order on the UltraCart account.
|
|
1067
956
|
```ruby
|
1068
957
|
# load the gem
|
1069
958
|
require 'ultracart_api'
|
1070
|
-
# setup authorization
|
1071
|
-
UltracartClient.configure do |config|
|
1072
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
1073
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
1074
|
-
|
1075
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
1076
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
1077
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1078
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
1079
|
-
end
|
1080
959
|
|
1081
|
-
|
960
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
961
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
962
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
963
|
+
|
1082
964
|
|
1083
965
|
order_id = 'order_id_example' # String | The order id to resend the receipt for.
|
1084
966
|
|
@@ -1124,18 +1006,11 @@ Resend shipment confirmation for an order on the UltraCart account.
|
|
1124
1006
|
```ruby
|
1125
1007
|
# load the gem
|
1126
1008
|
require 'ultracart_api'
|
1127
|
-
# setup authorization
|
1128
|
-
UltracartClient.configure do |config|
|
1129
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
1130
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
1131
|
-
|
1132
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
1133
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
1134
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1135
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
1136
|
-
end
|
1137
1009
|
|
1138
|
-
|
1010
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1011
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1012
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
1013
|
+
|
1139
1014
|
|
1140
1015
|
order_id = 'order_id_example' # String | The order id to resend the shipment notification for.
|
1141
1016
|
|
@@ -1181,18 +1056,11 @@ Update A/R Retry Configuration. This is primarily an internal API call. It is
|
|
1181
1056
|
```ruby
|
1182
1057
|
# load the gem
|
1183
1058
|
require 'ultracart_api'
|
1184
|
-
# setup authorization
|
1185
|
-
UltracartClient.configure do |config|
|
1186
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
1187
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
1188
|
-
|
1189
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
1190
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
1191
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1192
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
1193
|
-
end
|
1194
1059
|
|
1195
|
-
|
1060
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1061
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1062
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
1063
|
+
|
1196
1064
|
|
1197
1065
|
retry_config = UltracartClient::AccountsReceivableRetryConfig.new # AccountsReceivableRetryConfig | AccountsReceivableRetryConfig object
|
1198
1066
|
|
@@ -1238,18 +1106,11 @@ Update a new order on the UltraCart account. This is probably NOT the method yo
|
|
1238
1106
|
```ruby
|
1239
1107
|
# load the gem
|
1240
1108
|
require 'ultracart_api'
|
1241
|
-
# setup authorization
|
1242
|
-
UltracartClient.configure do |config|
|
1243
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
1244
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
1245
|
-
|
1246
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
1247
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
1248
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1249
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
1250
|
-
end
|
1251
1109
|
|
1252
|
-
|
1110
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1111
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1112
|
+
api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
|
1113
|
+
|
1253
1114
|
|
1254
1115
|
order = UltracartClient::Order.new # Order | Order to update
|
1255
1116
|
|