ultracart_api 4.1.239 → 4.1.240
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 +27 -2
- data/docs/SfvbApi.md +337 -0
- data/docs/SfvbApprovalCreateRequest.md +4 -0
- data/docs/SfvbItemChildCreateRequest.md +26 -0
- data/docs/SfvbItemChildCreateResponse.md +36 -0
- data/docs/SfvbItemDefaultPageRequest.md +20 -0
- data/docs/SfvbItemDefaultPageResponse.md +36 -0
- data/docs/SfvbItemDefaultPageResult.md +40 -0
- data/docs/SfvbItemDefaultPageRow.md +28 -0
- data/docs/SfvbItemPageAssignment.md +28 -0
- data/docs/SfvbItemPages.md +28 -0
- data/docs/SfvbItemVariationAxis.md +22 -0
- data/docs/SfvbItemVariationChange.md +40 -0
- data/docs/SfvbItemVariationChangeResult.md +24 -0
- data/docs/SfvbItemVariationChild.md +22 -0
- data/docs/SfvbItemVariationCombination.md +24 -0
- data/docs/SfvbItemVariationOption.md +22 -0
- data/docs/SfvbItemVariationValue.md +20 -0
- data/docs/SfvbItemVariations.md +30 -0
- data/docs/SfvbItemVariationsRequest.md +20 -0
- data/docs/SfvbItemVariationsResponse.md +38 -0
- data/lib/ultracart_api/api/sfvb_api.rb +459 -0
- data/lib/ultracart_api/models/sfvb_approval_create_request.rb +24 -3
- data/lib/ultracart_api/models/sfvb_item_child_create_request.rb +260 -0
- data/lib/ultracart_api/models/sfvb_item_child_create_response.rb +309 -0
- data/lib/ultracart_api/models/sfvb_item_default_page_request.rb +232 -0
- data/lib/ultracart_api/models/sfvb_item_default_page_response.rb +312 -0
- data/lib/ultracart_api/models/sfvb_item_default_page_result.rb +330 -0
- data/lib/ultracart_api/models/sfvb_item_default_page_row.rb +270 -0
- data/lib/ultracart_api/models/sfvb_item_page_assignment.rb +270 -0
- data/lib/ultracart_api/models/sfvb_item_pages.rb +274 -0
- data/lib/ultracart_api/models/sfvb_item_variation_axis.rb +242 -0
- data/lib/ultracart_api/models/sfvb_item_variation_change.rb +334 -0
- data/lib/ultracart_api/models/sfvb_item_variation_change_result.rb +250 -0
- data/lib/ultracart_api/models/sfvb_item_variation_child.rb +240 -0
- data/lib/ultracart_api/models/sfvb_item_variation_combination.rb +251 -0
- data/lib/ultracart_api/models/sfvb_item_variation_option.rb +240 -0
- data/lib/ultracart_api/models/sfvb_item_variation_value.rb +230 -0
- data/lib/ultracart_api/models/sfvb_item_variations.rb +284 -0
- data/lib/ultracart_api/models/sfvb_item_variations_request.rb +232 -0
- data/lib/ultracart_api/models/sfvb_item_variations_response.rb +328 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +18 -0
- metadata +37 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ebf953d69f3ddcc5200f34fa08a84e21fc6ccdd80492b128b7a311f6e058ebe7
|
|
4
|
+
data.tar.gz: 027405e3cbb381212cb577750e02865dec6588d7b01ce6144ca137b4c3264824
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 983d8fa0feac3cb0df5503115ee380005d2fd69a3e13a2a7e86a8f145671167c657467adf4d8da44c9eba9d8f8a3d8f32ee22f994afd9a3c8dd32fcff079408b
|
|
7
|
+
data.tar.gz: 60c2ec07dfe72d7c97f393ea9bddc7c26be5922edf5e0b37104b82dff4ede44c3779b596cc5b54c9a9aacf5d391902006184eb825cc83f14f2a8c35817848b57
|
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.240
|
|
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.240'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -523,6 +523,7 @@ Class | Method | HTTP request | Description
|
|
|
523
523
|
*UltracartClient::SfvbApi* | [**disable_sfvb_upsell_path**](docs/SfvbApi.md#disable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/disable | Disable an upsell path
|
|
524
524
|
*UltracartClient::SfvbApi* | [**download_sfvb_file**](docs/SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes
|
|
525
525
|
*UltracartClient::SfvbApi* | [**dry_run_sfvb_item_attribute_batch**](docs/SfvbApi.md#dry_run_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch/dry_run | Check attribute changes across many items without writing them
|
|
526
|
+
*UltracartClient::SfvbApi* | [**dry_run_sfvb_item_default_page**](docs/SfvbApi.md#dry_run_sfvb_item_default_page) | **POST** /sfvb/storefronts/{storefront_oid}/items/default_page/dry_run | Check moving items' default (canonical) pages
|
|
526
527
|
*UltracartClient::SfvbApi* | [**dry_run_sfvb_redirect_delete**](docs/SfvbApi.md#dry_run_sfvb_redirect_delete) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete/dry_run | Check a batch delete of redirect rules without writing it
|
|
527
528
|
*UltracartClient::SfvbApi* | [**dry_run_sfvb_redirect_import**](docs/SfvbApi.md#dry_run_sfvb_redirect_import) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import/dry_run | Check a redirect import without writing it
|
|
528
529
|
*UltracartClient::SfvbApi* | [**duplicate_sfvb_library_entry**](docs/SfvbApi.md#duplicate_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/duplicate | Copy a library entry into a new private entry
|
|
@@ -586,10 +587,12 @@ Class | Method | HTTP request | Description
|
|
|
586
587
|
*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
588
|
*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
589
|
*UltracartClient::SfvbApi* | [**get_sfvb_item**](docs/SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content
|
|
590
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_item_pages**](docs/SfvbApi.md#get_sfvb_item_pages) | **GET** /sfvb/storefronts/{storefront_oid}/items/pages | Read the pages an item is on and its default page
|
|
589
591
|
*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
592
|
*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
|
|
591
593
|
*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
|
|
592
594
|
*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
|
|
595
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_item_variations**](docs/SfvbApi.md#get_sfvb_item_variations) | **GET** /sfvb/storefronts/{storefront_oid}/items/variations | Read an item's variations
|
|
593
596
|
*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
|
|
594
597
|
*UltracartClient::SfvbApi* | [**get_sfvb_library_history**](docs/SfvbApi.md#get_sfvb_library_history) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/history | List a library entry's published revisions
|
|
595
598
|
*UltracartClient::SfvbApi* | [**get_sfvb_library_share_targets**](docs/SfvbApi.md#get_sfvb_library_share_targets) | **GET** /sfvb/storefronts/{storefront_oid}/library/share_targets | List the accounts a library entry can be shared with
|
|
@@ -653,6 +656,7 @@ Class | Method | HTTP request | Description
|
|
|
653
656
|
*UltracartClient::SfvbApi* | [**insert_sfvb_comms_sending_domain**](docs/SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain
|
|
654
657
|
*UltracartClient::SfvbApi* | [**insert_sfvb_comms_twilio_account**](docs/SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account
|
|
655
658
|
*UltracartClient::SfvbApi* | [**insert_sfvb_docs_gap**](docs/SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report
|
|
659
|
+
*UltracartClient::SfvbApi* | [**insert_sfvb_item_child**](docs/SfvbApi.md#insert_sfvb_item_child) | **POST** /sfvb/storefronts/{storefront_oid}/items/children | Create a child item for a parent's variations
|
|
656
660
|
*UltracartClient::SfvbApi* | [**insert_sfvb_page**](docs/SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page
|
|
657
661
|
*UltracartClient::SfvbApi* | [**insert_sfvb_redirect**](docs/SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule
|
|
658
662
|
*UltracartClient::SfvbApi* | [**insert_sfvb_secret_request**](docs/SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values
|
|
@@ -700,6 +704,7 @@ Class | Method | HTTP request | Description
|
|
|
700
704
|
*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
|
|
701
705
|
*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
|
|
702
706
|
*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
|
|
707
|
+
*UltracartClient::SfvbApi* | [**put_sfvb_item_variations**](docs/SfvbApi.md#put_sfvb_item_variations) | **PUT** /sfvb/storefronts/{storefront_oid}/items/variations | Change an item's variations
|
|
703
708
|
*UltracartClient::SfvbApi* | [**put_sfvb_menu**](docs/SfvbApi.md#put_sfvb_menu) | **PUT** /sfvb/storefronts/{storefront_oid}/menus/{code} | Replace a store menu's entries
|
|
704
709
|
*UltracartClient::SfvbApi* | [**put_sfvb_page_attributes**](docs/SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes
|
|
705
710
|
*UltracartClient::SfvbApi* | [**put_sfvb_page_multimedia**](docs/SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page
|
|
@@ -755,6 +760,7 @@ Class | Method | HTTP request | Description
|
|
|
755
760
|
*UltracartClient::SfvbApi* | [**update_sfvb_flow**](docs/SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow
|
|
756
761
|
*UltracartClient::SfvbApi* | [**update_sfvb_flow_status**](docs/SfvbApi.md#update_sfvb_flow_status) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/status | Turn a flow on or off
|
|
757
762
|
*UltracartClient::SfvbApi* | [**update_sfvb_item_attribute_batch**](docs/SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call
|
|
763
|
+
*UltracartClient::SfvbApi* | [**update_sfvb_item_default_page**](docs/SfvbApi.md#update_sfvb_item_default_page) | **POST** /sfvb/storefronts/{storefront_oid}/items/default_page | Move items' default (canonical) pages
|
|
758
764
|
*UltracartClient::SfvbApi* | [**update_sfvb_library_entry**](docs/SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft
|
|
759
765
|
*UltracartClient::SfvbApi* | [**update_sfvb_redirect**](docs/SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule
|
|
760
766
|
*UltracartClient::SfvbApi* | [**update_sfvb_sequence_step**](docs/SfvbApi.md#update_sfvb_sequence_step) | **PUT** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Change one step's settings or audience filter
|
|
@@ -2153,12 +2159,20 @@ Class | Method | HTTP request | Description
|
|
|
2153
2159
|
- [UltracartClient::SfvbItemAttributeBatchRowResult](docs/SfvbItemAttributeBatchRowResult.md)
|
|
2154
2160
|
- [UltracartClient::SfvbItemAttributeUpdate](docs/SfvbItemAttributeUpdate.md)
|
|
2155
2161
|
- [UltracartClient::SfvbItemAttributeUpdateRequest](docs/SfvbItemAttributeUpdateRequest.md)
|
|
2162
|
+
- [UltracartClient::SfvbItemChildCreateRequest](docs/SfvbItemChildCreateRequest.md)
|
|
2163
|
+
- [UltracartClient::SfvbItemChildCreateResponse](docs/SfvbItemChildCreateResponse.md)
|
|
2156
2164
|
- [UltracartClient::SfvbItemContainer](docs/SfvbItemContainer.md)
|
|
2157
2165
|
- [UltracartClient::SfvbItemContainersResponse](docs/SfvbItemContainersResponse.md)
|
|
2158
2166
|
- [UltracartClient::SfvbItemContentRequest](docs/SfvbItemContentRequest.md)
|
|
2167
|
+
- [UltracartClient::SfvbItemDefaultPageRequest](docs/SfvbItemDefaultPageRequest.md)
|
|
2168
|
+
- [UltracartClient::SfvbItemDefaultPageResponse](docs/SfvbItemDefaultPageResponse.md)
|
|
2169
|
+
- [UltracartClient::SfvbItemDefaultPageResult](docs/SfvbItemDefaultPageResult.md)
|
|
2170
|
+
- [UltracartClient::SfvbItemDefaultPageRow](docs/SfvbItemDefaultPageRow.md)
|
|
2159
2171
|
- [UltracartClient::SfvbItemMultimedia](docs/SfvbItemMultimedia.md)
|
|
2160
2172
|
- [UltracartClient::SfvbItemMultimediaDescriptionRequest](docs/SfvbItemMultimediaDescriptionRequest.md)
|
|
2161
2173
|
- [UltracartClient::SfvbItemMultimediaRequest](docs/SfvbItemMultimediaRequest.md)
|
|
2174
|
+
- [UltracartClient::SfvbItemPageAssignment](docs/SfvbItemPageAssignment.md)
|
|
2175
|
+
- [UltracartClient::SfvbItemPages](docs/SfvbItemPages.md)
|
|
2162
2176
|
- [UltracartClient::SfvbItemPreorder](docs/SfvbItemPreorder.md)
|
|
2163
2177
|
- [UltracartClient::SfvbItemPreorderChange](docs/SfvbItemPreorderChange.md)
|
|
2164
2178
|
- [UltracartClient::SfvbItemPreorderChildRow](docs/SfvbItemPreorderChildRow.md)
|
|
@@ -2175,6 +2189,16 @@ Class | Method | HTTP request | Description
|
|
|
2175
2189
|
- [UltracartClient::SfvbItemSeo](docs/SfvbItemSeo.md)
|
|
2176
2190
|
- [UltracartClient::SfvbItemSeoRequest](docs/SfvbItemSeoRequest.md)
|
|
2177
2191
|
- [UltracartClient::SfvbItemTags](docs/SfvbItemTags.md)
|
|
2192
|
+
- [UltracartClient::SfvbItemVariationAxis](docs/SfvbItemVariationAxis.md)
|
|
2193
|
+
- [UltracartClient::SfvbItemVariationChange](docs/SfvbItemVariationChange.md)
|
|
2194
|
+
- [UltracartClient::SfvbItemVariationChangeResult](docs/SfvbItemVariationChangeResult.md)
|
|
2195
|
+
- [UltracartClient::SfvbItemVariationChild](docs/SfvbItemVariationChild.md)
|
|
2196
|
+
- [UltracartClient::SfvbItemVariationCombination](docs/SfvbItemVariationCombination.md)
|
|
2197
|
+
- [UltracartClient::SfvbItemVariationOption](docs/SfvbItemVariationOption.md)
|
|
2198
|
+
- [UltracartClient::SfvbItemVariationValue](docs/SfvbItemVariationValue.md)
|
|
2199
|
+
- [UltracartClient::SfvbItemVariations](docs/SfvbItemVariations.md)
|
|
2200
|
+
- [UltracartClient::SfvbItemVariationsRequest](docs/SfvbItemVariationsRequest.md)
|
|
2201
|
+
- [UltracartClient::SfvbItemVariationsResponse](docs/SfvbItemVariationsResponse.md)
|
|
2178
2202
|
- [UltracartClient::SfvbItemVolumeDiscount](docs/SfvbItemVolumeDiscount.md)
|
|
2179
2203
|
- [UltracartClient::SfvbLibraryAiReview](docs/SfvbLibraryAiReview.md)
|
|
2180
2204
|
- [UltracartClient::SfvbLibraryContentManifest](docs/SfvbLibraryContentManifest.md)
|
|
@@ -2556,6 +2580,7 @@ Not every change is committed to every SDK.
|
|
|
2556
2580
|
|
|
2557
2581
|
| Version | Date | Comments |
|
|
2558
2582
|
| --: | :-: | --- |
|
|
2583
|
+
| 4.1.240 | 11/10/2026 | sfvb internal testing |
|
|
2559
2584
|
| 4.1.239 | 11/10/2026 | sfvb internal testing |
|
|
2560
2585
|
| 4.1.238 | 11/10/2026 | sfvb internal testing |
|
|
2561
2586
|
| 4.1.237 | 11/10/2026 | sfvb internal testing |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -51,6 +51,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
51
51
|
| [**disable_sfvb_upsell_path**](SfvbApi.md#disable_sfvb_upsell_path) | **POST** /sfvb/storefronts/{storefront_oid}/upsell_paths/{upsell_path_oid}/disable | Disable an upsell path |
|
|
52
52
|
| [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
|
|
53
53
|
| [**dry_run_sfvb_item_attribute_batch**](SfvbApi.md#dry_run_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch/dry_run | Check attribute changes across many items without writing them |
|
|
54
|
+
| [**dry_run_sfvb_item_default_page**](SfvbApi.md#dry_run_sfvb_item_default_page) | **POST** /sfvb/storefronts/{storefront_oid}/items/default_page/dry_run | Check moving items' default (canonical) pages |
|
|
54
55
|
| [**dry_run_sfvb_redirect_delete**](SfvbApi.md#dry_run_sfvb_redirect_delete) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/delete/dry_run | Check a batch delete of redirect rules without writing it |
|
|
55
56
|
| [**dry_run_sfvb_redirect_import**](SfvbApi.md#dry_run_sfvb_redirect_import) | **POST** /sfvb/storefronts/{storefront_oid}/redirects/import/dry_run | Check a redirect import without writing it |
|
|
56
57
|
| [**duplicate_sfvb_library_entry**](SfvbApi.md#duplicate_sfvb_library_entry) | **POST** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/duplicate | Copy a library entry into a new private entry |
|
|
@@ -114,10 +115,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
114
115
|
| [**get_sfvb_i18n_message**](SfvbApi.md#get_sfvb_i18n_message) | **GET** /sfvb/storefronts/{storefront_oid}/i18n/messages/{key} | Read one built-in message |
|
|
115
116
|
| [**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
117
|
| [**get_sfvb_item**](SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content |
|
|
118
|
+
| [**get_sfvb_item_pages**](SfvbApi.md#get_sfvb_item_pages) | **GET** /sfvb/storefronts/{storefront_oid}/items/pages | Read the pages an item is on and its default page |
|
|
117
119
|
| [**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
120
|
| [**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 |
|
|
119
121
|
| [**get_sfvb_item_pricing**](SfvbApi.md#get_sfvb_item_pricing) | **GET** /sfvb/storefronts/{storefront_oid}/items/pricing | Read what an item charges |
|
|
120
122
|
| [**get_sfvb_item_related**](SfvbApi.md#get_sfvb_item_related) | **GET** /sfvb/storefronts/{storefront_oid}/items/related | Read an item's related items |
|
|
123
|
+
| [**get_sfvb_item_variations**](SfvbApi.md#get_sfvb_item_variations) | **GET** /sfvb/storefronts/{storefront_oid}/items/variations | Read an item's variations |
|
|
121
124
|
| [**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 |
|
|
122
125
|
| [**get_sfvb_library_history**](SfvbApi.md#get_sfvb_library_history) | **GET** /sfvb/storefronts/{storefront_oid}/library/{library_oid}/history | List a library entry's published revisions |
|
|
123
126
|
| [**get_sfvb_library_share_targets**](SfvbApi.md#get_sfvb_library_share_targets) | **GET** /sfvb/storefronts/{storefront_oid}/library/share_targets | List the accounts a library entry can be shared with |
|
|
@@ -181,6 +184,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
181
184
|
| [**insert_sfvb_comms_sending_domain**](SfvbApi.md#insert_sfvb_comms_sending_domain) | **POST** /sfvb/comms/sending_domains | Add a sending domain |
|
|
182
185
|
| [**insert_sfvb_comms_twilio_account**](SfvbApi.md#insert_sfvb_comms_twilio_account) | **POST** /sfvb/comms/twilio_account | Connect the Twilio account |
|
|
183
186
|
| [**insert_sfvb_docs_gap**](SfvbApi.md#insert_sfvb_docs_gap) | **POST** /sfvb/docs/gaps | Send UltraCart a documentation-gap report |
|
|
187
|
+
| [**insert_sfvb_item_child**](SfvbApi.md#insert_sfvb_item_child) | **POST** /sfvb/storefronts/{storefront_oid}/items/children | Create a child item for a parent's variations |
|
|
184
188
|
| [**insert_sfvb_page**](SfvbApi.md#insert_sfvb_page) | **POST** /sfvb/storefronts/{storefront_oid}/pages | Create a page |
|
|
185
189
|
| [**insert_sfvb_redirect**](SfvbApi.md#insert_sfvb_redirect) | **POST** /sfvb/storefronts/{storefront_oid}/redirects | Create a 301 redirect rule |
|
|
186
190
|
| [**insert_sfvb_secret_request**](SfvbApi.md#insert_sfvb_secret_request) | **POST** /sfvb/secrets | Ask a person to enter secret values |
|
|
@@ -228,6 +232,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
228
232
|
| [**put_sfvb_item_pricing**](SfvbApi.md#put_sfvb_item_pricing) | **PUT** /sfvb/storefronts/{storefront_oid}/items/pricing | Change what an item charges |
|
|
229
233
|
| [**put_sfvb_item_related**](SfvbApi.md#put_sfvb_item_related) | **PUT** /sfvb/storefronts/{storefront_oid}/items/related | Replace an item's related items |
|
|
230
234
|
| [**put_sfvb_item_seo**](SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata |
|
|
235
|
+
| [**put_sfvb_item_variations**](SfvbApi.md#put_sfvb_item_variations) | **PUT** /sfvb/storefronts/{storefront_oid}/items/variations | Change an item's variations |
|
|
231
236
|
| [**put_sfvb_menu**](SfvbApi.md#put_sfvb_menu) | **PUT** /sfvb/storefronts/{storefront_oid}/menus/{code} | Replace a store menu's entries |
|
|
232
237
|
| [**put_sfvb_page_attributes**](SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes |
|
|
233
238
|
| [**put_sfvb_page_multimedia**](SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page |
|
|
@@ -283,6 +288,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
283
288
|
| [**update_sfvb_flow**](SfvbApi.md#update_sfvb_flow) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid} | Change a flow |
|
|
284
289
|
| [**update_sfvb_flow_status**](SfvbApi.md#update_sfvb_flow_status) | **PUT** /sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}/status | Turn a flow on or off |
|
|
285
290
|
| [**update_sfvb_item_attribute_batch**](SfvbApi.md#update_sfvb_item_attribute_batch) | **POST** /sfvb/storefronts/{storefront_oid}/items/attributes/batch | Change attributes across many items in one call |
|
|
291
|
+
| [**update_sfvb_item_default_page**](SfvbApi.md#update_sfvb_item_default_page) | **POST** /sfvb/storefronts/{storefront_oid}/items/default_page | Move items' default (canonical) pages |
|
|
286
292
|
| [**update_sfvb_library_entry**](SfvbApi.md#update_sfvb_library_entry) | **PUT** /sfvb/storefronts/{storefront_oid}/library/{library_oid} | Update a library entry's draft |
|
|
287
293
|
| [**update_sfvb_redirect**](SfvbApi.md#update_sfvb_redirect) | **PUT** /sfvb/storefronts/{storefront_oid}/redirects/{redirect_id} | Change a redirect rule |
|
|
288
294
|
| [**update_sfvb_sequence_step**](SfvbApi.md#update_sfvb_sequence_step) | **PUT** /sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid} | Change one step's settings or audience filter |
|
|
@@ -2875,6 +2881,60 @@ end
|
|
|
2875
2881
|
- **Accept**: application/json
|
|
2876
2882
|
|
|
2877
2883
|
|
|
2884
|
+
## dry_run_sfvb_item_default_page
|
|
2885
|
+
|
|
2886
|
+
> <SfvbItemDefaultPageResponse> dry_run_sfvb_item_default_page(storefront_oid, item_default_page_request)
|
|
2887
|
+
|
|
2888
|
+
Check moving items' default (canonical) pages
|
|
2889
|
+
|
|
2890
|
+
Checks up to 2,000 rows on up to 200 items, each naming an item and a page it is already on, and saves nothing. Each row answers ready, already_default, target_not_found, target_not_on_host, target_not_assigned, target_hidden (refused - a hidden page isn't served to shoppers), item_not_found, invalid or stale, with the item's current default and current_sha256. rows_sha256 covers the ready rows - request item.default_page with exactly those rows, then apply them.
|
|
2891
|
+
|
|
2892
|
+
|
|
2893
|
+
### Examples
|
|
2894
|
+
|
|
2895
|
+
|
|
2896
|
+
(No example for this operation).
|
|
2897
|
+
|
|
2898
|
+
|
|
2899
|
+
#### Using the dry_run_sfvb_item_default_page_with_http_info variant
|
|
2900
|
+
|
|
2901
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2902
|
+
|
|
2903
|
+
> <Array(<SfvbItemDefaultPageResponse>, Integer, Hash)> dry_run_sfvb_item_default_page_with_http_info(storefront_oid, item_default_page_request)
|
|
2904
|
+
|
|
2905
|
+
```ruby
|
|
2906
|
+
begin
|
|
2907
|
+
# Check moving items' default (canonical) pages
|
|
2908
|
+
data, status_code, headers = api_instance.dry_run_sfvb_item_default_page_with_http_info(storefront_oid, item_default_page_request)
|
|
2909
|
+
p status_code # => 2xx
|
|
2910
|
+
p headers # => { ... }
|
|
2911
|
+
p data # => <SfvbItemDefaultPageResponse>
|
|
2912
|
+
rescue UltracartClient::ApiError => e
|
|
2913
|
+
puts "Error when calling SfvbApi->dry_run_sfvb_item_default_page_with_http_info: #{e}"
|
|
2914
|
+
end
|
|
2915
|
+
```
|
|
2916
|
+
|
|
2917
|
+
### Parameters
|
|
2918
|
+
|
|
2919
|
+
| Name | Type | Description | Notes |
|
|
2920
|
+
| ---- | ---- | ----------- | ----- |
|
|
2921
|
+
| **storefront_oid** | **Integer** | | |
|
|
2922
|
+
| **item_default_page_request** | [**SfvbItemDefaultPageRequest**](SfvbItemDefaultPageRequest.md) | The rows | |
|
|
2923
|
+
|
|
2924
|
+
### Return type
|
|
2925
|
+
|
|
2926
|
+
[**SfvbItemDefaultPageResponse**](SfvbItemDefaultPageResponse.md)
|
|
2927
|
+
|
|
2928
|
+
### Authorization
|
|
2929
|
+
|
|
2930
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
2931
|
+
|
|
2932
|
+
### HTTP request headers
|
|
2933
|
+
|
|
2934
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
2935
|
+
- **Accept**: application/json
|
|
2936
|
+
|
|
2937
|
+
|
|
2878
2938
|
## dry_run_sfvb_redirect_delete
|
|
2879
2939
|
|
|
2880
2940
|
> <SfvbRedirectDeleteResponse> dry_run_sfvb_redirect_delete(storefront_oid, redirect_delete_request)
|
|
@@ -6278,6 +6338,61 @@ end
|
|
|
6278
6338
|
- **Accept**: application/json
|
|
6279
6339
|
|
|
6280
6340
|
|
|
6341
|
+
## get_sfvb_item_pages
|
|
6342
|
+
|
|
6343
|
+
> <SfvbItemPages> get_sfvb_item_pages(storefront_oid, opts)
|
|
6344
|
+
|
|
6345
|
+
Read the pages an item is on and its default page
|
|
6346
|
+
|
|
6347
|
+
Every page the item is assigned to on this storefront, whether each is visible, and which is the default - the page the item's canonical link uses. Another storefront's pages aren't listed. hash_sha256 is the same value the default-page dry run reports as current_sha256. Address the item by merchant_item_id or merchant_item_oid.
|
|
6348
|
+
|
|
6349
|
+
|
|
6350
|
+
### Examples
|
|
6351
|
+
|
|
6352
|
+
|
|
6353
|
+
(No example for this operation).
|
|
6354
|
+
|
|
6355
|
+
|
|
6356
|
+
#### Using the get_sfvb_item_pages_with_http_info variant
|
|
6357
|
+
|
|
6358
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6359
|
+
|
|
6360
|
+
> <Array(<SfvbItemPages>, Integer, Hash)> get_sfvb_item_pages_with_http_info(storefront_oid, opts)
|
|
6361
|
+
|
|
6362
|
+
```ruby
|
|
6363
|
+
begin
|
|
6364
|
+
# Read the pages an item is on and its default page
|
|
6365
|
+
data, status_code, headers = api_instance.get_sfvb_item_pages_with_http_info(storefront_oid, opts)
|
|
6366
|
+
p status_code # => 2xx
|
|
6367
|
+
p headers # => { ... }
|
|
6368
|
+
p data # => <SfvbItemPages>
|
|
6369
|
+
rescue UltracartClient::ApiError => e
|
|
6370
|
+
puts "Error when calling SfvbApi->get_sfvb_item_pages_with_http_info: #{e}"
|
|
6371
|
+
end
|
|
6372
|
+
```
|
|
6373
|
+
|
|
6374
|
+
### Parameters
|
|
6375
|
+
|
|
6376
|
+
| Name | Type | Description | Notes |
|
|
6377
|
+
| ---- | ---- | ----------- | ----- |
|
|
6378
|
+
| **storefront_oid** | **Integer** | | |
|
|
6379
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
6380
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
6381
|
+
|
|
6382
|
+
### Return type
|
|
6383
|
+
|
|
6384
|
+
[**SfvbItemPages**](SfvbItemPages.md)
|
|
6385
|
+
|
|
6386
|
+
### Authorization
|
|
6387
|
+
|
|
6388
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6389
|
+
|
|
6390
|
+
### HTTP request headers
|
|
6391
|
+
|
|
6392
|
+
- **Content-Type**: Not defined
|
|
6393
|
+
- **Accept**: application/json
|
|
6394
|
+
|
|
6395
|
+
|
|
6281
6396
|
## get_sfvb_item_preorder
|
|
6282
6397
|
|
|
6283
6398
|
> <SfvbItemPreorder> get_sfvb_item_preorder(storefront_oid, opts)
|
|
@@ -6498,6 +6613,61 @@ end
|
|
|
6498
6613
|
- **Accept**: application/json
|
|
6499
6614
|
|
|
6500
6615
|
|
|
6616
|
+
## get_sfvb_item_variations
|
|
6617
|
+
|
|
6618
|
+
> <SfvbItemVariations> get_sfvb_item_variations(storefront_oid, opts)
|
|
6619
|
+
|
|
6620
|
+
Read an item's variations
|
|
6621
|
+
|
|
6622
|
+
The variation axes, such as Size, with their options in the order shoppers see them, and every filled combination with the child item it sells and its quantity. A combination not listed has no child, and storefronts show it as unavailable. hash_sha256 goes back as If-Match on the update. Address the parent by merchant_item_id or merchant_item_oid.
|
|
6623
|
+
|
|
6624
|
+
|
|
6625
|
+
### Examples
|
|
6626
|
+
|
|
6627
|
+
|
|
6628
|
+
(No example for this operation).
|
|
6629
|
+
|
|
6630
|
+
|
|
6631
|
+
#### Using the get_sfvb_item_variations_with_http_info variant
|
|
6632
|
+
|
|
6633
|
+
This returns an Array which contains the response data, status code and headers.
|
|
6634
|
+
|
|
6635
|
+
> <Array(<SfvbItemVariations>, Integer, Hash)> get_sfvb_item_variations_with_http_info(storefront_oid, opts)
|
|
6636
|
+
|
|
6637
|
+
```ruby
|
|
6638
|
+
begin
|
|
6639
|
+
# Read an item's variations
|
|
6640
|
+
data, status_code, headers = api_instance.get_sfvb_item_variations_with_http_info(storefront_oid, opts)
|
|
6641
|
+
p status_code # => 2xx
|
|
6642
|
+
p headers # => { ... }
|
|
6643
|
+
p data # => <SfvbItemVariations>
|
|
6644
|
+
rescue UltracartClient::ApiError => e
|
|
6645
|
+
puts "Error when calling SfvbApi->get_sfvb_item_variations_with_http_info: #{e}"
|
|
6646
|
+
end
|
|
6647
|
+
```
|
|
6648
|
+
|
|
6649
|
+
### Parameters
|
|
6650
|
+
|
|
6651
|
+
| Name | Type | Description | Notes |
|
|
6652
|
+
| ---- | ---- | ----------- | ----- |
|
|
6653
|
+
| **storefront_oid** | **Integer** | | |
|
|
6654
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
6655
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
6656
|
+
|
|
6657
|
+
### Return type
|
|
6658
|
+
|
|
6659
|
+
[**SfvbItemVariations**](SfvbItemVariations.md)
|
|
6660
|
+
|
|
6661
|
+
### Authorization
|
|
6662
|
+
|
|
6663
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
6664
|
+
|
|
6665
|
+
### HTTP request headers
|
|
6666
|
+
|
|
6667
|
+
- **Content-Type**: Not defined
|
|
6668
|
+
- **Accept**: application/json
|
|
6669
|
+
|
|
6670
|
+
|
|
6501
6671
|
## get_sfvb_library_entry
|
|
6502
6672
|
|
|
6503
6673
|
> <SfvbLibraryEntry> get_sfvb_library_entry(storefront_oid, library_oid, opts)
|
|
@@ -9907,6 +10077,60 @@ end
|
|
|
9907
10077
|
- **Accept**: application/json
|
|
9908
10078
|
|
|
9909
10079
|
|
|
10080
|
+
## insert_sfvb_item_child
|
|
10081
|
+
|
|
10082
|
+
> <SfvbItemChildCreateResponse> insert_sfvb_item_child(storefront_oid, item_child_request)
|
|
10083
|
+
|
|
10084
|
+
Create a child item for a parent's variations
|
|
10085
|
+
|
|
10086
|
+
Creates a new item copying the parent's description, cost, weight, dimensions and item folder, so it can be assigned to a combination with the variations update. It is not assigned here and nothing else is copied. merchant_item_id may use letters, digits, dot, underscore and dash, at most 20 characters; an id already on the account is 409 sfvb.item_exists. Needs sfvb_publish when items are live. dry_run checks without creating.
|
|
10087
|
+
|
|
10088
|
+
|
|
10089
|
+
### Examples
|
|
10090
|
+
|
|
10091
|
+
|
|
10092
|
+
(No example for this operation).
|
|
10093
|
+
|
|
10094
|
+
|
|
10095
|
+
#### Using the insert_sfvb_item_child_with_http_info variant
|
|
10096
|
+
|
|
10097
|
+
This returns an Array which contains the response data, status code and headers.
|
|
10098
|
+
|
|
10099
|
+
> <Array(<SfvbItemChildCreateResponse>, Integer, Hash)> insert_sfvb_item_child_with_http_info(storefront_oid, item_child_request)
|
|
10100
|
+
|
|
10101
|
+
```ruby
|
|
10102
|
+
begin
|
|
10103
|
+
# Create a child item for a parent's variations
|
|
10104
|
+
data, status_code, headers = api_instance.insert_sfvb_item_child_with_http_info(storefront_oid, item_child_request)
|
|
10105
|
+
p status_code # => 2xx
|
|
10106
|
+
p headers # => { ... }
|
|
10107
|
+
p data # => <SfvbItemChildCreateResponse>
|
|
10108
|
+
rescue UltracartClient::ApiError => e
|
|
10109
|
+
puts "Error when calling SfvbApi->insert_sfvb_item_child_with_http_info: #{e}"
|
|
10110
|
+
end
|
|
10111
|
+
```
|
|
10112
|
+
|
|
10113
|
+
### Parameters
|
|
10114
|
+
|
|
10115
|
+
| Name | Type | Description | Notes |
|
|
10116
|
+
| ---- | ---- | ----------- | ----- |
|
|
10117
|
+
| **storefront_oid** | **Integer** | | |
|
|
10118
|
+
| **item_child_request** | [**SfvbItemChildCreateRequest**](SfvbItemChildCreateRequest.md) | The child to create | |
|
|
10119
|
+
|
|
10120
|
+
### Return type
|
|
10121
|
+
|
|
10122
|
+
[**SfvbItemChildCreateResponse**](SfvbItemChildCreateResponse.md)
|
|
10123
|
+
|
|
10124
|
+
### Authorization
|
|
10125
|
+
|
|
10126
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
10127
|
+
|
|
10128
|
+
### HTTP request headers
|
|
10129
|
+
|
|
10130
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
10131
|
+
- **Accept**: application/json
|
|
10132
|
+
|
|
10133
|
+
|
|
9910
10134
|
## insert_sfvb_page
|
|
9911
10135
|
|
|
9912
10136
|
> <SfvbPageResponse> insert_sfvb_page(storefront_oid, page_create_request)
|
|
@@ -12519,6 +12743,64 @@ end
|
|
|
12519
12743
|
- **Accept**: application/json
|
|
12520
12744
|
|
|
12521
12745
|
|
|
12746
|
+
## put_sfvb_item_variations
|
|
12747
|
+
|
|
12748
|
+
> <SfvbItemVariationsResponse> put_sfvb_item_variations(storefront_oid, if_match, item_variations_request, opts)
|
|
12749
|
+
|
|
12750
|
+
Change an item's variations
|
|
12751
|
+
|
|
12752
|
+
A list of changes applied in order - add_axis, remove_axis, rename_axis, add_option, remove_option, rename_option, reorder_options, set_default, set_default_text, set_option_multimedia and set_combination. Every change is checked before anything is saved, and nothing the list doesn't mention changes. Child items must already exist; create one with POST items/children. Needs sfvb_publish when items are live and If-Match with the hash_sha256 from the read. Removing an axis, removing an option whose combinations sell a child, or re-pointing or clearing a combination shoppers can buy today also needs the approval of the person who signed in the CLI - an approved item.variations request for this item and exactly this list. Adding never does. dry_run returns the planned variations, what each change does, and whether approval is needed.
|
|
12753
|
+
|
|
12754
|
+
|
|
12755
|
+
### Examples
|
|
12756
|
+
|
|
12757
|
+
|
|
12758
|
+
(No example for this operation).
|
|
12759
|
+
|
|
12760
|
+
|
|
12761
|
+
#### Using the put_sfvb_item_variations_with_http_info variant
|
|
12762
|
+
|
|
12763
|
+
This returns an Array which contains the response data, status code and headers.
|
|
12764
|
+
|
|
12765
|
+
> <Array(<SfvbItemVariationsResponse>, Integer, Hash)> put_sfvb_item_variations_with_http_info(storefront_oid, if_match, item_variations_request, opts)
|
|
12766
|
+
|
|
12767
|
+
```ruby
|
|
12768
|
+
begin
|
|
12769
|
+
# Change an item's variations
|
|
12770
|
+
data, status_code, headers = api_instance.put_sfvb_item_variations_with_http_info(storefront_oid, if_match, item_variations_request, opts)
|
|
12771
|
+
p status_code # => 2xx
|
|
12772
|
+
p headers # => { ... }
|
|
12773
|
+
p data # => <SfvbItemVariationsResponse>
|
|
12774
|
+
rescue UltracartClient::ApiError => e
|
|
12775
|
+
puts "Error when calling SfvbApi->put_sfvb_item_variations_with_http_info: #{e}"
|
|
12776
|
+
end
|
|
12777
|
+
```
|
|
12778
|
+
|
|
12779
|
+
### Parameters
|
|
12780
|
+
|
|
12781
|
+
| Name | Type | Description | Notes |
|
|
12782
|
+
| ---- | ---- | ----------- | ----- |
|
|
12783
|
+
| **storefront_oid** | **Integer** | | |
|
|
12784
|
+
| **if_match** | **String** | hash_sha256 from the variations read. Required; 428 when absent, 412 when stale. | |
|
|
12785
|
+
| **item_variations_request** | [**SfvbItemVariationsRequest**](SfvbItemVariationsRequest.md) | The changes | |
|
|
12786
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
12787
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
12788
|
+
| **approval_id** | **String** | The approval_id of an approved item.variations request for this item and list. Required when the list removes or re-points something shoppers can buy. See POST /sfvb/approvals. | [optional] |
|
|
12789
|
+
|
|
12790
|
+
### Return type
|
|
12791
|
+
|
|
12792
|
+
[**SfvbItemVariationsResponse**](SfvbItemVariationsResponse.md)
|
|
12793
|
+
|
|
12794
|
+
### Authorization
|
|
12795
|
+
|
|
12796
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
12797
|
+
|
|
12798
|
+
### HTTP request headers
|
|
12799
|
+
|
|
12800
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
12801
|
+
- **Accept**: application/json
|
|
12802
|
+
|
|
12803
|
+
|
|
12522
12804
|
## put_sfvb_menu
|
|
12523
12805
|
|
|
12524
12806
|
> <SfvbMenu> put_sfvb_menu(storefront_oid, code, menu_write_request, opts)
|
|
@@ -15554,6 +15836,61 @@ end
|
|
|
15554
15836
|
- **Accept**: application/json
|
|
15555
15837
|
|
|
15556
15838
|
|
|
15839
|
+
## update_sfvb_item_default_page
|
|
15840
|
+
|
|
15841
|
+
> <SfvbItemDefaultPageResponse> update_sfvb_item_default_page(storefront_oid, item_default_page_request, opts)
|
|
15842
|
+
|
|
15843
|
+
Move items' default (canonical) pages
|
|
15844
|
+
|
|
15845
|
+
Applies the dry run's ready rows with their rows_sha256 under an approved item.default_page request for exactly those rows. Each item's default moves to the named page on this storefront only; every page assignment stays, and nothing else on the item changes. A row whose pages changed since the dry run is skipped as stale, and one failed row doesn't stop the others. Each row is read back; it answers updated with previous_default_path, so the change can be undone, or failed. Needs sfvb_publish when items are live.
|
|
15846
|
+
|
|
15847
|
+
|
|
15848
|
+
### Examples
|
|
15849
|
+
|
|
15850
|
+
|
|
15851
|
+
(No example for this operation).
|
|
15852
|
+
|
|
15853
|
+
|
|
15854
|
+
#### Using the update_sfvb_item_default_page_with_http_info variant
|
|
15855
|
+
|
|
15856
|
+
This returns an Array which contains the response data, status code and headers.
|
|
15857
|
+
|
|
15858
|
+
> <Array(<SfvbItemDefaultPageResponse>, Integer, Hash)> update_sfvb_item_default_page_with_http_info(storefront_oid, item_default_page_request, opts)
|
|
15859
|
+
|
|
15860
|
+
```ruby
|
|
15861
|
+
begin
|
|
15862
|
+
# Move items' default (canonical) pages
|
|
15863
|
+
data, status_code, headers = api_instance.update_sfvb_item_default_page_with_http_info(storefront_oid, item_default_page_request, opts)
|
|
15864
|
+
p status_code # => 2xx
|
|
15865
|
+
p headers # => { ... }
|
|
15866
|
+
p data # => <SfvbItemDefaultPageResponse>
|
|
15867
|
+
rescue UltracartClient::ApiError => e
|
|
15868
|
+
puts "Error when calling SfvbApi->update_sfvb_item_default_page_with_http_info: #{e}"
|
|
15869
|
+
end
|
|
15870
|
+
```
|
|
15871
|
+
|
|
15872
|
+
### Parameters
|
|
15873
|
+
|
|
15874
|
+
| Name | Type | Description | Notes |
|
|
15875
|
+
| ---- | ---- | ----------- | ----- |
|
|
15876
|
+
| **storefront_oid** | **Integer** | | |
|
|
15877
|
+
| **item_default_page_request** | [**SfvbItemDefaultPageRequest**](SfvbItemDefaultPageRequest.md) | The dry run's ready rows and rows_sha256 | |
|
|
15878
|
+
| **approval_id** | **String** | The approval_id of an approved item.default_page request for exactly these rows. Required. See POST /sfvb/approvals. | [optional] |
|
|
15879
|
+
|
|
15880
|
+
### Return type
|
|
15881
|
+
|
|
15882
|
+
[**SfvbItemDefaultPageResponse**](SfvbItemDefaultPageResponse.md)
|
|
15883
|
+
|
|
15884
|
+
### Authorization
|
|
15885
|
+
|
|
15886
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
15887
|
+
|
|
15888
|
+
### HTTP request headers
|
|
15889
|
+
|
|
15890
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
15891
|
+
- **Accept**: application/json
|
|
15892
|
+
|
|
15893
|
+
|
|
15557
15894
|
## update_sfvb_library_entry
|
|
15558
15895
|
|
|
15559
15896
|
> <SfvbLibraryEntry> update_sfvb_library_entry(storefront_oid, library_oid, if_match, library_entry)
|
|
@@ -12,9 +12,11 @@
|
|
|
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_default_page_rows** | [**Array<SfvbItemDefaultPageRow>**](SfvbItemDefaultPageRow.md) | For item.default_page, exactly the rows the apply will send - the dry run's ready rows, each with merchant_item_oid, page_oid and current_sha256. UltraCart keeps only their hash. | [optional] |
|
|
15
16
|
| **item_preorder** | [**SfvbItemPreorderRequest**](SfvbItemPreorderRequest.md) | | [optional] |
|
|
16
17
|
| **item_preorder_children** | [**SfvbItemPreorderChildrenRequest**](SfvbItemPreorderChildrenRequest.md) | | [optional] |
|
|
17
18
|
| **item_pricing** | [**SfvbItemPricingRequest**](SfvbItemPricingRequest.md) | | [optional] |
|
|
19
|
+
| **item_variations** | [**SfvbItemVariationsRequest**](SfvbItemVariationsRequest.md) | | [optional] |
|
|
18
20
|
| **params** | [**SfvbApprovalParams**](SfvbApprovalParams.md) | | [optional] |
|
|
19
21
|
| **postcard_test_mail** | [**SfvbCommsTestPostcardRequest**](SfvbCommsTestPostcardRequest.md) | | [optional] |
|
|
20
22
|
| **reason** | **String** | Why the agent wants to do this, in a sentence. Shown to the person as unverified text, capped at 500 characters. | [optional] |
|
|
@@ -39,9 +41,11 @@ instance = UltracartClient::SfvbApprovalCreateRequest.new(
|
|
|
39
41
|
experiment_start: null,
|
|
40
42
|
flow_backfill: null,
|
|
41
43
|
item_attribute_rows: null,
|
|
44
|
+
item_default_page_rows: null,
|
|
42
45
|
item_preorder: null,
|
|
43
46
|
item_preorder_children: null,
|
|
44
47
|
item_pricing: null,
|
|
48
|
+
item_variations: null,
|
|
45
49
|
params: null,
|
|
46
50
|
postcard_test_mail: null,
|
|
47
51
|
reason: null,
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemChildCreateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **description** | **String** | The new item's description. Defaults to the parent's. | [optional] |
|
|
8
|
+
| **dry_run** | **Boolean** | True to check without creating. | [optional] |
|
|
9
|
+
| **merchant_item_id** | **String** | The new item's id - letters, digits, dot, underscore and dash, at most 20. | [optional] |
|
|
10
|
+
| **parent_merchant_item_id** | **String** | The parent item's id. Send this or parent_merchant_item_oid. | [optional] |
|
|
11
|
+
| **parent_merchant_item_oid** | **Integer** | The parent item's oid. Send this or parent_merchant_item_id. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::SfvbItemChildCreateRequest.new(
|
|
19
|
+
description: null,
|
|
20
|
+
dry_run: null,
|
|
21
|
+
merchant_item_id: null,
|
|
22
|
+
parent_merchant_item_id: null,
|
|
23
|
+
parent_merchant_item_oid: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemChildCreateResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **copied_cost** | **String** | The cost copied from the parent. | [optional] |
|
|
8
|
+
| **copied_dimensions** | **String** | Length, width and height copied from the parent. | [optional] |
|
|
9
|
+
| **copied_folder_id** | **Integer** | The parent's item folder the new item is filed in, 0 for the top. | [optional] |
|
|
10
|
+
| **copied_weight** | **String** | The weight copied from the parent. | [optional] |
|
|
11
|
+
| **description** | **String** | The new item's description. | [optional] |
|
|
12
|
+
| **dry_run** | **Boolean** | True when nothing was created. | [optional] |
|
|
13
|
+
| **merchant_item_id** | **String** | The new item's id. | [optional] |
|
|
14
|
+
| **merchant_item_oid** | **Integer** | The new item's oid. Absent on a dry run. | [optional] |
|
|
15
|
+
| **_next** | **String** | What to do next. | [optional] |
|
|
16
|
+
| **parent** | [**SfvbItemVariationChild**](SfvbItemVariationChild.md) | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'ultracart_api'
|
|
22
|
+
|
|
23
|
+
instance = UltracartClient::SfvbItemChildCreateResponse.new(
|
|
24
|
+
copied_cost: null,
|
|
25
|
+
copied_dimensions: null,
|
|
26
|
+
copied_folder_id: null,
|
|
27
|
+
copied_weight: null,
|
|
28
|
+
description: null,
|
|
29
|
+
dry_run: null,
|
|
30
|
+
merchant_item_id: null,
|
|
31
|
+
merchant_item_oid: null,
|
|
32
|
+
_next: null,
|
|
33
|
+
parent: null
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemDefaultPageRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **rows** | [**Array<SfvbItemDefaultPageRow>**](SfvbItemDefaultPageRow.md) | Up to 2,000 rows on up to 200 items. | [optional] |
|
|
8
|
+
| **rows_sha256** | **String** | Apply only - the dry run's rows_sha256 for exactly these rows. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbItemDefaultPageRequest.new(
|
|
16
|
+
rows: null,
|
|
17
|
+
rows_sha256: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|