ultracart_api 4.1.237 → 4.1.239
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 +15 -2
- data/docs/SfvbApi.md +229 -0
- data/docs/SfvbApprovalCreateRequest.md +4 -0
- data/docs/SfvbItemPreorder.md +36 -0
- data/docs/SfvbItemPreorderChange.md +24 -0
- data/docs/SfvbItemPreorderChildRow.md +20 -0
- data/docs/SfvbItemPreorderChildrenRequest.md +24 -0
- data/docs/SfvbItemPreorderListResponse.md +20 -0
- data/docs/SfvbItemPreorderOption.md +20 -0
- data/docs/SfvbItemPreorderRequest.md +22 -0
- data/docs/SfvbTrackingProviderSecrets.md +2 -0
- data/docs/SfvbWhoamiResponse.md +4 -0
- data/docs/TaxJarConfig.md +2 -0
- data/lib/ultracart_api/api/sfvb_api.rb +315 -0
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +21 -3
- data/lib/ultracart_api/models/sfvb_item_preorder.rb +347 -0
- data/lib/ultracart_api/models/sfvb_item_preorder_change.rb +250 -0
- data/lib/ultracart_api/models/sfvb_item_preorder_child_row.rb +230 -0
- data/lib/ultracart_api/models/sfvb_item_preorder_children_request.rb +252 -0
- data/lib/ultracart_api/models/sfvb_item_preorder_list_response.rb +231 -0
- data/lib/ultracart_api/models/sfvb_item_preorder_option.rb +230 -0
- data/lib/ultracart_api/models/sfvb_item_preorder_request.rb +240 -0
- data/lib/ultracart_api/models/sfvb_tracking_provider_secrets.rb +11 -1
- data/lib/ultracart_api/models/sfvb_whoami_response.rb +21 -1
- data/lib/ultracart_api/models/tax_jar_config.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +7 -0
- metadata +15 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a9ae11f608a97028cbf3e710d16fc04218dff17ba90ffaa9a66f7343b115540b
|
|
4
|
+
data.tar.gz: 9b2e53b6cd006e88f187e1550363d81764bd88da1eaff5f8e9c3cf4554a6d2a3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d85d830f1d58c665544e631c8cc94a2683a37182704e9f7c630273d005b3ff7ec20d674a81edb3b3cf8af41958bb7a89bbed25ad40d95eaa77ac98e2271e8483
|
|
7
|
+
data.tar.gz: 7dc08df9e7ee4d61007f7b1583c0d041251f3547f0acdb174fdc1d3552df965003757102300166c4e4eacae6a1713b5d2e3c6744f43bac3c4b3d63b85888ecde
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
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.1.
|
|
10
|
+
- Package version: 4.1.239
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.239'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -586,6 +586,8 @@ Class | Method | HTTP request | Description
|
|
|
586
586
|
*UltracartClient::SfvbApi* | [**get_sfvb_i18n_message**](docs/SfvbApi.md#get_sfvb_i18n_message) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Read one built-in message
|
|
587
587
|
*UltracartClient::SfvbApi* | [**get_sfvb_i18n_message_machine_translations**](docs/SfvbApi.md#get_sfvb_i18n_message_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key}/machine_translations | Read where a message's translations come from
|
|
588
588
|
*UltracartClient::SfvbApi* | [**get_sfvb_item**](docs/SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content
|
|
589
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_item_preorder**](docs/SfvbApi.md#get_sfvb_item_preorder) | **GET** /sfvb/storefronts/{storefront_oid}/items/preorder | Read an item's pre-order flag and ETA
|
|
590
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_item_preorder_children**](docs/SfvbApi.md#get_sfvb_item_preorder_children) | **GET** /sfvb/storefronts/{storefront_oid}/items/preorder/children | Read the pre-order flag and ETA of a parent item's variations
|
|
589
591
|
*UltracartClient::SfvbApi* | [**get_sfvb_item_pricing**](docs/SfvbApi.md#get_sfvb_item_pricing) | **GET** /sfvb/storefronts/{storefront_oid}/items/pricing | Read what an item charges
|
|
590
592
|
*UltracartClient::SfvbApi* | [**get_sfvb_item_related**](docs/SfvbApi.md#get_sfvb_item_related) | **GET** /sfvb/storefronts/{storefront_oid}/items/related | Read an item's related items
|
|
591
593
|
*UltracartClient::SfvbApi* | [**get_sfvb_library_entry**](docs/SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON
|
|
@@ -693,6 +695,8 @@ Class | Method | HTTP request | Description
|
|
|
693
695
|
*UltracartClient::SfvbApi* | [**put_sfvb_item_content**](docs/SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description
|
|
694
696
|
*UltracartClient::SfvbApi* | [**put_sfvb_item_multimedia**](docs/SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item
|
|
695
697
|
*UltracartClient::SfvbApi* | [**put_sfvb_item_multimedia_description**](docs/SfvbApi.md#put_sfvb_item_multimedia_description) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia/description | Change an item image's description
|
|
698
|
+
*UltracartClient::SfvbApi* | [**put_sfvb_item_preorder**](docs/SfvbApi.md#put_sfvb_item_preorder) | **PUT** /sfvb/storefronts/{storefront_oid}/items/preorder | Change an item's pre-order flag or ETA
|
|
699
|
+
*UltracartClient::SfvbApi* | [**put_sfvb_item_preorder_children**](docs/SfvbApi.md#put_sfvb_item_preorder_children) | **PUT** /sfvb/storefronts/{storefront_oid}/items/preorder/children | Change the pre-order flag or ETA of several variations of one parent
|
|
696
700
|
*UltracartClient::SfvbApi* | [**put_sfvb_item_pricing**](docs/SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges
|
|
697
701
|
*UltracartClient::SfvbApi* | [**put_sfvb_item_related**](docs/SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items
|
|
698
702
|
*UltracartClient::SfvbApi* | [**put_sfvb_item_seo**](docs/SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata
|
|
@@ -2155,6 +2159,13 @@ Class | Method | HTTP request | Description
|
|
|
2155
2159
|
- [UltracartClient::SfvbItemMultimedia](docs/SfvbItemMultimedia.md)
|
|
2156
2160
|
- [UltracartClient::SfvbItemMultimediaDescriptionRequest](docs/SfvbItemMultimediaDescriptionRequest.md)
|
|
2157
2161
|
- [UltracartClient::SfvbItemMultimediaRequest](docs/SfvbItemMultimediaRequest.md)
|
|
2162
|
+
- [UltracartClient::SfvbItemPreorder](docs/SfvbItemPreorder.md)
|
|
2163
|
+
- [UltracartClient::SfvbItemPreorderChange](docs/SfvbItemPreorderChange.md)
|
|
2164
|
+
- [UltracartClient::SfvbItemPreorderChildRow](docs/SfvbItemPreorderChildRow.md)
|
|
2165
|
+
- [UltracartClient::SfvbItemPreorderChildrenRequest](docs/SfvbItemPreorderChildrenRequest.md)
|
|
2166
|
+
- [UltracartClient::SfvbItemPreorderListResponse](docs/SfvbItemPreorderListResponse.md)
|
|
2167
|
+
- [UltracartClient::SfvbItemPreorderOption](docs/SfvbItemPreorderOption.md)
|
|
2168
|
+
- [UltracartClient::SfvbItemPreorderRequest](docs/SfvbItemPreorderRequest.md)
|
|
2158
2169
|
- [UltracartClient::SfvbItemPricing](docs/SfvbItemPricing.md)
|
|
2159
2170
|
- [UltracartClient::SfvbItemPricingRequest](docs/SfvbItemPricingRequest.md)
|
|
2160
2171
|
- [UltracartClient::SfvbItemRelated](docs/SfvbItemRelated.md)
|
|
@@ -2545,6 +2556,8 @@ Not every change is committed to every SDK.
|
|
|
2545
2556
|
|
|
2546
2557
|
| Version | Date | Comments |
|
|
2547
2558
|
| --: | :-: | --- |
|
|
2559
|
+
| 4.1.239 | 11/10/2026 | sfvb internal testing |
|
|
2560
|
+
| 4.1.238 | 11/10/2026 | sfvb internal testing |
|
|
2548
2561
|
| 4.1.237 | 11/10/2026 | sfvb internal testing |
|
|
2549
2562
|
| 4.1.236 | 11/09/2026 | sfvb internal testing |
|
|
2550
2563
|
| 4.1.235 | 11/09/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -114,6 +114,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
114
114
|
| [**get_sfvb_i18n_message**](SfvbApi.md#get_sfvb_i18n_message) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Read one built-in message |
|
|
115
115
|
| [**get_sfvb_i18n_message_machine_translations**](SfvbApi.md#get_sfvb_i18n_message_machine_translations) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key}/machine_translations | Read where a message's translations come from |
|
|
116
116
|
| [**get_sfvb_item**](SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content |
|
|
117
|
+
| [**get_sfvb_item_preorder**](SfvbApi.md#get_sfvb_item_preorder) | **GET** /sfvb/storefronts/{storefront_oid}/items/preorder | Read an item's pre-order flag and ETA |
|
|
118
|
+
| [**get_sfvb_item_preorder_children**](SfvbApi.md#get_sfvb_item_preorder_children) | **GET** /sfvb/storefronts/{storefront_oid}/items/preorder/children | Read the pre-order flag and ETA of a parent item's variations |
|
|
117
119
|
| [**get_sfvb_item_pricing**](SfvbApi.md#get_sfvb_item_pricing) | **GET** /sfvb/storefronts/{storefront_oid}/items/pricing | Read what an item charges |
|
|
118
120
|
| [**get_sfvb_item_related**](SfvbApi.md#get_sfvb_item_related) | **GET** /sfvb/storefronts/{storefront_oid}/items/related | Read an item's related items |
|
|
119
121
|
| [**get_sfvb_library_entry**](SfvbApi.md#get_sfvb_library_entry) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Read one library entry including its CJSON |
|
|
@@ -221,6 +223,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
221
223
|
| [**put_sfvb_item_content**](SfvbApi.md#put_sfvb_item_content) | **PUT** /sfvb/storefronts/{storefront_oid}/items/content | Change an item's title or long description |
|
|
222
224
|
| [**put_sfvb_item_multimedia**](SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item |
|
|
223
225
|
| [**put_sfvb_item_multimedia_description**](SfvbApi.md#put_sfvb_item_multimedia_description) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia/description | Change an item image's description |
|
|
226
|
+
| [**put_sfvb_item_preorder**](SfvbApi.md#put_sfvb_item_preorder) | **PUT** /sfvb/storefronts/{storefront_oid}/items/preorder | Change an item's pre-order flag or ETA |
|
|
227
|
+
| [**put_sfvb_item_preorder_children**](SfvbApi.md#put_sfvb_item_preorder_children) | **PUT** /sfvb/storefronts/{storefront_oid}/items/preorder/children | Change the pre-order flag or ETA of several variations of one parent |
|
|
224
228
|
| [**put_sfvb_item_pricing**](SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges |
|
|
225
229
|
| [**put_sfvb_item_related**](SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items |
|
|
226
230
|
| [**put_sfvb_item_seo**](SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata |
|
|
@@ -6274,6 +6278,116 @@ end
|
|
|
6274
6278
|
- **Accept**: application/json
|
|
6275
6279
|
|
|
6276
6280
|
|
|
6281
|
+
## get_sfvb_item_preorder
|
|
6282
|
+
|
|
6283
|
+
> <SfvbItemPreorder> get_sfvb_item_preorder(storefront_oid, opts)
|
|
6284
|
+
|
|
6285
|
+
Read an item's pre-order flag and ETA
|
|
6286
|
+
|
|
6287
|
+
Whether the item is on pre-order, its ETA, and what itempreorder shows shoppers because of them, with a hash_sha256 to send as If-Match when changing them. A variation is an item of its own and can be read here; read a parent's variations together with GET items/preorder/children. Address by merchant_item_id or merchant_item_oid.
|
|
6288
|
+
|
|
6289
|
+
|
|
6290
|
+
### Examples
|
|
6291
|
+
|
|
6292
|
+
|
|
6293
|
+
(No example for this operation).
|
|
6294
|
+
|
|
6295
|
+
|
|
6296
|
+
#### Using the get_sfvb_item_preorder_with_http_info variant
|
|
6297
|
+
|
|
6298
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6299
|
+
|
|
6300
|
+
> <Array(<SfvbItemPreorder>, Integer, Hash)> get_sfvb_item_preorder_with_http_info(storefront_oid, opts)
|
|
6301
|
+
|
|
6302
|
+
```ruby
|
|
6303
|
+
begin
|
|
6304
|
+
# Read an item's pre-order flag and ETA
|
|
6305
|
+
data, status_code, headers = api_instance.get_sfvb_item_preorder_with_http_info(storefront_oid, opts)
|
|
6306
|
+
p status_code # => 2xx
|
|
6307
|
+
p headers # => { ... }
|
|
6308
|
+
p data # => <SfvbItemPreorder>
|
|
6309
|
+
rescue UltracartClient::ApiError => e
|
|
6310
|
+
puts "Error when calling SfvbApi->get_sfvb_item_preorder_with_http_info: #{e}"
|
|
6311
|
+
end
|
|
6312
|
+
```
|
|
6313
|
+
|
|
6314
|
+
### Parameters
|
|
6315
|
+
|
|
6316
|
+
| Name | Type | Description | Notes |
|
|
6317
|
+
| ---- | ---- | ----------- | ----- |
|
|
6318
|
+
| **storefront_oid** | **Integer** | | |
|
|
6319
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
6320
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
6321
|
+
|
|
6322
|
+
### Return type
|
|
6323
|
+
|
|
6324
|
+
[**SfvbItemPreorder**](SfvbItemPreorder.md)
|
|
6325
|
+
|
|
6326
|
+
### Authorization
|
|
6327
|
+
|
|
6328
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6329
|
+
|
|
6330
|
+
### HTTP request headers
|
|
6331
|
+
|
|
6332
|
+
- **Content-Type**: Not defined
|
|
6333
|
+
- **Accept**: application/json
|
|
6334
|
+
|
|
6335
|
+
|
|
6336
|
+
## get_sfvb_item_preorder_children
|
|
6337
|
+
|
|
6338
|
+
> <SfvbItemPreorderListResponse> get_sfvb_item_preorder_children(storefront_oid, opts)
|
|
6339
|
+
|
|
6340
|
+
Read the pre-order flag and ETA of a parent item's variations
|
|
6341
|
+
|
|
6342
|
+
The parent's own values and each variation's, with the option values that pick it (such as Size 2T) and its hash_sha256 to send when changing it. Read fresh, never from a cache. Address the parent by merchant_item_id or merchant_item_oid.
|
|
6343
|
+
|
|
6344
|
+
|
|
6345
|
+
### Examples
|
|
6346
|
+
|
|
6347
|
+
|
|
6348
|
+
(No example for this operation).
|
|
6349
|
+
|
|
6350
|
+
|
|
6351
|
+
#### Using the get_sfvb_item_preorder_children_with_http_info variant
|
|
6352
|
+
|
|
6353
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6354
|
+
|
|
6355
|
+
> <Array(<SfvbItemPreorderListResponse>, Integer, Hash)> get_sfvb_item_preorder_children_with_http_info(storefront_oid, opts)
|
|
6356
|
+
|
|
6357
|
+
```ruby
|
|
6358
|
+
begin
|
|
6359
|
+
# Read the pre-order flag and ETA of a parent item's variations
|
|
6360
|
+
data, status_code, headers = api_instance.get_sfvb_item_preorder_children_with_http_info(storefront_oid, opts)
|
|
6361
|
+
p status_code # => 2xx
|
|
6362
|
+
p headers # => { ... }
|
|
6363
|
+
p data # => <SfvbItemPreorderListResponse>
|
|
6364
|
+
rescue UltracartClient::ApiError => e
|
|
6365
|
+
puts "Error when calling SfvbApi->get_sfvb_item_preorder_children_with_http_info: #{e}"
|
|
6366
|
+
end
|
|
6367
|
+
```
|
|
6368
|
+
|
|
6369
|
+
### Parameters
|
|
6370
|
+
|
|
6371
|
+
| Name | Type | Description | Notes |
|
|
6372
|
+
| ---- | ---- | ----------- | ----- |
|
|
6373
|
+
| **storefront_oid** | **Integer** | | |
|
|
6374
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
6375
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
6376
|
+
|
|
6377
|
+
### Return type
|
|
6378
|
+
|
|
6379
|
+
[**SfvbItemPreorderListResponse**](SfvbItemPreorderListResponse.md)
|
|
6380
|
+
|
|
6381
|
+
### Authorization
|
|
6382
|
+
|
|
6383
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6384
|
+
|
|
6385
|
+
### HTTP request headers
|
|
6386
|
+
|
|
6387
|
+
- **Content-Type**: Not defined
|
|
6388
|
+
- **Accept**: application/json
|
|
6389
|
+
|
|
6390
|
+
|
|
6277
6391
|
## get_sfvb_item_pricing
|
|
6278
6392
|
|
|
6279
6393
|
> <SfvbItemPricing> get_sfvb_item_pricing(storefront_oid, opts)
|
|
@@ -12119,6 +12233,121 @@ end
|
|
|
12119
12233
|
- **Accept**: application/json
|
|
12120
12234
|
|
|
12121
12235
|
|
|
12236
|
+
## put_sfvb_item_preorder
|
|
12237
|
+
|
|
12238
|
+
> <SfvbItemPreorder> put_sfvb_item_preorder(storefront_oid, if_match, item_preorder_request, opts)
|
|
12239
|
+
|
|
12240
|
+
Change an item's pre-order flag or ETA
|
|
12241
|
+
|
|
12242
|
+
Partial - a field left out is untouched, and nothing else on the item changes. eta is YYYY-MM-DD; clear_eta removes it. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Putting the item on or off pre-order also needs the approval of the person who signed in the CLI - an approved item.preorder request for this item and exactly this change - because a pre-order item can be ordered while out of stock and its orders go to the Pre-ordered stage. An ETA-only change needs no approval. A change that sets every field to what it already is returns the item unchanged. The answer has the values before and after, what shoppers now see, and warnings such as an ETA in the past.
|
|
12243
|
+
|
|
12244
|
+
|
|
12245
|
+
### Examples
|
|
12246
|
+
|
|
12247
|
+
|
|
12248
|
+
(No example for this operation).
|
|
12249
|
+
|
|
12250
|
+
|
|
12251
|
+
#### Using the put_sfvb_item_preorder_with_http_info variant
|
|
12252
|
+
|
|
12253
|
+
This returns an Array which contains the response data, status code and headers.
|
|
12254
|
+
|
|
12255
|
+
> <Array(<SfvbItemPreorder>, Integer, Hash)> put_sfvb_item_preorder_with_http_info(storefront_oid, if_match, item_preorder_request, opts)
|
|
12256
|
+
|
|
12257
|
+
```ruby
|
|
12258
|
+
begin
|
|
12259
|
+
# Change an item's pre-order flag or ETA
|
|
12260
|
+
data, status_code, headers = api_instance.put_sfvb_item_preorder_with_http_info(storefront_oid, if_match, item_preorder_request, opts)
|
|
12261
|
+
p status_code # => 2xx
|
|
12262
|
+
p headers # => { ... }
|
|
12263
|
+
p data # => <SfvbItemPreorder>
|
|
12264
|
+
rescue UltracartClient::ApiError => e
|
|
12265
|
+
puts "Error when calling SfvbApi->put_sfvb_item_preorder_with_http_info: #{e}"
|
|
12266
|
+
end
|
|
12267
|
+
```
|
|
12268
|
+
|
|
12269
|
+
### Parameters
|
|
12270
|
+
|
|
12271
|
+
| Name | Type | Description | Notes |
|
|
12272
|
+
| ---- | ---- | ----------- | ----- |
|
|
12273
|
+
| **storefront_oid** | **Integer** | | |
|
|
12274
|
+
| **if_match** | **String** | hash_sha256 from the pre-order read. Required; 428 when absent, 412 when stale. | |
|
|
12275
|
+
| **item_preorder_request** | [**SfvbItemPreorderRequest**](SfvbItemPreorderRequest.md) | The change | |
|
|
12276
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
12277
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
12278
|
+
| **approval_id** | **String** | The approval_id of an approved item.preorder request for this item and change. Required when the change puts the item on or off pre-order. See POST /sfvb/approvals. | [optional] |
|
|
12279
|
+
|
|
12280
|
+
### Return type
|
|
12281
|
+
|
|
12282
|
+
[**SfvbItemPreorder**](SfvbItemPreorder.md)
|
|
12283
|
+
|
|
12284
|
+
### Authorization
|
|
12285
|
+
|
|
12286
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
12287
|
+
|
|
12288
|
+
### HTTP request headers
|
|
12289
|
+
|
|
12290
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
12291
|
+
- **Accept**: application/json
|
|
12292
|
+
|
|
12293
|
+
|
|
12294
|
+
## put_sfvb_item_preorder_children
|
|
12295
|
+
|
|
12296
|
+
> <SfvbItemPreorderListResponse> put_sfvb_item_preorder_children(storefront_oid, item_preorder_children_request, opts)
|
|
12297
|
+
|
|
12298
|
+
Change the pre-order flag or ETA of several variations of one parent
|
|
12299
|
+
|
|
12300
|
+
The same change for each variation named, 1 to 100, by its merchant item id or by an option value only one variation has (such as 2T), each with the hash_sha256 from the children read. All or nothing - every row is checked before any variation is saved, and an unknown, ambiguous, repeated or stale row refuses the whole call. Putting any of them on or off pre-order needs one approved item.preorder request for the parent and exactly this change; an ETA-only change needs none. Needs sfvb_publish when items are live. Each variation is saved on its own, so if a save itself fails part way the error names the variations already saved.
|
|
12301
|
+
|
|
12302
|
+
|
|
12303
|
+
### Examples
|
|
12304
|
+
|
|
12305
|
+
|
|
12306
|
+
(No example for this operation).
|
|
12307
|
+
|
|
12308
|
+
|
|
12309
|
+
#### Using the put_sfvb_item_preorder_children_with_http_info variant
|
|
12310
|
+
|
|
12311
|
+
This returns an Array which contains the response data, status code and headers.
|
|
12312
|
+
|
|
12313
|
+
> <Array(<SfvbItemPreorderListResponse>, Integer, Hash)> put_sfvb_item_preorder_children_with_http_info(storefront_oid, item_preorder_children_request, opts)
|
|
12314
|
+
|
|
12315
|
+
```ruby
|
|
12316
|
+
begin
|
|
12317
|
+
# Change the pre-order flag or ETA of several variations of one parent
|
|
12318
|
+
data, status_code, headers = api_instance.put_sfvb_item_preorder_children_with_http_info(storefront_oid, item_preorder_children_request, opts)
|
|
12319
|
+
p status_code # => 2xx
|
|
12320
|
+
p headers # => { ... }
|
|
12321
|
+
p data # => <SfvbItemPreorderListResponse>
|
|
12322
|
+
rescue UltracartClient::ApiError => e
|
|
12323
|
+
puts "Error when calling SfvbApi->put_sfvb_item_preorder_children_with_http_info: #{e}"
|
|
12324
|
+
end
|
|
12325
|
+
```
|
|
12326
|
+
|
|
12327
|
+
### Parameters
|
|
12328
|
+
|
|
12329
|
+
| Name | Type | Description | Notes |
|
|
12330
|
+
| ---- | ---- | ----------- | ----- |
|
|
12331
|
+
| **storefront_oid** | **Integer** | | |
|
|
12332
|
+
| **item_preorder_children_request** | [**SfvbItemPreorderChildrenRequest**](SfvbItemPreorderChildrenRequest.md) | The change and the variations | |
|
|
12333
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
12334
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
12335
|
+
| **approval_id** | **String** | The approval_id of an approved item.preorder request for the parent and this change. Required when the change puts any variation on or off pre-order. See POST /sfvb/approvals. | [optional] |
|
|
12336
|
+
|
|
12337
|
+
### Return type
|
|
12338
|
+
|
|
12339
|
+
[**SfvbItemPreorderListResponse**](SfvbItemPreorderListResponse.md)
|
|
12340
|
+
|
|
12341
|
+
### Authorization
|
|
12342
|
+
|
|
12343
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
12344
|
+
|
|
12345
|
+
### HTTP request headers
|
|
12346
|
+
|
|
12347
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
12348
|
+
- **Accept**: application/json
|
|
12349
|
+
|
|
12350
|
+
|
|
12122
12351
|
## put_sfvb_item_pricing
|
|
12123
12352
|
|
|
12124
12353
|
> <SfvbItemPricing> put_sfvb_item_pricing(storefront_oid, if_match, item_pricing_request, opts)
|
|
@@ -12,6 +12,8 @@
|
|
|
12
12
|
| **experiment_start** | [**SfvbExperimentStartRequest**](SfvbExperimentStartRequest.md) | | [optional] |
|
|
13
13
|
| **flow_backfill** | [**SfvbFlowBackfillRequest**](SfvbFlowBackfillRequest.md) | | [optional] |
|
|
14
14
|
| **item_attribute_rows** | [**Array<SfvbItemAttributeBatchRow>**](SfvbItemAttributeBatchRow.md) | For item.attribute_batch, exactly the rows the batch will send - the dry run's change rows, each with merchant_item_oid and current_sha256. UltraCart keeps only their hash. | [optional] |
|
|
15
|
+
| **item_preorder** | [**SfvbItemPreorderRequest**](SfvbItemPreorderRequest.md) | | [optional] |
|
|
16
|
+
| **item_preorder_children** | [**SfvbItemPreorderChildrenRequest**](SfvbItemPreorderChildrenRequest.md) | | [optional] |
|
|
15
17
|
| **item_pricing** | [**SfvbItemPricingRequest**](SfvbItemPricingRequest.md) | | [optional] |
|
|
16
18
|
| **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
|
|
17
19
|
| **postcard_test_mail** | [**SfvbCommsTestPostcardRequest**](SfvbCommsTestPostcardRequest.md) | | [optional] |
|
|
@@ -37,6 +39,8 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
|
|
|
37
39
|
experiment_start: null,
|
|
38
40
|
flow_backfill: null,
|
|
39
41
|
item_attribute_rows: null,
|
|
42
|
+
item_preorder: null,
|
|
43
|
+
item_preorder_children: null,
|
|
40
44
|
item_pricing: null,
|
|
41
45
|
params: null,
|
|
42
46
|
postcard_test_mail: null,
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPreorder
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **changed** | [**SfvbItemPreorderChange**](SfvbItemPreorderChange.md) | | [optional] |
|
|
8
|
+
| **eta** | **String** | The expected date, YYYY-MM-DD, or null when none is set. | [optional] |
|
|
9
|
+
| **hash_sha256** | **String** | The hash of preorder and eta. Send it as If-Match, or as the row's hash_sha256, to change them. | [optional] |
|
|
10
|
+
| **merchant_item_id** | **String** | The item's merchant item id. | [optional] |
|
|
11
|
+
| **merchant_item_oid** | **Integer** | The item. | [optional] |
|
|
12
|
+
| **preorder** | **Boolean** | True when the item is on pre-order. Shoppers can order it while out of stock, and its orders go to the Pre-ordered stage. | [optional] |
|
|
13
|
+
| **shoppers_see** | **String** | What itempreorder shows. preorder_with_eta when on pre-order with an ETA of today or later, preorder_no_eta when on pre-order with no ETA or a past one, nothing when not on pre-order. | [optional] |
|
|
14
|
+
| **shoppers_see_text** | **String** | shoppers_see in words, such as on pre-order, ETA 2026-11-20. | [optional] |
|
|
15
|
+
| **variation_values** | [**Array<SfvbItemPreorderOption>**](SfvbItemPreorderOption.md) | For a variation listed under its parent, the option values that pick it, such as Size 2T. | [optional] |
|
|
16
|
+
| **warnings** | **Array<String>** | After a change, things worth knowing about the new values, such as an ETA in the past. Never a refusal. | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::SfvbItemPreorder.new(
|
|
24
|
+
changed: null,
|
|
25
|
+
eta: null,
|
|
26
|
+
hash_sha256: null,
|
|
27
|
+
merchant_item_id: null,
|
|
28
|
+
merchant_item_oid: null,
|
|
29
|
+
preorder: null,
|
|
30
|
+
shoppers_see: null,
|
|
31
|
+
shoppers_see_text: null,
|
|
32
|
+
variation_values: null,
|
|
33
|
+
warnings: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPreorderChange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **eta_after** | **String** | The ETA after the change, YYYY-MM-DD, or null. | [optional] |
|
|
8
|
+
| **eta_before** | **String** | The ETA before the change, YYYY-MM-DD, or null. | [optional] |
|
|
9
|
+
| **preorder_after** | **Boolean** | Pre-order after the change. | [optional] |
|
|
10
|
+
| **preorder_before** | **Boolean** | Pre-order before the change. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbItemPreorderChange.new(
|
|
18
|
+
eta_after: null,
|
|
19
|
+
eta_before: null,
|
|
20
|
+
preorder_after: null,
|
|
21
|
+
preorder_before: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPreorderChildRow
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **child** | **String** | The variation's merchant item id, or an option value that exactly one variation of the parent has, such as 2T. | [optional] |
|
|
8
|
+
| **hash_sha256** | **String** | The variation's hash_sha256 from the read. Required. A stale hash refuses the whole call. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbItemPreorderChildRow.new(
|
|
16
|
+
child: null,
|
|
17
|
+
hash_sha256: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPreorderChildrenRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **children** | [**Array<SfvbItemPreorderChildRow>**](SfvbItemPreorderChildRow.md) | The variations to change, 1 to 100, each named once. | [optional] |
|
|
8
|
+
| **clear_eta** | **Boolean** | True to remove the ETA from every variation named. Not with eta. | [optional] |
|
|
9
|
+
| **eta** | **String** | The expected date for every variation named, YYYY-MM-DD. Not with clear_eta. | [optional] |
|
|
10
|
+
| **preorder** | **Boolean** | True to put the variations on pre-order, false to take them off. Needs an approved item.preorder request when it changes any of them. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbItemPreorderChildrenRequest.new(
|
|
18
|
+
children: null,
|
|
19
|
+
clear_eta: null,
|
|
20
|
+
eta: null,
|
|
21
|
+
preorder: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPreorderListResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **children** | [**Array<SfvbItemPreorder>**](SfvbItemPreorder.md) | Each variation, with the option values that pick it. After a change, the variations named, in the order sent. | [optional] |
|
|
8
|
+
| **parent** | [**SfvbItemPreorder**](SfvbItemPreorder.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbItemPreorderListResponse.new(
|
|
16
|
+
children: null,
|
|
17
|
+
parent: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPreorderOption
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The variation's name, such as Size. | [optional] |
|
|
8
|
+
| **value** | **String** | The option value, such as 2T. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbItemPreorderOption.new(
|
|
16
|
+
name: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemPreorderRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **clear_eta** | **Boolean** | True to remove the ETA. Not with eta. | [optional] |
|
|
8
|
+
| **eta** | **String** | The expected date, YYYY-MM-DD. Not with clear_eta. | [optional] |
|
|
9
|
+
| **preorder** | **Boolean** | True to put the item on pre-order, false to take it off. Either needs an approved item.preorder request when it changes the item. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbItemPreorderRequest.new(
|
|
17
|
+
clear_eta: null,
|
|
18
|
+
eta: null,
|
|
19
|
+
preorder: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -16,6 +16,7 @@
|
|
|
16
16
|
| **klaviyo_private_api_key** | **String** | Klaviyo API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.klaviyo.private_api_key, or an empty string to clear it. | [optional] |
|
|
17
17
|
| **nextdoor_access_token** | **String** | Nextdoor Access Token. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.nextdoor.access_token, or an empty string to clear it. | [optional] |
|
|
18
18
|
| **northbeam_api_key** | **String** | Northbeam API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.northbeam.api_key, or an empty string to clear it. | [optional] |
|
|
19
|
+
| **openai_conversions_api_key** | **String** | OpenAI Conversions API Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.openai.conversions_api_key, or an empty string to clear it. | [optional] |
|
|
19
20
|
| **pinterest_token** | **String** | Pinterest Conversion Token. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.pinterest.capi_token, or an empty string to clear it. | [optional] |
|
|
20
21
|
| **referralcandy_secret_key** | **String** | ReferralCandy Secret Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.referralcandy.secret_key, or an empty string to clear it. | [optional] |
|
|
21
22
|
| **retention_key** | **String** | Retention.com Key. A secret handle (sec_...) made for this storefront by POST secrets with sink tracking.retention.api_key, or an empty string to clear it. | [optional] |
|
|
@@ -38,6 +39,7 @@ instance = UltracartClient::SfvbTrackingProviderSecrets.new(
|
|
|
38
39
|
klaviyo_private_api_key: null,
|
|
39
40
|
nextdoor_access_token: null,
|
|
40
41
|
northbeam_api_key: null,
|
|
42
|
+
openai_conversions_api_key: null,
|
|
41
43
|
pinterest_token: null,
|
|
42
44
|
referralcandy_secret_key: null,
|
|
43
45
|
retention_key: null
|
data/docs/SfvbWhoamiResponse.md
CHANGED
|
@@ -7,9 +7,11 @@
|
|
|
7
7
|
| **acting_as_user** | **Boolean** | True when this token resolves to a merchant user. Preview sessions and file writes need one, because they are recorded against the person who approved the token. Only device flow tokens resolve a user, so a plain API key will see this false. | [optional] |
|
|
8
8
|
| **application_name** | **String** | Description of the application this credential belongs to. | [optional] |
|
|
9
9
|
| **authentication_type** | **String** | How this token authenticated - Oauth2, Simple Key, Public/Private Key or Browser Key. | [optional] |
|
|
10
|
+
| **can_edit_items** | **Boolean** | True when this token may change item data. Needs can_write, and the UltraCart user behind the token must hold Edit Items. A token with no user is judged on its scopes alone. | [optional] |
|
|
10
11
|
| **can_publish** | **Boolean** | True when this token may write a target that is currently live - an active upsell offer, an email on a delivering flow, the active theme, the storefront root. Never infer this; it is the difference between a draft edit and a shopper visible change. | [optional] |
|
|
11
12
|
| **can_publish_public** | **Boolean** | True when this account may publish library entries to the public library. Set by UltraCart staff only. | [optional] |
|
|
12
13
|
| **can_read** | **Boolean** | True when this token may read. Do not infer this from the requested scope name. | [optional] |
|
|
14
|
+
| **can_read_items** | **Boolean** | True when this token may read item data - the item, its pricing, pre-order and related items. Needs can_read, and the UltraCart user behind the token must hold View Items or Edit Items. A token with no user is judged on its scopes alone. | [optional] |
|
|
13
15
|
| **can_write** | **Boolean** | True when this token may write. Writing a target that is not currently live needs only this. | [optional] |
|
|
14
16
|
| **device_scope** | **String** | Device scope name, when this is a device flow token. | [optional] |
|
|
15
17
|
| **login** | **String** | Login of the user who approved this token. Populated for device flow tokens; null for plain API key credentials. | [optional] |
|
|
@@ -28,9 +30,11 @@ instance = UltracartClient::SfvbWhoamiResponse.new(
|
|
|
28
30
|
acting_as_user: null,
|
|
29
31
|
application_name: null,
|
|
30
32
|
authentication_type: null,
|
|
33
|
+
can_edit_items: null,
|
|
31
34
|
can_publish: null,
|
|
32
35
|
can_publish_public: null,
|
|
33
36
|
can_read: null,
|
|
37
|
+
can_read_items: null,
|
|
34
38
|
can_write: null,
|
|
35
39
|
device_scope: null,
|
|
36
40
|
login: null,
|
data/docs/TaxJarConfig.md
CHANGED
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **estimate_only** | **Boolean** | True if this TaxJar configuration is to estimate taxes only and not report placed orders to TaxJar | [optional] |
|
|
10
10
|
| **send_outside_nexus** | **Boolean** | Send orders outside your nexus TaxJar. The default is to not transmit outside orders to TaxJar to reduce API calls. However, this will prevent TaxJar from dynamically creating new Nexus when thresholds are exceeded for a state. | [optional] |
|
|
11
11
|
| **send_test_orders** | **Boolean** | Send test orders through to TaxJar. The default is to not transmit test orders to TaxJar. | [optional] |
|
|
12
|
+
| **skip_calculation_outside_nexus** | **Boolean** | Only calculate tax for states within your nexus. Requires send_outside_nexus to be true. When true, orders outside your nexus are still transmitted to TaxJar for nexus tracking, but no tax calculation is requested for them, reducing API calls. | [optional] |
|
|
12
13
|
| **skip_channel_orders** | **Boolean** | Do not send channel partner orders to TaxJar. Set this to true if your channel partner reports tax on their own. | [optional] |
|
|
13
14
|
| **use_distribution_center_from** | **Boolean** | Use distribution center from address | [optional] |
|
|
14
15
|
|
|
@@ -23,6 +24,7 @@ instance = UltracartClient::TaxJarConfig.new(
|
|
|
23
24
|
estimate_only: null,
|
|
24
25
|
send_outside_nexus: null,
|
|
25
26
|
send_test_orders: null,
|
|
27
|
+
skip_calculation_outside_nexus: null,
|
|
26
28
|
skip_channel_orders: null,
|
|
27
29
|
use_distribution_center_from: null
|
|
28
30
|
)
|