ultracart_api 4.1.169 → 4.1.170
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 +18 -2
- data/docs/SfvbApi.md +342 -0
- data/docs/SfvbItemAttribute.md +34 -0
- data/docs/SfvbItemAttributeUpdate.md +22 -0
- data/docs/SfvbItemAttributeUpdateRequest.md +18 -0
- data/docs/SfvbItemContentRequest.md +20 -0
- data/docs/SfvbItemMultimedia.md +34 -0
- data/docs/SfvbItemMultimediaRequest.md +24 -0
- data/docs/SfvbItemResponse.md +32 -0
- data/docs/SfvbItemSeo.md +34 -0
- data/docs/SfvbItemSeoRequest.md +22 -0
- data/lib/ultracart_api/api/sfvb_api.rb +470 -0
- data/lib/ultracart_api/models/sfvb_item_attribute.rb +336 -0
- data/lib/ultracart_api/models/sfvb_item_attribute_update.rb +274 -0
- data/lib/ultracart_api/models/sfvb_item_attribute_update_request.rb +222 -0
- data/lib/ultracart_api/models/sfvb_item_content_request.rb +230 -0
- data/lib/ultracart_api/models/sfvb_item_multimedia.rb +334 -0
- data/lib/ultracart_api/models/sfvb_item_multimedia_request.rb +250 -0
- data/lib/ultracart_api/models/sfvb_item_response.rb +295 -0
- data/lib/ultracart_api/models/sfvb_item_seo.rb +358 -0
- data/lib/ultracart_api/models/sfvb_item_seo_request.rb +240 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +9 -0
- metadata +19 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 587d0b851790956519ecd3b689a83e101aeb02e9dffff0d0ff55eda75de84ace
|
|
4
|
+
data.tar.gz: 25738c61130e73a2d43576f2186b865cba2a5d8a8572e7efdb8211366a17203b
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ce35fd15220eca085d72167bebc6dd4491d2081e1b0e8433def037d597a9075746f5ace1a5b26c33521a057b067548daa8db4732ccd0dd5c8552303048d25291
|
|
7
|
+
data.tar.gz: b5135dde15c102eeac215ff46efe34e165762610214d55f7171ff45b897e9a3b8c2f3cc5e3e3d06ecde8778166d9520cdbf693e3a726d37aa2e837903d350142
|
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.170
|
|
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.170'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -478,6 +478,7 @@ Class | Method | HTTP request | Description
|
|
|
478
478
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_access**](docs/SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login
|
|
479
479
|
*UltracartClient::SfvbApi* | [**create_sfvb_preview_session**](docs/SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session
|
|
480
480
|
*UltracartClient::SfvbApi* | [**delete_sfvb_file**](docs/SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file
|
|
481
|
+
*UltracartClient::SfvbApi* | [**delete_sfvb_item_multimedia**](docs/SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item
|
|
481
482
|
*UltracartClient::SfvbApi* | [**delete_sfvb_page_multimedia**](docs/SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page
|
|
482
483
|
*UltracartClient::SfvbApi* | [**delete_sfvb_preview_session**](docs/SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session
|
|
483
484
|
*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
|
|
@@ -492,6 +493,7 @@ Class | Method | HTTP request | Description
|
|
|
492
493
|
*UltracartClient::SfvbApi* | [**get_sfvb_experiment_objectives**](docs/SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize
|
|
493
494
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_content**](docs/SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file
|
|
494
495
|
*UltracartClient::SfvbApi* | [**get_sfvb_file_upload_url**](docs/SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to
|
|
496
|
+
*UltracartClient::SfvbApi* | [**get_sfvb_item**](docs/SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content
|
|
495
497
|
*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
|
|
496
498
|
*UltracartClient::SfvbApi* | [**get_sfvb_menu**](docs/SfvbApi.md#get_sfvb_menu) | **GET** /sfvb/storefronts/{storefront_oid}/menus/{code} | Read one store menu and its entries
|
|
497
499
|
*UltracartClient::SfvbApi* | [**get_sfvb_menus**](docs/SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus
|
|
@@ -523,6 +525,10 @@ Class | Method | HTTP request | Description
|
|
|
523
525
|
*UltracartClient::SfvbApi* | [**put_sfvb_container**](docs/SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system
|
|
524
526
|
*UltracartClient::SfvbApi* | [**put_sfvb_experiment_variation**](docs/SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation
|
|
525
527
|
*UltracartClient::SfvbApi* | [**put_sfvb_file_content**](docs/SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file
|
|
528
|
+
*UltracartClient::SfvbApi* | [**put_sfvb_item_attributes**](docs/SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes
|
|
529
|
+
*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
|
|
530
|
+
*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
|
|
531
|
+
*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
|
|
526
532
|
*UltracartClient::SfvbApi* | [**put_sfvb_menu**](docs/SfvbApi.md#put_sfvb_menu) | **PUT** /sfvb/storefronts/{storefront_oid}/menus/{code} | Replace a store menu's entries
|
|
527
533
|
*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
|
|
528
534
|
*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
|
|
@@ -1798,8 +1804,17 @@ Class | Method | HTTP request | Description
|
|
|
1798
1804
|
- [UltracartClient::SfvbFileWriteRequest](docs/SfvbFileWriteRequest.md)
|
|
1799
1805
|
- [UltracartClient::SfvbFileWriteResponse](docs/SfvbFileWriteResponse.md)
|
|
1800
1806
|
- [UltracartClient::SfvbFilesResponse](docs/SfvbFilesResponse.md)
|
|
1807
|
+
- [UltracartClient::SfvbItemAttribute](docs/SfvbItemAttribute.md)
|
|
1808
|
+
- [UltracartClient::SfvbItemAttributeUpdate](docs/SfvbItemAttributeUpdate.md)
|
|
1809
|
+
- [UltracartClient::SfvbItemAttributeUpdateRequest](docs/SfvbItemAttributeUpdateRequest.md)
|
|
1801
1810
|
- [UltracartClient::SfvbItemContainer](docs/SfvbItemContainer.md)
|
|
1802
1811
|
- [UltracartClient::SfvbItemContainersResponse](docs/SfvbItemContainersResponse.md)
|
|
1812
|
+
- [UltracartClient::SfvbItemContentRequest](docs/SfvbItemContentRequest.md)
|
|
1813
|
+
- [UltracartClient::SfvbItemMultimedia](docs/SfvbItemMultimedia.md)
|
|
1814
|
+
- [UltracartClient::SfvbItemMultimediaRequest](docs/SfvbItemMultimediaRequest.md)
|
|
1815
|
+
- [UltracartClient::SfvbItemResponse](docs/SfvbItemResponse.md)
|
|
1816
|
+
- [UltracartClient::SfvbItemSeo](docs/SfvbItemSeo.md)
|
|
1817
|
+
- [UltracartClient::SfvbItemSeoRequest](docs/SfvbItemSeoRequest.md)
|
|
1803
1818
|
- [UltracartClient::SfvbLibraryEntry](docs/SfvbLibraryEntry.md)
|
|
1804
1819
|
- [UltracartClient::SfvbLibraryFacet](docs/SfvbLibraryFacet.md)
|
|
1805
1820
|
- [UltracartClient::SfvbLibraryResponse](docs/SfvbLibraryResponse.md)
|
|
@@ -2025,6 +2040,7 @@ Not every change is committed to every SDK.
|
|
|
2025
2040
|
|
|
2026
2041
|
| Version | Date | Comments |
|
|
2027
2042
|
| --: | :-: | --- |
|
|
2043
|
+
| 4.1.170 | 09/22/2026 | sfvb internal testing |
|
|
2028
2044
|
| 4.1.169 | 09/22/2026 | sfvb builder |
|
|
2029
2045
|
| 4.1.168 | 09/21/2026 | further automation testing |
|
|
2030
2046
|
| 4.1.167 | 09/21/2026 | automation test |
|
data/docs/SfvbApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
10
10
|
| [**create_sfvb_preview_access**](SfvbApi.md#create_sfvb_preview_access) | **POST** /sfvb/storefronts/{storefront_oid}/preview_access | One time link that opens a preview in a browser with no UltraCart login |
|
|
11
11
|
| [**create_sfvb_preview_session**](SfvbApi.md#create_sfvb_preview_session) | **POST** /sfvb/storefronts/{storefront_oid}/preview_sessions | Create a preview session |
|
|
12
12
|
| [**delete_sfvb_file**](SfvbApi.md#delete_sfvb_file) | **DELETE** /sfvb/storefronts/{storefront_oid}/files | Delete a storefront file |
|
|
13
|
+
| [**delete_sfvb_item_multimedia**](SfvbApi.md#delete_sfvb_item_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/items/multimedia | Detach an image from an item |
|
|
13
14
|
| [**delete_sfvb_page_multimedia**](SfvbApi.md#delete_sfvb_page_multimedia) | **DELETE** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Detach an image from a page |
|
|
14
15
|
| [**delete_sfvb_preview_session**](SfvbApi.md#delete_sfvb_preview_session) | **DELETE** /sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id} | Delete a preview session |
|
|
15
16
|
| [**download_sfvb_file**](SfvbApi.md#download_sfvb_file) | **GET** /sfvb/storefronts/{storefront_oid}/files/download | Read a storefront file's raw bytes |
|
|
@@ -24,6 +25,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
24
25
|
| [**get_sfvb_experiment_objectives**](SfvbApi.md#get_sfvb_experiment_objectives) | **GET** /sfvb/storefronts/{storefront_oid}/experiments/objectives | List the objectives an experiment can optimize |
|
|
25
26
|
| [**get_sfvb_file_content**](SfvbApi.md#get_sfvb_file_content) | **GET** /sfvb/storefronts/{storefront_oid}/files/content | Read a storefront file |
|
|
26
27
|
| [**get_sfvb_file_upload_url**](SfvbApi.md#get_sfvb_file_upload_url) | **GET** /sfvb/storefronts/{storefront_oid}/files/upload_url/{extension} | Get a URL to upload a binary asset to |
|
|
28
|
+
| [**get_sfvb_item**](SfvbApi.md#get_sfvb_item) | **GET** /sfvb/storefronts/{storefront_oid}/items | Read an item's storefront facing content |
|
|
27
29
|
| [**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 |
|
|
28
30
|
| [**get_sfvb_menu**](SfvbApi.md#get_sfvb_menu) | **GET** /sfvb/storefronts/{storefront_oid}/menus/{code} | Read one store menu and its entries |
|
|
29
31
|
| [**get_sfvb_menus**](SfvbApi.md#get_sfvb_menus) | **GET** /sfvb/storefronts/{storefront_oid}/menus | List a storefront's store menus |
|
|
@@ -55,6 +57,10 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
55
57
|
| [**put_sfvb_container**](SfvbApi.md#put_sfvb_container) | **PUT** /sfvb/storefronts/{storefront_oid}/containers/{owner_type}/{owner_object_id} | Write a container stored outside the file system |
|
|
56
58
|
| [**put_sfvb_experiment_variation**](SfvbApi.md#put_sfvb_experiment_variation) | **PUT** /sfvb/storefronts/{storefront_oid}/experiments/{experiment_oid}/variations/{variation_number} | Pause or resume a variation |
|
|
57
59
|
| [**put_sfvb_file_content**](SfvbApi.md#put_sfvb_file_content) | **PUT** /sfvb/storefronts/{storefront_oid}/files/content | Write a storefront file |
|
|
60
|
+
| [**put_sfvb_item_attributes**](SfvbApi.md#put_sfvb_item_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/items/attributes | Change some of an item's attributes |
|
|
61
|
+
| [**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 |
|
|
62
|
+
| [**put_sfvb_item_multimedia**](SfvbApi.md#put_sfvb_item_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/items/multimedia | Attach an image to an item |
|
|
63
|
+
| [**put_sfvb_item_seo**](SfvbApi.md#put_sfvb_item_seo) | **PUT** /sfvb/storefronts/{storefront_oid}/items/seo | Change an item's search metadata |
|
|
58
64
|
| [**put_sfvb_menu**](SfvbApi.md#put_sfvb_menu) | **PUT** /sfvb/storefronts/{storefront_oid}/menus/{code} | Replace a store menu's entries |
|
|
59
65
|
| [**put_sfvb_page_attributes**](SfvbApi.md#put_sfvb_page_attributes) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/attributes | Change a page's attributes |
|
|
60
66
|
| [**put_sfvb_page_multimedia**](SfvbApi.md#put_sfvb_page_multimedia) | **PUT** /sfvb/storefronts/{storefront_oid}/pages/multimedia | Attach an image to a page |
|
|
@@ -402,6 +408,63 @@ nil (empty response body)
|
|
|
402
408
|
- **Accept**: application/json
|
|
403
409
|
|
|
404
410
|
|
|
411
|
+
## delete_sfvb_item_multimedia
|
|
412
|
+
|
|
413
|
+
> <SfvbItemResponse> delete_sfvb_item_multimedia(storefront_oid, opts)
|
|
414
|
+
|
|
415
|
+
Detach an image from an item
|
|
416
|
+
|
|
417
|
+
Removes the item's copy of the image in one slot. The file you uploaded is left where it is, so the same source can be attached again or used elsewhere.
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
### Examples
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
(No example for this operation).
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
#### Using the delete_sfvb_item_multimedia_with_http_info variant
|
|
427
|
+
|
|
428
|
+
This returns an Array which contains the response data, status code and headers.
|
|
429
|
+
|
|
430
|
+
> <Array(<SfvbItemResponse>, Integer, Hash)> delete_sfvb_item_multimedia_with_http_info(storefront_oid, opts)
|
|
431
|
+
|
|
432
|
+
```ruby
|
|
433
|
+
begin
|
|
434
|
+
# Detach an image from an item
|
|
435
|
+
data, status_code, headers = api_instance.delete_sfvb_item_multimedia_with_http_info(storefront_oid, opts)
|
|
436
|
+
p status_code # => 2xx
|
|
437
|
+
p headers # => { ... }
|
|
438
|
+
p data # => <SfvbItemResponse>
|
|
439
|
+
rescue UltracartClient::ApiError => e
|
|
440
|
+
puts "Error when calling SfvbApi->delete_sfvb_item_multimedia_with_http_info: #{e}"
|
|
441
|
+
end
|
|
442
|
+
```
|
|
443
|
+
|
|
444
|
+
### Parameters
|
|
445
|
+
|
|
446
|
+
| Name | Type | Description | Notes |
|
|
447
|
+
| ---- | ---- | ----------- | ----- |
|
|
448
|
+
| **storefront_oid** | **Integer** | | |
|
|
449
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
450
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
451
|
+
| **code** | **String** | The image code to detach | [optional] |
|
|
452
|
+
| **default** | **Boolean** | Detach the default image instead of a coded one | [optional] |
|
|
453
|
+
|
|
454
|
+
### Return type
|
|
455
|
+
|
|
456
|
+
[**SfvbItemResponse**](SfvbItemResponse.md)
|
|
457
|
+
|
|
458
|
+
### Authorization
|
|
459
|
+
|
|
460
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
461
|
+
|
|
462
|
+
### HTTP request headers
|
|
463
|
+
|
|
464
|
+
- **Content-Type**: Not defined
|
|
465
|
+
- **Accept**: application/json
|
|
466
|
+
|
|
467
|
+
|
|
405
468
|
## delete_sfvb_page_multimedia
|
|
406
469
|
|
|
407
470
|
> <SfvbPageResponse> delete_sfvb_page_multimedia(storefront_oid, path, opts)
|
|
@@ -1164,6 +1227,61 @@ end
|
|
|
1164
1227
|
- **Accept**: application/json
|
|
1165
1228
|
|
|
1166
1229
|
|
|
1230
|
+
## get_sfvb_item
|
|
1231
|
+
|
|
1232
|
+
> <SfvbItemResponse> get_sfvb_item(storefront_oid, opts)
|
|
1233
|
+
|
|
1234
|
+
Read an item's storefront facing content
|
|
1235
|
+
|
|
1236
|
+
The attributes, images, title, description and search metadata a StoreFront element can render, reconciled against the templates behind the pages this item sits on. An attribute a template declares but nothing has set comes back present with an empty value, which is how you discover what the page is asking for. Pricing, shipping, inventory, tax, variants and kit structure are not here because no element reads them; use the item API for those. Address by merchant_item_id, the value data-context-item-id carries, or by merchant_item_oid.
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
### Examples
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
(No example for this operation).
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
#### Using the get_sfvb_item_with_http_info variant
|
|
1246
|
+
|
|
1247
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1248
|
+
|
|
1249
|
+
> <Array(<SfvbItemResponse>, Integer, Hash)> get_sfvb_item_with_http_info(storefront_oid, opts)
|
|
1250
|
+
|
|
1251
|
+
```ruby
|
|
1252
|
+
begin
|
|
1253
|
+
# Read an item's storefront facing content
|
|
1254
|
+
data, status_code, headers = api_instance.get_sfvb_item_with_http_info(storefront_oid, opts)
|
|
1255
|
+
p status_code # => 2xx
|
|
1256
|
+
p headers # => { ... }
|
|
1257
|
+
p data # => <SfvbItemResponse>
|
|
1258
|
+
rescue UltracartClient::ApiError => e
|
|
1259
|
+
puts "Error when calling SfvbApi->get_sfvb_item_with_http_info: #{e}"
|
|
1260
|
+
end
|
|
1261
|
+
```
|
|
1262
|
+
|
|
1263
|
+
### Parameters
|
|
1264
|
+
|
|
1265
|
+
| Name | Type | Description | Notes |
|
|
1266
|
+
| ---- | ---- | ----------- | ----- |
|
|
1267
|
+
| **storefront_oid** | **Integer** | | |
|
|
1268
|
+
| **merchant_item_id** | **String** | The merchant item id, as a storefront carries it | [optional] |
|
|
1269
|
+
| **merchant_item_oid** | **Integer** | The item oid. Send this or merchant_item_id, not both | [optional] |
|
|
1270
|
+
|
|
1271
|
+
### Return type
|
|
1272
|
+
|
|
1273
|
+
[**SfvbItemResponse**](SfvbItemResponse.md)
|
|
1274
|
+
|
|
1275
|
+
### Authorization
|
|
1276
|
+
|
|
1277
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1278
|
+
|
|
1279
|
+
### HTTP request headers
|
|
1280
|
+
|
|
1281
|
+
- **Content-Type**: Not defined
|
|
1282
|
+
- **Accept**: application/json
|
|
1283
|
+
|
|
1284
|
+
|
|
1167
1285
|
## get_sfvb_library_entry
|
|
1168
1286
|
|
|
1169
1287
|
> <SfvbLibraryEntry> get_sfvb_library_entry(storefront_oid, library_oid)
|
|
@@ -2840,6 +2958,230 @@ end
|
|
|
2840
2958
|
- **Accept**: application/json
|
|
2841
2959
|
|
|
2842
2960
|
|
|
2961
|
+
## put_sfvb_item_attributes
|
|
2962
|
+
|
|
2963
|
+
> <SfvbItemResponse> put_sfvb_item_attributes(storefront_oid, item_attribute_update_request, opts)
|
|
2964
|
+
|
|
2965
|
+
Change some of an item's attributes
|
|
2966
|
+
|
|
2967
|
+
Partial - only the attributes named change, and an empty value clears one. Every entry is validated before any is written, so a refusal leaves the item untouched. The list types are checked against the shape their renderer actually parses, which matters more than it sounds: a definition list is a bare array with one letter keys, a video list is a wrapper object with keys spelled out, and an item set is comma separated text rather than JSON. A shape the renderer cannot read is not reported at render time - it renders exactly like an attribute nobody ever set.
|
|
2968
|
+
|
|
2969
|
+
|
|
2970
|
+
### Examples
|
|
2971
|
+
|
|
2972
|
+
|
|
2973
|
+
(No example for this operation).
|
|
2974
|
+
|
|
2975
|
+
|
|
2976
|
+
#### Using the put_sfvb_item_attributes_with_http_info variant
|
|
2977
|
+
|
|
2978
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2979
|
+
|
|
2980
|
+
> <Array(<SfvbItemResponse>, Integer, Hash)> put_sfvb_item_attributes_with_http_info(storefront_oid, item_attribute_update_request, opts)
|
|
2981
|
+
|
|
2982
|
+
```ruby
|
|
2983
|
+
begin
|
|
2984
|
+
# Change some of an item's attributes
|
|
2985
|
+
data, status_code, headers = api_instance.put_sfvb_item_attributes_with_http_info(storefront_oid, item_attribute_update_request, opts)
|
|
2986
|
+
p status_code # => 2xx
|
|
2987
|
+
p headers # => { ... }
|
|
2988
|
+
p data # => <SfvbItemResponse>
|
|
2989
|
+
rescue UltracartClient::ApiError => e
|
|
2990
|
+
puts "Error when calling SfvbApi->put_sfvb_item_attributes_with_http_info: #{e}"
|
|
2991
|
+
end
|
|
2992
|
+
```
|
|
2993
|
+
|
|
2994
|
+
### Parameters
|
|
2995
|
+
|
|
2996
|
+
| Name | Type | Description | Notes |
|
|
2997
|
+
| ---- | ---- | ----------- | ----- |
|
|
2998
|
+
| **storefront_oid** | **Integer** | | |
|
|
2999
|
+
| **item_attribute_update_request** | [**SfvbItemAttributeUpdateRequest**](SfvbItemAttributeUpdateRequest.md) | Attributes to change | |
|
|
3000
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
3001
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
3002
|
+
|
|
3003
|
+
### Return type
|
|
3004
|
+
|
|
3005
|
+
[**SfvbItemResponse**](SfvbItemResponse.md)
|
|
3006
|
+
|
|
3007
|
+
### Authorization
|
|
3008
|
+
|
|
3009
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3010
|
+
|
|
3011
|
+
### HTTP request headers
|
|
3012
|
+
|
|
3013
|
+
- **Content-Type**: application/json
|
|
3014
|
+
- **Accept**: application/json
|
|
3015
|
+
|
|
3016
|
+
|
|
3017
|
+
## put_sfvb_item_content
|
|
3018
|
+
|
|
3019
|
+
> <SfvbItemResponse> put_sfvb_item_content(storefront_oid, item_content_request, opts)
|
|
3020
|
+
|
|
3021
|
+
Change an item's title or long description
|
|
3022
|
+
|
|
3023
|
+
Partial - a field left out is untouched, a field sent empty is cleared, and those are different things. These are what itemtitle and itemdescription render. Writing the matching config keys into a container does nothing, because they are dialog buffers bound to the item and the render never reads them. Both are the catalog's own fields, so a change here reaches the item everywhere, not only on this storefront.
|
|
3024
|
+
|
|
3025
|
+
|
|
3026
|
+
### Examples
|
|
3027
|
+
|
|
3028
|
+
|
|
3029
|
+
(No example for this operation).
|
|
3030
|
+
|
|
3031
|
+
|
|
3032
|
+
#### Using the put_sfvb_item_content_with_http_info variant
|
|
3033
|
+
|
|
3034
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3035
|
+
|
|
3036
|
+
> <Array(<SfvbItemResponse>, Integer, Hash)> put_sfvb_item_content_with_http_info(storefront_oid, item_content_request, opts)
|
|
3037
|
+
|
|
3038
|
+
```ruby
|
|
3039
|
+
begin
|
|
3040
|
+
# Change an item's title or long description
|
|
3041
|
+
data, status_code, headers = api_instance.put_sfvb_item_content_with_http_info(storefront_oid, item_content_request, opts)
|
|
3042
|
+
p status_code # => 2xx
|
|
3043
|
+
p headers # => { ... }
|
|
3044
|
+
p data # => <SfvbItemResponse>
|
|
3045
|
+
rescue UltracartClient::ApiError => e
|
|
3046
|
+
puts "Error when calling SfvbApi->put_sfvb_item_content_with_http_info: #{e}"
|
|
3047
|
+
end
|
|
3048
|
+
```
|
|
3049
|
+
|
|
3050
|
+
### Parameters
|
|
3051
|
+
|
|
3052
|
+
| Name | Type | Description | Notes |
|
|
3053
|
+
| ---- | ---- | ----------- | ----- |
|
|
3054
|
+
| **storefront_oid** | **Integer** | | |
|
|
3055
|
+
| **item_content_request** | [**SfvbItemContentRequest**](SfvbItemContentRequest.md) | Title and description to change | |
|
|
3056
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
3057
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
3058
|
+
|
|
3059
|
+
### Return type
|
|
3060
|
+
|
|
3061
|
+
[**SfvbItemResponse**](SfvbItemResponse.md)
|
|
3062
|
+
|
|
3063
|
+
### Authorization
|
|
3064
|
+
|
|
3065
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3066
|
+
|
|
3067
|
+
### HTTP request headers
|
|
3068
|
+
|
|
3069
|
+
- **Content-Type**: application/json
|
|
3070
|
+
- **Accept**: application/json
|
|
3071
|
+
|
|
3072
|
+
|
|
3073
|
+
## put_sfvb_item_multimedia
|
|
3074
|
+
|
|
3075
|
+
> <SfvbItemResponse> put_sfvb_item_multimedia(storefront_oid, item_multimedia_request, opts)
|
|
3076
|
+
|
|
3077
|
+
Attach an image to an item
|
|
3078
|
+
|
|
3079
|
+
One slot at a time - the default image or one code - and every other image on the item is left alone. That is the difference from the item API, where images are reachable only through a full item update whose multimedia array is reconciled destructively, so adding one means resending the rest or losing them. Upload the file with files/upload first and name its storefront path here; unlike a page image it does not have to live in any particular folder, because the bytes are copied into the item's own storage on attach.
|
|
3080
|
+
|
|
3081
|
+
|
|
3082
|
+
### Examples
|
|
3083
|
+
|
|
3084
|
+
|
|
3085
|
+
(No example for this operation).
|
|
3086
|
+
|
|
3087
|
+
|
|
3088
|
+
#### Using the put_sfvb_item_multimedia_with_http_info variant
|
|
3089
|
+
|
|
3090
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3091
|
+
|
|
3092
|
+
> <Array(<SfvbItemResponse>, Integer, Hash)> put_sfvb_item_multimedia_with_http_info(storefront_oid, item_multimedia_request, opts)
|
|
3093
|
+
|
|
3094
|
+
```ruby
|
|
3095
|
+
begin
|
|
3096
|
+
# Attach an image to an item
|
|
3097
|
+
data, status_code, headers = api_instance.put_sfvb_item_multimedia_with_http_info(storefront_oid, item_multimedia_request, opts)
|
|
3098
|
+
p status_code # => 2xx
|
|
3099
|
+
p headers # => { ... }
|
|
3100
|
+
p data # => <SfvbItemResponse>
|
|
3101
|
+
rescue UltracartClient::ApiError => e
|
|
3102
|
+
puts "Error when calling SfvbApi->put_sfvb_item_multimedia_with_http_info: #{e}"
|
|
3103
|
+
end
|
|
3104
|
+
```
|
|
3105
|
+
|
|
3106
|
+
### Parameters
|
|
3107
|
+
|
|
3108
|
+
| Name | Type | Description | Notes |
|
|
3109
|
+
| ---- | ---- | ----------- | ----- |
|
|
3110
|
+
| **storefront_oid** | **Integer** | | |
|
|
3111
|
+
| **item_multimedia_request** | [**SfvbItemMultimediaRequest**](SfvbItemMultimediaRequest.md) | Image to attach | |
|
|
3112
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
3113
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
3114
|
+
|
|
3115
|
+
### Return type
|
|
3116
|
+
|
|
3117
|
+
[**SfvbItemResponse**](SfvbItemResponse.md)
|
|
3118
|
+
|
|
3119
|
+
### Authorization
|
|
3120
|
+
|
|
3121
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3122
|
+
|
|
3123
|
+
### HTTP request headers
|
|
3124
|
+
|
|
3125
|
+
- **Content-Type**: application/json
|
|
3126
|
+
- **Accept**: application/json
|
|
3127
|
+
|
|
3128
|
+
|
|
3129
|
+
## put_sfvb_item_seo
|
|
3130
|
+
|
|
3131
|
+
> <SfvbItemResponse> put_sfvb_item_seo(storefront_oid, item_seo_request, opts)
|
|
3132
|
+
|
|
3133
|
+
Change an item's search metadata
|
|
3134
|
+
|
|
3135
|
+
Partial - a field left out is untouched, a field sent empty is cleared and the page falls back to what it fell back to before. Underneath these are three item attributes with reserved names, so this and the attributes endpoint reach the same storage; it exists separately because the names are not discoverable from the templates. Two things worth knowing. A title set here changes the document title only - og:title and twitter:title render the item's description either way. And there is no canonical or noindex field, because both are site wide switches rather than per item values.
|
|
3136
|
+
|
|
3137
|
+
|
|
3138
|
+
### Examples
|
|
3139
|
+
|
|
3140
|
+
|
|
3141
|
+
(No example for this operation).
|
|
3142
|
+
|
|
3143
|
+
|
|
3144
|
+
#### Using the put_sfvb_item_seo_with_http_info variant
|
|
3145
|
+
|
|
3146
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3147
|
+
|
|
3148
|
+
> <Array(<SfvbItemResponse>, Integer, Hash)> put_sfvb_item_seo_with_http_info(storefront_oid, item_seo_request, opts)
|
|
3149
|
+
|
|
3150
|
+
```ruby
|
|
3151
|
+
begin
|
|
3152
|
+
# Change an item's search metadata
|
|
3153
|
+
data, status_code, headers = api_instance.put_sfvb_item_seo_with_http_info(storefront_oid, item_seo_request, opts)
|
|
3154
|
+
p status_code # => 2xx
|
|
3155
|
+
p headers # => { ... }
|
|
3156
|
+
p data # => <SfvbItemResponse>
|
|
3157
|
+
rescue UltracartClient::ApiError => e
|
|
3158
|
+
puts "Error when calling SfvbApi->put_sfvb_item_seo_with_http_info: #{e}"
|
|
3159
|
+
end
|
|
3160
|
+
```
|
|
3161
|
+
|
|
3162
|
+
### Parameters
|
|
3163
|
+
|
|
3164
|
+
| Name | Type | Description | Notes |
|
|
3165
|
+
| ---- | ---- | ----------- | ----- |
|
|
3166
|
+
| **storefront_oid** | **Integer** | | |
|
|
3167
|
+
| **item_seo_request** | [**SfvbItemSeoRequest**](SfvbItemSeoRequest.md) | Search metadata to change | |
|
|
3168
|
+
| **merchant_item_id** | **String** | | [optional] |
|
|
3169
|
+
| **merchant_item_oid** | **Integer** | | [optional] |
|
|
3170
|
+
|
|
3171
|
+
### Return type
|
|
3172
|
+
|
|
3173
|
+
[**SfvbItemResponse**](SfvbItemResponse.md)
|
|
3174
|
+
|
|
3175
|
+
### Authorization
|
|
3176
|
+
|
|
3177
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3178
|
+
|
|
3179
|
+
### HTTP request headers
|
|
3180
|
+
|
|
3181
|
+
- **Content-Type**: application/json
|
|
3182
|
+
- **Accept**: application/json
|
|
3183
|
+
|
|
3184
|
+
|
|
2843
3185
|
## put_sfvb_menu
|
|
2844
3186
|
|
|
2845
3187
|
> <SfvbMenu> put_sfvb_menu(storefront_oid, code, menu_write_request, opts)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemAttribute
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **conflicting_types** | **Array<String>** | Set only when templates disagree about this attribute's type, listing every type declared for it. The render does not resolve this - each element parses the value as its own itemAttributeType says - so one of the elements reading it is showing nothing. | [optional] |
|
|
8
|
+
| **deprecated** | **Boolean** | True when the declaring template marks this attribute as on its way out. Prefer not to build on it. | [optional] |
|
|
9
|
+
| **name** | **String** | The attribute name, which is what an itemattribute element's itemAttributeName refers to. Matching is forgiving on the render side - uppercased, trimmed, runs of whitespace collapsed - so Care Notes and care notes are the same attribute. | [optional] |
|
|
10
|
+
| **type** | **String** | How the templates declaring this attribute expect its value to be shaped. orphan means no template declares it, so nothing here can say what shape it should be. | [optional] |
|
|
11
|
+
| **undeclared** | **Boolean** | True when the attribute is stored on the item but no template declares it. Not an error - a value set for an element placed in a container is undeclared by design, because the container is not a template. | [optional] |
|
|
12
|
+
| **used_by** | **String** | The other themes that declare this attribute, when the active theme does not. | [optional] |
|
|
13
|
+
| **used_by_current_theme** | **Boolean** | True when a template in the active theme declares this attribute. | [optional] |
|
|
14
|
+
| **value** | **String** | The stored value. Empty when a template declares the attribute and nothing has set it. | [optional] |
|
|
15
|
+
| **writable** | **Boolean** | True when this API will change the value. An item attribute is a plain value column, so unlike a page attribute the list types are writable here; their per entry translation handles are assigned on first read rather than stored with the value. | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'ultracart_api'
|
|
21
|
+
|
|
22
|
+
instance = UltracartClient::SfvbItemAttribute.new(
|
|
23
|
+
conflicting_types: null,
|
|
24
|
+
deprecated: null,
|
|
25
|
+
name: null,
|
|
26
|
+
type: null,
|
|
27
|
+
undeclared: null,
|
|
28
|
+
used_by: null,
|
|
29
|
+
used_by_current_theme: null,
|
|
30
|
+
value: null,
|
|
31
|
+
writable: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemAttributeUpdate
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The attribute to change, matched without regard to case. An attribute that does not exist yet is created. | [optional] |
|
|
8
|
+
| **type** | **String** | Only consulted for a name no template declares, to say how the value should be validated and what the attribute is recorded as. Ignored otherwise, because a declared attribute's type comes from the template that declares it. | [optional] |
|
|
9
|
+
| **value** | **String** | The new value. Send an empty string to clear it. For the list types this is the JSON document as text, not a nested object - see the type's own format, because a shape the renderer cannot parse renders exactly like an attribute that was never set. | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'ultracart_api'
|
|
15
|
+
|
|
16
|
+
instance = UltracartClient::SfvbItemAttributeUpdate.new(
|
|
17
|
+
name: null,
|
|
18
|
+
type: null,
|
|
19
|
+
value: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemAttributeUpdateRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **attributes** | [**Array<SfvbItemAttributeUpdate>**](SfvbItemAttributeUpdate.md) | The attributes to change. Every entry is validated before any is written, so one refused attribute changes nothing. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'ultracart_api'
|
|
13
|
+
|
|
14
|
+
instance = UltracartClient::SfvbItemAttributeUpdateRequest.new(
|
|
15
|
+
attributes: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemContentRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **description** | **String** | What an itemdescription element renders, the item's extended description. HTML is accepted; the element's excerpt settings only decide how much of it is shown. | [optional] |
|
|
8
|
+
| **title** | **String** | What an itemtitle element renders. This is the item's short description in the catalog, so it changes the item everywhere, not only on this storefront. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::SfvbItemContentRequest.new(
|
|
16
|
+
description: null,
|
|
17
|
+
title: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemMultimedia
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | The image code, which is what an itemimage element's itemImageCode refers to. Empty for the default image. | [optional] |
|
|
8
|
+
| **declared** | **Boolean** | True when a template declares this code. A slot that is attached but not declared is an image nothing on the page is asking for. | [optional] |
|
|
9
|
+
| **default** | **Boolean** | True for the image an itemimage element with no code renders. Default is per media type, so an item may have one default image and one default PDF at the same time. | [optional] |
|
|
10
|
+
| **description** | **String** | Stored with the image and rendered as its alt text. When it is empty the render falls back to the item's own description, so an empty value here is not an empty alt attribute. | [optional] |
|
|
11
|
+
| **dimensions** | **String** | Width x height in pixels, when the storage measured the file. | [optional] |
|
|
12
|
+
| **exclude_from_gallery** | **Boolean** | True when the storage marks this image as kept out of the item gallery. | [optional] |
|
|
13
|
+
| **filename** | **String** | The stored file's name. Empty when the slot is declared and nothing is attached. | [optional] |
|
|
14
|
+
| **type** | **String** | The media type the storage recorded. | [optional] |
|
|
15
|
+
| **view_url** | **String** | Where the stored image is served. Absent when nothing is attached to the slot. | [optional] |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'ultracart_api'
|
|
21
|
+
|
|
22
|
+
instance = UltracartClient::SfvbItemMultimedia.new(
|
|
23
|
+
code: null,
|
|
24
|
+
declared: null,
|
|
25
|
+
default: null,
|
|
26
|
+
description: null,
|
|
27
|
+
dimensions: null,
|
|
28
|
+
exclude_from_gallery: null,
|
|
29
|
+
filename: null,
|
|
30
|
+
type: null,
|
|
31
|
+
view_url: null
|
|
32
|
+
)
|
|
33
|
+
```
|
|
34
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemMultimediaRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Attach under this image code, the value an itemimage element's itemImageCode names. | [optional] |
|
|
8
|
+
| **default** | **Boolean** | Attach as the item's default image, which is what an itemimage element with no code renders. Name exactly one of this or code. | [optional] |
|
|
9
|
+
| **description** | **String** | Stored with the image and rendered as its alt text. Left out, the slot keeps the description it already had. | [optional] |
|
|
10
|
+
| **path** | **String** | Storefront file system path of the image to attach, such as /assets/img/mug-front.jpg. Upload it with files/upload first. Unlike a page image this does not have to sit in any particular folder, because an item has no folder of its own - the bytes are copied into the item's own storage on attach. | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'ultracart_api'
|
|
16
|
+
|
|
17
|
+
instance = UltracartClient::SfvbItemMultimediaRequest.new(
|
|
18
|
+
code: null,
|
|
19
|
+
default: null,
|
|
20
|
+
description: null,
|
|
21
|
+
path: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::SfvbItemResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **attributes** | [**Array<SfvbItemAttribute>**](SfvbItemAttribute.md) | Every attribute a template declares for this item plus every one stored on it, so the list answers what can be set as well as what is set. | [optional] |
|
|
8
|
+
| **description** | **String** | What an itemdescription element renders, the item's extended description. Like title this is the catalog's own field rather than a storefront copy of it. | [optional] |
|
|
9
|
+
| **groups** | **Array<String>** | The page paths this item is assigned to on this storefront. The templates behind those pages are what the attribute and image declarations were reconciled against, so an empty list is why an item can report no declared attributes at all. | [optional] |
|
|
10
|
+
| **merchant_item_id** | **String** | The item id a storefront carries, and the one data-context-item-id holds. | [optional] |
|
|
11
|
+
| **merchant_item_oid** | **Integer** | The item's internal oid, which appears nowhere on a rendered storefront. | [optional] |
|
|
12
|
+
| **multimedia** | [**Array<SfvbItemMultimedia>**](SfvbItemMultimedia.md) | Every image slot a template declares plus every image attached to the item. | [optional] |
|
|
13
|
+
| **seo** | [**SfvbItemSeo**](SfvbItemSeo.md) | | [optional] |
|
|
14
|
+
| **title** | **String** | What an itemtitle element renders. This is the item's short description in the catalog, not a storefront only field, so changing it changes the item everywhere. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::SfvbItemResponse.new(
|
|
22
|
+
attributes: null,
|
|
23
|
+
description: null,
|
|
24
|
+
groups: null,
|
|
25
|
+
merchant_item_id: null,
|
|
26
|
+
merchant_item_oid: null,
|
|
27
|
+
multimedia: null,
|
|
28
|
+
seo: null,
|
|
29
|
+
title: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|