@wix/ditto-codegen-public 1.0.162 → 1.0.163
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.
- package/dist/docs-output/api-docs/bookings-bookings-onBookingCanceled-doc.txt +169 -0
- package/dist/docs-output/api-docs/bookings-bookings-onBookingCreated-doc.txt +154 -0
- package/dist/docs-output/api-docs/crm-contacts-onContactCreated-doc.txt +87 -171
- package/dist/docs-output/api-docs/crm-contacts-onContactDeleted-doc.txt +58 -0
- package/dist/docs-output/api-docs/crm-contacts-onContactUpdated-doc.txt +99 -0
- package/dist/docs-output/api-docs/data-items-get-doc.txt +95 -54
- package/dist/docs-output/api-docs/data-items-insert-doc.txt +235 -43
- package/dist/docs-output/api-docs/data-items-onDataItemCreated-doc.txt +61 -0
- package/dist/docs-output/api-docs/data-items-onDataItemDeleted-doc.txt +58 -0
- package/dist/docs-output/api-docs/data-items-onDataItemUpdated-doc.txt +61 -0
- package/dist/docs-output/api-docs/data-items-query-doc.txt +507 -302
- package/dist/docs-output/api-docs/data-items-remove-doc.txt +120 -40
- package/dist/docs-output/api-docs/data-items-update-doc.txt +425 -46
- package/dist/docs-output/api-docs/ecom-cart-addToCart-doc.txt +488 -0
- package/dist/docs-output/api-docs/ecom-cart-createCart-doc.txt +518 -0
- package/dist/docs-output/api-docs/ecom-cart-createCheckout-doc.txt +155 -0
- package/dist/docs-output/api-docs/ecom-cart-deleteCart-doc.txt +92 -0
- package/dist/docs-output/api-docs/ecom-cart-getCart-doc.txt +376 -0
- package/dist/docs-output/api-docs/ecom-cart-onCartCreated-doc.txt +89 -80
- package/dist/docs-output/api-docs/ecom-cart-onCartUpdated-doc.txt +91 -81
- package/dist/docs-output/api-docs/ecom-cart-removeLineItemsFromCart-doc.txt +321 -0
- package/dist/docs-output/api-docs/ecom-cart-updateCart-doc.txt +539 -0
- package/dist/docs-output/api-docs/ecom-checkout-addToCheckout-doc.txt +1005 -0
- package/dist/docs-output/api-docs/ecom-checkout-createCheckout-doc.txt +1641 -0
- package/dist/docs-output/api-docs/ecom-checkout-getCheckout-doc.txt +1027 -0
- package/dist/docs-output/api-docs/ecom-checkout-onCheckoutCompleted-doc.txt +151 -0
- package/dist/docs-output/api-docs/ecom-checkout-onCheckoutCreated-doc.txt +150 -0
- package/dist/docs-output/api-docs/ecom-checkout-onCheckoutUpdated-doc.txt +150 -0
- package/dist/docs-output/api-docs/ecom-checkout-removeLineItemsFromCheckout-doc.txt +879 -0
- package/dist/docs-output/api-docs/ecom-checkout-updateCheckout-doc.txt +1011 -0
- package/dist/docs-output/api-docs/ecom-currentCart-getCurrentCart-doc.txt +368 -322
- package/dist/docs-output/api-docs/ecom-currentCart-updateCurrentCart-doc.txt +506 -321
- package/dist/docs-output/api-docs/ecom-orders-bulkUpdateOrders-doc.txt +1040 -0
- package/dist/docs-output/api-docs/ecom-orders-cancelOrder-doc.txt +608 -0
- package/dist/docs-output/api-docs/ecom-orders-getOrder-doc.txt +926 -0
- package/dist/docs-output/api-docs/ecom-orders-onOrderCreated-doc.txt +245 -0
- package/dist/docs-output/api-docs/ecom-orders-onOrderUpdated-doc.txt +244 -0
- package/dist/docs-output/api-docs/ecom-orders-searchOrders-doc.txt +670 -0
- package/dist/docs-output/api-docs/ecom-orders-updateOrder-doc.txt +818 -0
- package/dist/docs-output/api-docs/search-wixSiteSearch-search-doc.txt +162 -0
- package/dist/docs-output/api-docs/stores-collections-addProductsToCollection-doc.txt +86 -0
- package/dist/docs-output/api-docs/stores-collections-createCollection-doc.txt +108 -0
- package/dist/docs-output/api-docs/stores-collections-getCollection-doc.txt +102 -0
- package/dist/docs-output/api-docs/stores-collections-queryCollections-doc.txt +209 -0
- package/dist/docs-output/api-docs/stores-collections-removeProductsFromCollection-doc.txt +86 -0
- package/dist/docs-output/api-docs/stores-collections-updateCollection-doc.txt +110 -0
- package/dist/docs-output/api-docs/stores-inventory-queryInventory-doc.txt +98 -0
- package/dist/docs-output/api-docs/stores-inventory-updateInventoryVariants-doc.txt +249 -0
- package/dist/docs-output/api-docs/stores-inventoryItemsV3-queryInventoryItems-doc.txt +236 -0
- package/dist/docs-output/api-docs/stores-inventoryItemsV3-updateInventoryItem-doc.txt +139 -0
- package/dist/docs-output/api-docs/stores-productsV3-createProduct-doc.txt +1697 -0
- package/dist/docs-output/api-docs/stores-productsV3-deleteProduct-doc.txt +73 -0
- package/dist/docs-output/api-docs/stores-productsV3-getProduct-doc.txt +933 -0
- package/dist/docs-output/api-docs/stores-productsV3-onProductCreated-doc.txt +794 -0
- package/dist/docs-output/api-docs/stores-productsV3-onProductDeleted-doc.txt +794 -0
- package/dist/docs-output/api-docs/stores-productsV3-onProductUpdated-doc.txt +794 -0
- package/dist/docs-output/api-docs/stores-productsV3-queryProducts-doc.txt +1051 -0
- package/dist/docs-output/api-docs/stores-productsV3-searchProducts-doc.txt +1144 -0
- package/dist/docs-output/api-docs/stores-productsV3-updateProduct-doc.txt +1730 -1600
- package/dist/docs-output/api-docs/stores-readOnlyVariantsV3-queryVariants-doc.txt +290 -0
- package/dist/docs-output/api-docs/stores-readOnlyVariantsV3-searchVariants-doc.txt +353 -0
- package/dist/out.js +929 -79
- package/package.json +2 -2
- package/dist/docs-output/api-docs/data-items-onDataItemCreated.txt +0 -103
- package/dist/docs-output/api-docs/stores-product-onProductCreated-doc.txt +0 -118
- package/dist/docs-output/api-docs/stores-productV3-onProductCreated-doc.txt +0 -184
|
@@ -0,0 +1,1144 @@
|
|
|
1
|
+
<stores_productsV3_searchProducts>
|
|
2
|
+
<description>
|
|
3
|
+
# Method name:
|
|
4
|
+
|
|
5
|
+
stores.productsV3.searchProducts(search: CommonCursorSearch, options: SearchProductsOptions)
|
|
6
|
+
|
|
7
|
+
# Method Link:
|
|
8
|
+
|
|
9
|
+
https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/products-v3/search-products
|
|
10
|
+
|
|
11
|
+
# Method Description:
|
|
12
|
+
|
|
13
|
+
Retrieves a list of up to 100 products, given the provided filtering, search expression, sorting, and cursor paging.
|
|
14
|
+
Pass supported values to the `fields` array in the request to include those fields in the response.
|
|
15
|
+
|
|
16
|
+
To learn about working with _Search_ endpoints, see
|
|
17
|
+
[API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language),
|
|
18
|
+
and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
19
|
+
|
|
20
|
+
> **Notes:**
|
|
21
|
+
> + This method does not return `variantsInfo`. To retrieve product variants, use the Get Product method.
|
|
22
|
+
> + To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
23
|
+
|
|
24
|
+
| Property | Capabilities | Filters
|
|
25
|
+
|-------|------------|------|
|
|
26
|
+
| `allCategoriesInfo.categories` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$matchItems` |
|
|
27
|
+
| `directCategoriesInfo.categories` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$matchItems` |
|
|
28
|
+
| `variantsInfo.variants` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$matchItems` |
|
|
29
|
+
| `infoSections._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
30
|
+
| `infoSections.uniqueName` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
31
|
+
| `modifiers._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
32
|
+
| `modifiers.choicesSettings.choices.choiceId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
33
|
+
| `modifiers.choicesSettings.choices.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
34
|
+
| `modifiers.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
35
|
+
| `options._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
36
|
+
| `options.choicesSettings.choices.choiceId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
37
|
+
| `options.choicesSettings.choices.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
38
|
+
| `options.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` |
|
|
39
|
+
| `_id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
40
|
+
| `brand._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
41
|
+
| `brand.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
42
|
+
| `handle` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
43
|
+
| `inventory.availabilityStatus` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
|
|
44
|
+
| `inventory.preorderAvailability` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
|
|
45
|
+
| `inventory.preorderStatus` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
|
|
46
|
+
| `physicalProperties.deliveryProfileId` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
47
|
+
| `physicalProperties.fulfillerId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
48
|
+
| `productType` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
|
|
49
|
+
| `ribbon._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
50
|
+
| `ribbon.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
51
|
+
| `slug` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
52
|
+
| `subscriptionDetails.allowOneTimePurchases` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
|
|
53
|
+
| `taxGroupId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
54
|
+
| `visible` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
|
|
55
|
+
| `visibleInPos` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` |
|
|
56
|
+
| `_createdDate` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` |
|
|
57
|
+
| `_updatedDate` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` |
|
|
58
|
+
| `actualPriceRange.maxValue.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
59
|
+
| `actualPriceRange.minValue.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
60
|
+
| `compareAtPriceRange.maxValue.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
61
|
+
| `compareAtPriceRange.minValue.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
62
|
+
| `minVariantPriceInfo.sku` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
63
|
+
| `name` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` |
|
|
64
|
+
| `physicalProperties.shippingWeightRange.maxValue` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` |
|
|
65
|
+
| `physicalProperties.shippingWeightRange.minValue` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` |
|
|
66
|
+
| `description` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: ✗<br/> Sort: ✗ | |
|
|
67
|
+
| `directCategoryIdsInfo.categoryIds` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: ✗<br/> Sort: ✗ | |
|
|
68
|
+
| `physicalProperties.shippingGroupId` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: ✗<br/> Sort: ✗ | |
|
|
69
|
+
| `variantsInfo.variants.sku` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: ✗<br/> Sort: ✗ | |
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
# Method Permissions:
|
|
73
|
+
|
|
74
|
+
- WIX_STORES.PRODUCT_READ
|
|
75
|
+
- WIX_STORES.PRODUCT_READ_NON_VISIBLE
|
|
76
|
+
|
|
77
|
+
# Method Permissions Scopes IDs:
|
|
78
|
+
|
|
79
|
+
undefined
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
# Method Code Examples:
|
|
84
|
+
|
|
85
|
+
## searchProducts
|
|
86
|
+
|
|
87
|
+
```javascript
|
|
88
|
+
import { productsV3 } from '@wix/stores';
|
|
89
|
+
|
|
90
|
+
async function searchProducts(search, options) {
|
|
91
|
+
const response = await productsV3.searchProducts(search, options);
|
|
92
|
+
};
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## searchProducts (with elevated permissions)
|
|
96
|
+
|
|
97
|
+
```javascript
|
|
98
|
+
import { productsV3 } from '@wix/stores';
|
|
99
|
+
import { auth } from '@wix/essentials';
|
|
100
|
+
|
|
101
|
+
async function mySearchProductsMethod(search, options) {
|
|
102
|
+
const elevatedSearchProducts = auth.elevate(productsV3.searchProducts);
|
|
103
|
+
const response = await elevatedSearchProducts(search, options);
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
## default
|
|
110
|
+
|
|
111
|
+
```javascript
|
|
112
|
+
try {
|
|
113
|
+
const result = await productsV3.searchProducts({
|
|
114
|
+
search: {
|
|
115
|
+
search: {
|
|
116
|
+
expression: "Sample",
|
|
117
|
+
fields: ["name"]
|
|
118
|
+
},
|
|
119
|
+
aggregations: [
|
|
120
|
+
{
|
|
121
|
+
fieldPath: "name",
|
|
122
|
+
name: "Product Name",
|
|
123
|
+
type: "VALUE"
|
|
124
|
+
}
|
|
125
|
+
],
|
|
126
|
+
filter: {},
|
|
127
|
+
sort: [{
|
|
128
|
+
fieldName: "numericId",
|
|
129
|
+
order: "ASC"
|
|
130
|
+
}]
|
|
131
|
+
},
|
|
132
|
+
options: {}
|
|
133
|
+
});
|
|
134
|
+
return result;
|
|
135
|
+
} catch (error) {
|
|
136
|
+
console.error(error);
|
|
137
|
+
throw error;
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
</description>
|
|
141
|
+
<type_definition>
|
|
142
|
+
```
|
|
143
|
+
Method: stores.productsV3.searchProducts(search, options)
|
|
144
|
+
Description: Retrieves a list of up to 100 products, given the provided filtering, search expression, sorting, and cursor paging. Pass supported values to the `fields` array in the request to include those fields in the response. To learn about working with _Search_ endpoints, see [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging). > **Notes:** > + This method does not return `variantsInfo`. To retrieve product variants, use the Get Product method. > + To retrieve a non-visible product (`visible: false`), your app must have the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope. | Property | Capabilities | Filters |-------|------------|------| | `allCategoriesInfo.categories` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$matchItems` | | `directCategoriesInfo.categories` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$matchItems` | | `variantsInfo.variants` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$matchItems` | | `infoSections._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `infoSections.uniqueName` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `modifiers._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `modifiers.choicesSettings.choices.choiceId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `modifiers.choicesSettings.choices.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `modifiers.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `options._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `options.choicesSettings.choices.choiceId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `options.choicesSettings.choices.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `options.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$hasAll`, `$hasSome` | | `_id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `brand._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `brand.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `handle` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `inventory.availabilityStatus` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `inventory.preorderAvailability` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `inventory.preorderStatus` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `physicalProperties.deliveryProfileId` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `physicalProperties.fulfillerId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `productType` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `ribbon._id` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `ribbon.name` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `slug` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `subscriptionDetails.allowOneTimePurchases` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `taxGroupId` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `visible` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `visibleInPos` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: ✗ | `$eq`, `$ne`, `$exists`, `$in`, `$any` | | `_createdDate` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` | | `_updatedDate` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` | | `actualPriceRange.maxValue.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `actualPriceRange.minValue.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `compareAtPriceRange.maxValue.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `compareAtPriceRange.minValue.amount` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `minVariantPriceInfo.sku` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `name` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$begins`, `$gt`, `$lt`, `$lte`, `$gte` | | `physicalProperties.shippingWeightRange.maxValue` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` | | `physicalProperties.shippingWeightRange.minValue` | Search: ✗<br/> Aggregate: <span style="color: #2e7d32;">✓</span><br/> Sort: `ASC`, `DESC` | `$eq`, `$ne`, `$exists`, `$in`, `$any`, `$lt`, `$lte`, `$gt`, `$gte` | | `description` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: ✗<br/> Sort: ✗ | | | `directCategoryIdsInfo.categoryIds` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: ✗<br/> Sort: ✗ | | | `physicalProperties.shippingGroupId` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: ✗<br/> Sort: ✗ | | | `variantsInfo.variants.sku` | Search: <span style="color: #2e7d32;">✓</span><br/> Aggregate: ✗<br/> Sort: ✗ | |
|
|
145
|
+
Method parameters:
|
|
146
|
+
param name: search | type: CommonCursorSearch | description: Search options. | required: true
|
|
147
|
+
- name: aggregations | type: Array<WixCommonAggregation> | description: Logical groupings of data into facets, with summaries for each facet. For example, use aggregations to allow site visitors to narrow down their search results by selecting specific categories.
|
|
148
|
+
- name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
149
|
+
- name: name | type: string | description: Aggregation name, returned in `aggregations.results.name`.
|
|
150
|
+
- name: type | type: WixCommonAggregationType | description: Type of aggregation to perform. Must align with the corresponding aggregation field.
|
|
151
|
+
enum:
|
|
152
|
+
DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.).
|
|
153
|
+
NESTED: Flattened list of aggregations, where each aggregation is nested within previous one.
|
|
154
|
+
RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define.
|
|
155
|
+
SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`.
|
|
156
|
+
UNKNOWN_AGGREGATION_TYPE, VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values.
|
|
157
|
+
- ONE-OF:
|
|
158
|
+
- name: dateHistogram | type: CommonAggregationDateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week.
|
|
159
|
+
- name: interval | type: AggregationDateHistogramAggregationInterval | description: Interval for date histogram aggregation.
|
|
160
|
+
enum:
|
|
161
|
+
DAY: Daily interval
|
|
162
|
+
HOUR: Hourly interval
|
|
163
|
+
MINUTE: Minute interval
|
|
164
|
+
MONTH: Monthly interval
|
|
165
|
+
SECOND: Second interval
|
|
166
|
+
UNKNOWN_INTERVAL, WEEK: Weekly interval
|
|
167
|
+
YEAR: Yearly interval
|
|
168
|
+
- name: nested | type: CommonAggregationNestedAggregation | description: A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy. For example, to get the number of products that are in stock and out of stock for each price listed, first perform a value aggregation on `discountedPriceNumeric`, and a second value aggregation on `inStock`.
|
|
169
|
+
- name: nestedAggregations | type: Array<AggregationNestedAggregationNestedAggregationItem> | description: Flattened list of aggregations, where each next aggregation is nested within previous one.
|
|
170
|
+
- name: fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
171
|
+
- name: name | type: string | description: Unique, caller-defined aggregation name, returned in `aggregations.results`.
|
|
172
|
+
- name: type | type: AggregationNestedAggregationNestedAggregationType | description: Type of aggregation to perform. The matching aggregation field must be passed.
|
|
173
|
+
enum:
|
|
174
|
+
DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.).
|
|
175
|
+
RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define.
|
|
176
|
+
SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`.
|
|
177
|
+
UNKNOWN_AGGREGATION_TYPE, VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values.
|
|
178
|
+
- ONE-OF:
|
|
179
|
+
- name: dateHistogram | type: CommonAggregationDateHistogramAggregation | description: A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.). For example, use a date histogram to determine how many reservations have been made at a restaurant each week. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria.
|
|
180
|
+
- name: range | type: CommonAggregationRangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more. If ranges overlap, a record that fits more than one range will only be counted in the first range that matches the criteria.
|
|
181
|
+
- name: buckets | type: Array<AggregationRangeAggregationRangeBucket> | description: List of range buckets. During aggregation each entity is placed in the first bucket its value falls into, based on the provided range bounds.
|
|
182
|
+
- name: from | type: number | description: Inclusive lower bound of the range. Required if `to` is not provided.
|
|
183
|
+
- name: to | type: number | description: Exclusive upper bound of the range. Required if `from` is not provided.
|
|
184
|
+
- name: scalar | type: CommonAggregationScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`.
|
|
185
|
+
- name: type | type: WixCommonScalarType | description: Operator type for the scalar aggregation.
|
|
186
|
+
enum:
|
|
187
|
+
COUNT_DISTINCT: Total number of distinct values.
|
|
188
|
+
MAX: Maximum value.
|
|
189
|
+
MIN: Minimum value.
|
|
190
|
+
UNKNOWN_SCALAR_TYPE
|
|
191
|
+
- name: value | type: CommonAggregationValueAggregation | description: A value aggregation calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of orders for each order status.
|
|
192
|
+
- name: limit | type: number | description: Number of aggregation results to return. Min: `1` Max: `250` Default: `10`
|
|
193
|
+
- name: missingValues | type: AggregationValueAggregationMissingValues | description: Whether to include or exclude missing values in the aggregation results. Default: `EXCLUDE`.
|
|
194
|
+
enum:
|
|
195
|
+
EXCLUDE: Exclude missing values from the aggregation results.
|
|
196
|
+
INCLUDE: Include missing values in the aggregation results.
|
|
197
|
+
- name: sortDirection | type: AggregationValueAggregationSortDirection | description: Sort direction.
|
|
198
|
+
enum:
|
|
199
|
+
ASC: Ascending order.
|
|
200
|
+
DESC: Descending order.
|
|
201
|
+
- name: sortType | type: AggregationValueAggregationSortType | description: Sort type.
|
|
202
|
+
enum:
|
|
203
|
+
COUNT: Number of matches in the results.
|
|
204
|
+
VALUE: Alphabetically by the field value.
|
|
205
|
+
- ONE-OF:
|
|
206
|
+
- name: includeOptions | type: AggregationValueAggregationIncludeMissingValuesOptions | description: Options for including missing values in results.
|
|
207
|
+
- name: addToBucket | type: string | description: Specify a custom name for the bucket containing the missing values. Defaults are `"N/A"` for strings, `0` for integers, and `false` for booleans.
|
|
208
|
+
- name: range | type: CommonAggregationRangeAggregation | description: A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more.
|
|
209
|
+
- name: scalar | type: CommonAggregationScalarAggregation | description: A scalar aggregation calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`.
|
|
210
|
+
- name: value | type: CommonAggregationValueAggregation | description: A value aggregation calculates metrics such as count for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number (count) of products for each price listed in the store.
|
|
211
|
+
- name: filter | type: Record<string, any> | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
|
|
212
|
+
- name: search | type: WixCommonSearchDetails | description: Free text to match in searchable fields.
|
|
213
|
+
- name: expression | type: string | description: Search term or expression
|
|
214
|
+
- name: fields | type: Array<string> | description: Fields to search in. If the array is empty, all searchable fields are searched. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
215
|
+
- name: fuzzy | type: boolean | description: Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions.
|
|
216
|
+
- name: mode | type: CommonSearchDetailsMode | description: Defines how separate search terms in `expression` are combined
|
|
217
|
+
enum:
|
|
218
|
+
AND: All search terms must be present
|
|
219
|
+
OR: Any of the search terms must be present
|
|
220
|
+
- name: sort | type: Array<WixCommonSorting> | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
|
|
221
|
+
- name: fieldName | type: string | description: Name of the field to sort by.
|
|
222
|
+
- name: order | type: WixCommonSortOrder | description: Sort order.
|
|
223
|
+
enum: ASC, DESC
|
|
224
|
+
- name: selectItemsBy | type: Array<undefined> | description: When `field_name` is a property of repeated field that is marked as `MATCH_ITEMS` and sort should be done by a specific element from a collection, filter can/should be provided to ensure correct sort value is picked. If multiple filters are provided, they are combined with AND operator. Example: Given we have document like {"id": "1", "nestedField": [{"price": 10, "region": "EU"}, {"price": 20, "region": "US"}]} and `nestedField` is marked as `MATCH_ITEMS`, to ensure that sorting is done by correct region, filter should be { fieldName: "nestedField.price", "select_items_by": [{"nestedField.region": "US"}] }
|
|
225
|
+
- name: timeZone | type: string | description: Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone GUIDs) format. Applies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".
|
|
226
|
+
- ONE-OF:
|
|
227
|
+
- name: cursorPaging | type: CommonCursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
228
|
+
- name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request.
|
|
229
|
+
- name: limit | type: number | description: Maximum number of items to return in the results.
|
|
230
|
+
param name: options | type: SearchProductsOptions | description: none
|
|
231
|
+
- name: fields | type: Array<RequestedFields> | description: Fields to include in the response.
|
|
232
|
+
enum:
|
|
233
|
+
ALL_CATEGORIES_INFO: Provides GUIDs and indexes for all categories including inherited parent categories.
|
|
234
|
+
BREADCRUMBS_INFO: Returns the category breadcrumb navigation path from root categories down to the product's main category, including category GUIDs, names, and slugs.
|
|
235
|
+
CURRENCY: Currency information including the currency code and formatted price amounts for storefront display.
|
|
236
|
+
DESCRIPTION: Returns the product description as rich content with complete node structure, metadata, and styling information.
|
|
237
|
+
DIRECT_CATEGORIES_INFO: Provides the GUIDs and indexes of categories the product is directly assigned to.
|
|
238
|
+
INFO_SECTION: Returns basic info section metadata including GUIDs, unique names, and titles. Use with `INFO_SECTION_DESCRIPTION` or `INFO_SECTION_PLAIN_DESCRIPTION` to include content.
|
|
239
|
+
INFO_SECTION_DESCRIPTION: Returns info section descriptions as rich content with complete node structure, metadata, and styling information. Use with `INFO_SECTION` for complete metadata.
|
|
240
|
+
INFO_SECTION_PLAIN_DESCRIPTION: Returns info section descriptions as HTML content. Use with `INFO_SECTION` for complete metadata.
|
|
241
|
+
MEDIA_ITEMS_INFO: Returns all media items associated with the product, including detailed metadata (URLs, alt-text, dimensions, filenames, file sizes).
|
|
242
|
+
MERCHANT_DATA: Returns merchant-related financial data including cost ranges and variant revenue details like cost, profit, and profit margin. Requires the `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
243
|
+
PLAIN_DESCRIPTION: Provides product description as plain HTML text.
|
|
244
|
+
SUBSCRIPTION_PRICES_INFO: Details subscription pricing options, empty for non-subscription products.
|
|
245
|
+
THUMBNAIL: Returns an optimized thumbnail image with standard dimensions, suitable for listings or previews.
|
|
246
|
+
UNKNOWN_REQUESTED_FIELD: Not implemented.
|
|
247
|
+
URL: The product's public storefront URL, including both relative path and full URL with base domain.
|
|
248
|
+
VARIANT_OPTION_CHOICE_NAMES: Enriches variant choices with human-readable option and choice names alongside render types.
|
|
249
|
+
WEIGHT_MEASUREMENT_UNIT_INFO: Returns the weight measurement unit (KG, LB) for the product.
|
|
250
|
+
Return type: PROMISE<V3SearchProductsResponse>
|
|
251
|
+
- name: aggregationData | type: CommonAggregationData | description: Aggregation data.
|
|
252
|
+
- name: aggregationData.results | type: Array<AggregationDataAggregationResults> | description: List of the aggregated data results.
|
|
253
|
+
- name: aggregationData.results[].fieldPath | type: string | description: Field to aggregate by. Use dot notation to specify a JSON path. For example, `order.address.streetName`.
|
|
254
|
+
- name: aggregationData.results[].name | type: string | description: Aggregation name, returned in `aggregations.results.name`.
|
|
255
|
+
- name: aggregationData.results[].type | type: WixCommonAggregationType | description: Aggregation type. Must align with the corresponding aggregation field.
|
|
256
|
+
enum:
|
|
257
|
+
DATE_HISTOGRAM: Calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.).
|
|
258
|
+
NESTED: Flattened list of aggregations, where each aggregation is nested within previous one.
|
|
259
|
+
RANGE: Calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define.
|
|
260
|
+
SCALAR: Calculates a single numerical value from a dataset, summarizing the dataset into one key metric: `COUNT_DISTINCT`, `SUM`, `AVG`, `MIN`, or `MAX`.
|
|
261
|
+
UNKNOWN_AGGREGATION_TYPE, VALUE: Calculates the distribution of a specific field's values within a dataset, providing insights into the overall distribution and key statistics of those values.
|
|
262
|
+
- ONE-OF:
|
|
263
|
+
- name: aggregationData.results[].dateHistogram | type: AggregationResultsDateHistogramResults | description: Date histogram aggregation results.
|
|
264
|
+
- name: aggregationData.results[].dateHistogram.results | type: Array<DateHistogramResultsDateHistogramResult> | description: List of date histogram aggregations.
|
|
265
|
+
- name: aggregationData.results[].dateHistogram.results[].count | type: number | description: Number of entities in the bucket.
|
|
266
|
+
- name: aggregationData.results[].dateHistogram.results[].value | type: string | description: Date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
|
|
267
|
+
- name: aggregationData.results[].groupedByValue | type: AggregationResultsGroupByValueResults | description: Group by value aggregation results.
|
|
268
|
+
- name: aggregationData.results[].groupedByValue.results | type: Array<GroupByValueResultsNestedValueAggregationResult> | description: List of value aggregations.
|
|
269
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults | type: AggregationResultsNestedAggregationResults | description: Nested aggregations.
|
|
270
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.fieldPath | type: string | description: Field which the data was aggregated by.
|
|
271
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.name | type: string | description: Unique, caller-defined aggregation name, identifiable by the requested aggregation `name`.
|
|
272
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.type | type: WixCommonAggregationType | description: Aggregation type.
|
|
273
|
+
- ONE-OF:
|
|
274
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges | type: AggregationResultsRangeResults | description: Range aggregation results.
|
|
275
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges.results | type: Array<RangeResultsRangeAggregationResult> | description: List of ranges returned in same order as requested.
|
|
276
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges.results[].count | type: number | description: Total number of entities in this range.
|
|
277
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges.results[].from | type: number | description: Inclusive lower bound of the range.
|
|
278
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.ranges.results[].to | type: number | description: Exclusive upper bound of the range.
|
|
279
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.scalar | type: AggregationDataAggregationResultsScalarResult | description: Scalar aggregation results.
|
|
280
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.scalar.type | type: WixCommonScalarType | description: Type of scalar aggregation.
|
|
281
|
+
enum:
|
|
282
|
+
COUNT_DISTINCT: Total number of distinct values.
|
|
283
|
+
MAX: Maximum value.
|
|
284
|
+
MIN: Minimum value.
|
|
285
|
+
UNKNOWN_SCALAR_TYPE
|
|
286
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.scalar.value | type: number | description: Value of the scalar aggregation.
|
|
287
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.values | type: AggregationResultsValueResults | description: Value aggregation results.
|
|
288
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.values.results | type: Array<ValueResultsValueAggregationResult> | description: List of value aggregations.
|
|
289
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.values.results[].count | type: number | description: Number of entities with this value.
|
|
290
|
+
- name: aggregationData.results[].groupedByValue.results[].nestedResults.values.results[].value | type: string | description: Value of the field.
|
|
291
|
+
- name: aggregationData.results[].groupedByValue.results[].value | type: string | description: Value of the field.
|
|
292
|
+
- name: aggregationData.results[].nested | type: AggregationResultsNestedResults | description: Nested aggregation results.
|
|
293
|
+
- name: aggregationData.results[].nested.results | type: Array<NestedResultsResults> | description: List of nested aggregations.
|
|
294
|
+
- name: aggregationData.results[].nested.results[].results | type: Record<string, NestedResultsNestedResultValue> | description: List of nested aggregations.
|
|
295
|
+
- name: aggregationData.results[].ranges | type: AggregationResultsRangeResults | description: Range aggregation results.
|
|
296
|
+
- name: aggregationData.results[].scalar | type: AggregationDataAggregationResultsScalarResult | description: Scalar aggregation results.
|
|
297
|
+
- name: aggregationData.results[].values | type: AggregationResultsValueResults | description: Value aggregation results.
|
|
298
|
+
- name: pagingMetadata | type: CommonCursorPagingMetadata | description: Paging metadata.
|
|
299
|
+
- name: pagingMetadata.count | type: number | description: Number of items returned in the response.
|
|
300
|
+
- name: pagingMetadata.cursors | type: CommonCursors | description: Cursor strings that point to the next page, previous page, or both.
|
|
301
|
+
- name: pagingMetadata.cursors.next | type: string | description: Cursor string pointing to the next page in the list of results.
|
|
302
|
+
- name: pagingMetadata.cursors.prev | type: string | description: Cursor pointing to the previous page in the list of results.
|
|
303
|
+
- name: pagingMetadata.hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page.
|
|
304
|
+
- name: products | type: Array<V3Product> | description: List of products.
|
|
305
|
+
- name: products[]._createdDate | type: Date | description: Date and time the product was created.
|
|
306
|
+
- name: products[]._id | type: string | description: Product GUID.
|
|
307
|
+
- name: products[]._updatedDate | type: Date | description: Date and time the product was updated.
|
|
308
|
+
- name: products[].actualPriceRange | type: PriceRange | description: Product actualPrice range - minimum and maximum prices of all product variants.
|
|
309
|
+
- name: products[].actualPriceRange.maxValue | type: FixedMonetaryAmount | description: Maximum value.
|
|
310
|
+
- name: products[].actualPriceRange.maxValue.amount | type: string | description: Monetary amount. For example, `"3.99"`, or `"-4.99"` for a negative amount.
|
|
311
|
+
- name: products[].actualPriceRange.maxValue.formattedAmount | type: string | description: Formatted monetary amount. For example, `"$3.99"`. > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
|
|
312
|
+
- name: products[].actualPriceRange.minValue | type: FixedMonetaryAmount | description: Minimum value.
|
|
313
|
+
- name: products[].allCategoriesInfo | type: ProductCategoriesInfo | description: List of categories that directly contain this product, as well as their parent categories. > **Note:** Returned only when you pass `"ALL_CATEGORIES_INFO"` to the `fields` array in Products API requests.
|
|
314
|
+
- name: products[].allCategoriesInfo.categories | type: Array<ProductCategory> | description: A list of categories related to product.
|
|
315
|
+
- name: products[].allCategoriesInfo.categories[]._id | type: string | description: Category GUID.
|
|
316
|
+
- name: products[].allCategoriesInfo.categories[].index | type: number | description: Index location of the product within the category, which can be utilized for sorting products in a specific category. For detailed instructions on how to set this up, refer to the [Add and arrange products in category](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/products-v3/sample-use-cases-and-flows#add-and-arrange-products-in-category) sample flow.
|
|
317
|
+
- name: products[].brand | type: Brand | description: Product brand. + Pass `brand.name` to add a new brand while creating a product. + Pass an existing brand's `id` to assign that brand to the product.
|
|
318
|
+
- name: products[].brand._id | type: string | description: Brand GUID.
|
|
319
|
+
- name: products[].brand.name | type: string | description: Brand name.
|
|
320
|
+
- name: products[].breadcrumbsInfo | type: BreadcrumbsInfo | description: Breadcrumbs of the `mainCategoryId`. Used to navigate to parent categories. > **Note:** Returned only when you pass `"BREADCRUMBS_INFO"` to the `fields` array in Products API requests.
|
|
321
|
+
- name: products[].breadcrumbsInfo.breadcrumbs | type: Array<BreadCrumb> | description: Breadcrumbs.
|
|
322
|
+
- name: products[].breadcrumbsInfo.breadcrumbs[].categoryId | type: string | description: Category GUID.
|
|
323
|
+
- name: products[].breadcrumbsInfo.breadcrumbs[].categoryName | type: string | description: Category name.
|
|
324
|
+
- name: products[].breadcrumbsInfo.breadcrumbs[].categorySlug | type: string | description: Category slug.
|
|
325
|
+
- name: products[].compareAtPriceRange | type: PriceRange | description: Product compareAtPrice range - minimum and maximum compare at prices of all product variants.
|
|
326
|
+
- name: products[].costRange | type: PriceRange | description: Product cost range - minimum and maximum costs of all product variants. > **Note:** Returned only when the following conditions are met: > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests. > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
327
|
+
- name: products[].currency | type: string | description: Currency used for the pricing of this product, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. Defaults to the currency defined in the site settings, unless specified in `x-wix-currency` header. > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
|
|
328
|
+
- name: products[].description | type: RichContent | description: Product description using rich content. > **Note:** Returned only when you pass `"DESCRIPTION"` to the `fields` array in Products API requests. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303"> <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a> </widget>
|
|
329
|
+
- name: products[].description.documentStyle | type: DocumentStyle | description: Global styling for header, paragraph, block quote, and code block nodes in the object.
|
|
330
|
+
- name: products[].description.documentStyle.blockquote | type: TextNodeStyle | description: Styling for block quote nodes.
|
|
331
|
+
- name: products[].description.documentStyle.blockquote.decorations | type: Array<Decoration> | description: The decorations to apply to the node.
|
|
332
|
+
- name: products[].description.documentStyle.blockquote.decorations[].type | type: DecorationType | description: The type of decoration to apply.
|
|
333
|
+
enum: ANCHOR, BOLD, COLOR, EXTERNAL, FONT_FAMILY, FONT_SIZE, ITALIC, LINK, MENTION, SPOILER, STRIKETHROUGH, SUBSCRIPT, SUPERSCRIPT, UNDERLINE
|
|
334
|
+
- ONE-OF:
|
|
335
|
+
- name: products[].description.documentStyle.blockquote.decorations[].anchorData | type: AnchorData | description: Data for an anchor link decoration.
|
|
336
|
+
- name: products[].description.documentStyle.blockquote.decorations[].anchorData.anchor | type: string | description: The target node's GUID.
|
|
337
|
+
- name: products[].description.documentStyle.blockquote.decorations[].colorData | type: ColorData | description: Data for a color decoration.
|
|
338
|
+
- name: products[].description.documentStyle.blockquote.decorations[].colorData.background | type: string | description: The text's background color as a hexadecimal value.
|
|
339
|
+
- name: products[].description.documentStyle.blockquote.decorations[].colorData.foreground | type: string | description: The text's foreground color as a hexadecimal value.
|
|
340
|
+
- name: products[].description.documentStyle.blockquote.decorations[].fontFamilyData | type: FontFamilyData | description: Data for a font family decoration.
|
|
341
|
+
- name: products[].description.documentStyle.blockquote.decorations[].fontFamilyData.value | type: string | description: none
|
|
342
|
+
- name: products[].description.documentStyle.blockquote.decorations[].fontSizeData | type: FontSizeData | description: Data for a font size decoration.
|
|
343
|
+
- name: products[].description.documentStyle.blockquote.decorations[].fontSizeData.unit | type: FontType | description: The units used for the font size.
|
|
344
|
+
enum: EM, PX
|
|
345
|
+
- name: products[].description.documentStyle.blockquote.decorations[].fontSizeData.value | type: number | description: Font size value.
|
|
346
|
+
- name: products[].description.documentStyle.blockquote.decorations[].fontWeightValue | type: number | description: Font weight for a bold decoration.
|
|
347
|
+
- name: products[].description.documentStyle.blockquote.decorations[].italicData | type: boolean | description: Data for an italic decoration. Defaults to `true`.
|
|
348
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData | type: LinkData | description: Data for an external link decoration.
|
|
349
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link | type: Link | description: Link details.
|
|
350
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.customData | type: string | description: A serialized object used for a custom or external link panel.
|
|
351
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.rel | type: Rel | description: The HTML `rel` attribute value for the link. This object specifies the relationship between the current document and the linked document.
|
|
352
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.rel.nofollow | type: boolean | description: Indicates to search engine crawlers not to follow the link. Defaults to `false`.
|
|
353
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.rel.noreferrer | type: boolean | description: Indicates that this link protect referral information from being passed to the target website.
|
|
354
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.rel.sponsored | type: boolean | description: Indicates to search engine crawlers that the link is a paid placement such as sponsored content or an advertisement. Defaults to `false`.
|
|
355
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.rel.ugc | type: boolean | description: Indicates that this link is user-generated content and isn't necessarily trusted or endorsed by the page’s author. For example, a link in a fourm post. Defaults to `false`.
|
|
356
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.target | type: Target | description: he HTML `target` attribute value for the link. This property defines where the linked document opens as follows: `SELF` - Default. Opens the linked document in the same frame as the link. `BLANK` - Opens the linked document in a new browser tab or window. `PARENT` - Opens the linked document in the link's parent frame. `TOP` - Opens the linked document in the full body of the link's browser tab or window.
|
|
357
|
+
enum:
|
|
358
|
+
BLANK: Opens the linked document in a new window or tab
|
|
359
|
+
PARENT: Opens the linked document in the parent frame
|
|
360
|
+
SELF: Opens the linked document in the same frame as it was clicked (this is default)
|
|
361
|
+
TOP: Opens the linked document in the full body of the window
|
|
362
|
+
- ONE-OF:
|
|
363
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.anchor | type: string | description: The target node's GUID. Used for linking to another node in this object.
|
|
364
|
+
- name: products[].description.documentStyle.blockquote.decorations[].linkData.link.url | type: string | description: The absolute URL for the linked document.
|
|
365
|
+
- name: products[].description.documentStyle.blockquote.decorations[].mentionData | type: MentionData | description: Data for a mention decoration.
|
|
366
|
+
- name: products[].description.documentStyle.blockquote.decorations[].mentionData.id | type: string | description: Mentioned user's GUID.
|
|
367
|
+
- name: products[].description.documentStyle.blockquote.decorations[].mentionData.name | type: string | description: The mentioned user's name.
|
|
368
|
+
- name: products[].description.documentStyle.blockquote.decorations[].mentionData.slug | type: string | description: The version of the user's name that appears after the `@` character in the mention.
|
|
369
|
+
- name: products[].description.documentStyle.blockquote.decorations[].spoilerData | type: SpoilerData | description: Data for a spoiler decoration.
|
|
370
|
+
- name: products[].description.documentStyle.blockquote.decorations[].spoilerData.id | type: string | description: Spoiler GUID.
|
|
371
|
+
- name: products[].description.documentStyle.blockquote.decorations[].strikethroughData | type: boolean | description: Data for a strikethrough decoration. Defaults to `true`.
|
|
372
|
+
- name: products[].description.documentStyle.blockquote.decorations[].subscriptData | type: boolean | description: Data for a subscript decoration. Defaults to `true`.
|
|
373
|
+
- name: products[].description.documentStyle.blockquote.decorations[].superscriptData | type: boolean | description: Data for a superscript decoration. Defaults to `true`.
|
|
374
|
+
- name: products[].description.documentStyle.blockquote.decorations[].underlineData | type: boolean | description: Data for an underline decoration. Defaults to `true`.
|
|
375
|
+
- name: products[].description.documentStyle.blockquote.lineHeight | type: string | description: Line height for text in the node.
|
|
376
|
+
- name: products[].description.documentStyle.blockquote.nodeStyle | type: NodeStyle | description: Padding and background color for the node.
|
|
377
|
+
- name: products[].description.documentStyle.blockquote.nodeStyle.backgroundColor | type: string | description: The background color as a hexadecimal value.
|
|
378
|
+
- name: products[].description.documentStyle.blockquote.nodeStyle.paddingBottom | type: string | description: The bottom padding value in pixels.
|
|
379
|
+
- name: products[].description.documentStyle.blockquote.nodeStyle.paddingTop | type: string | description: The top padding value in pixels.
|
|
380
|
+
- name: products[].description.documentStyle.codeBlock | type: TextNodeStyle | description: Styling for code block nodes.
|
|
381
|
+
- name: products[].description.documentStyle.headerFive | type: TextNodeStyle | description: Styling for H5 nodes.
|
|
382
|
+
- name: products[].description.documentStyle.headerFour | type: TextNodeStyle | description: Styling for H4 nodes.
|
|
383
|
+
- name: products[].description.documentStyle.headerOne | type: TextNodeStyle | description: Styling for H1 nodes.
|
|
384
|
+
- name: products[].description.documentStyle.headerSix | type: TextNodeStyle | description: Styling for H6 nodes.
|
|
385
|
+
- name: products[].description.documentStyle.headerThree | type: TextNodeStyle | description: Styling for H3 nodes.
|
|
386
|
+
- name: products[].description.documentStyle.headerTwo | type: TextNodeStyle | description: Styling for H2 nodes.
|
|
387
|
+
- name: products[].description.documentStyle.paragraph | type: TextNodeStyle | description: Styling for paragraph nodes.
|
|
388
|
+
- name: products[].description.metadata | type: Metadata | description: Object metadata.
|
|
389
|
+
- name: products[].description.metadata._id | type: string | description: Object GUID.
|
|
390
|
+
- name: products[].description.metadata.version | type: number | description: Schema version.
|
|
391
|
+
- name: products[].description.nodes | type: Array<Node> | description: Node objects representing a rich content document.
|
|
392
|
+
- name: products[].description.nodes[].id | type: string | description: Node GUID.
|
|
393
|
+
- name: products[].description.nodes[].nodes | type: Array<Node> | description: A list of child nodes.
|
|
394
|
+
- name: products[].description.nodes[].style | type: NodeStyle | description: Padding and background color styling for the node.
|
|
395
|
+
- name: products[].description.nodes[].type | type: NodeType | description: Node type. Use `APP_EMBED` for nodes that embed content from other Wix apps. Use `EMBED` to embed content in [oEmbed](https://oembed.com/) format.
|
|
396
|
+
enum: APP_EMBED, AUDIO, BLOCKQUOTE, BULLETED_LIST, BUTTON, CAPTION, CODE_BLOCK, COLLAPSIBLE_ITEM, COLLAPSIBLE_ITEM_BODY, COLLAPSIBLE_ITEM_TITLE, COLLAPSIBLE_LIST, DIVIDER, EMBED, EXTERNAL, FILE, GALLERY, GIF, HEADING, HTML, IMAGE, LAYOUT, LAYOUT_CELL, LINK_PREVIEW, LIST_ITEM, MAP, ORDERED_LIST, PARAGRAPH, POLL, TABLE, TABLE_CELL, TABLE_ROW, TEXT, VIDEO
|
|
397
|
+
- ONE-OF:
|
|
398
|
+
- name: products[].description.nodes[].appEmbedData | type: AppEmbedData | description: Data for an app embed node.
|
|
399
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles | type: ButtonStyles | description: Button styling options.
|
|
400
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.backgroundColor | type: string | description: Background color as a hexadecimal value.
|
|
401
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.backgroundColorHover | type: string | description: Background color as a hexadecimal value (hover state).
|
|
402
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.borderColor | type: string | description: Border color as a hexadecimal value.
|
|
403
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.borderColorHover | type: string | description: Border color as a hexadecimal value (hover state).
|
|
404
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.borderRadius | type: number | description: Border radius in pixels.
|
|
405
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.borderWidth | type: number | description: Border width in pixels.
|
|
406
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.
|
|
407
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.buttonText | type: string | description: Text to display on the button.
|
|
408
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.textColor | type: string | description: Text color as a hexadecimal value.
|
|
409
|
+
- name: products[].description.nodes[].appEmbedData.buttonStyles.textColorHover | type: string | description: Text color as a hexadecimal value (hover state).
|
|
410
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles | type: CardStyles | description: Card styling options.
|
|
411
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.alignment | type: Alignment | description: Content alignment. Defaults to `START`.
|
|
412
|
+
enum:
|
|
413
|
+
CENTER: Content centered
|
|
414
|
+
END: Content aligned to end (right in LTR layouts, left in RTL layouts)
|
|
415
|
+
START: Content aligned to start (left in LTR layouts, right in RTL layouts)
|
|
416
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.backgroundColor | type: string | description: Card background color as a hexadecimal value.
|
|
417
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.borderColor | type: string | description: Card border color as a hexadecimal value.
|
|
418
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.borderRadius | type: number | description: Card border radius in pixels.
|
|
419
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.borderWidth | type: number | description: Card border width in pixels.
|
|
420
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.textColor | type: string | description: Text color as a hexadecimal value.
|
|
421
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.titleColor | type: string | description: Title text color as a hexadecimal value.
|
|
422
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.titlePriceLayout | type: Layout | description: Layout for title and price. Defaults to `STACKED`.
|
|
423
|
+
enum:
|
|
424
|
+
SIDE_BY_SIDE: Elements arranged horizontally
|
|
425
|
+
STACKED: Elements stacked vertically
|
|
426
|
+
- name: products[].description.nodes[].appEmbedData.cardStyles.type | type: Type | description: Card type. Defaults to `CONTAINED`.
|
|
427
|
+
enum:
|
|
428
|
+
CONTAINED: Card with visible border and background
|
|
429
|
+
FRAMELESS: Card without visible border
|
|
430
|
+
- name: products[].description.nodes[].appEmbedData.containerData | type: PluginContainerData | description: Styling for the app embed's container.
|
|
431
|
+
- name: products[].description.nodes[].appEmbedData.containerData.alignment | type: PluginContainerDataAlignment | description: The node's alignment within its container.
|
|
432
|
+
enum:
|
|
433
|
+
CENTER: Center Alignment
|
|
434
|
+
LEFT: Left Alignment
|
|
435
|
+
RIGHT: Right Alignment
|
|
436
|
+
- name: products[].description.nodes[].appEmbedData.containerData.height | type: Height | description: The height of the node when it's displayed.
|
|
437
|
+
- name: products[].description.nodes[].appEmbedData.containerData.height.custom | type: string | description: A custom height value in pixels.
|
|
438
|
+
- name: products[].description.nodes[].appEmbedData.containerData.spoiler | type: Spoiler | description: Spoiler cover settings for the node.
|
|
439
|
+
- name: products[].description.nodes[].appEmbedData.containerData.spoiler.buttonText | type: string | description: The text for the button used to remove the spoiler cover.
|
|
440
|
+
- name: products[].description.nodes[].appEmbedData.containerData.spoiler.description | type: string | description: The description displayed on top of the spoiler cover.
|
|
441
|
+
- name: products[].description.nodes[].appEmbedData.containerData.spoiler.enabled | type: boolean | description: Sets whether the spoiler cover is enabled for this node. Defaults to `false`.
|
|
442
|
+
- name: products[].description.nodes[].appEmbedData.containerData.textWrap | type: boolean | description: Sets whether text should wrap around this node when it's displayed. If `textWrap` is `false`, the node takes up the width of its container. Defaults to `true` for all node types except 'DIVIVDER' where it defaults to `false`.
|
|
443
|
+
- name: products[].description.nodes[].appEmbedData.containerData.width | type: PluginContainerDataWidth | description: The width of the node when it's displayed.
|
|
444
|
+
- ONE-OF:
|
|
445
|
+
- name: products[].description.nodes[].appEmbedData.containerData.width.custom | type: string | description: A custom width value in pixels.
|
|
446
|
+
- name: products[].description.nodes[].appEmbedData.containerData.width.size | type: WidthType | description: One of the following predefined width options: `CONTENT`: The width of the container matches the content width. `SMALL`: A small width. `ORIGINAL`: For `imageData` containers only. The width of the container matches the original image width. `FULL_WIDTH`: For `imageData` containers only. The image container takes up the full width of the screen.
|
|
447
|
+
enum:
|
|
448
|
+
CONTENT: Width matches the content width
|
|
449
|
+
FULL_WIDTH: coast-to-coast display
|
|
450
|
+
ORIGINAL: Width will match the original asset width
|
|
451
|
+
SMALL: Small Width
|
|
452
|
+
- name: products[].description.nodes[].appEmbedData.hideButton | type: boolean | description: Whether to hide the button.
|
|
453
|
+
- name: products[].description.nodes[].appEmbedData.hideDateTime | type: boolean | description: Whether to hide the date and time (Event).
|
|
454
|
+
- name: products[].description.nodes[].appEmbedData.hideDescription | type: boolean | description: Whether to hide the description (Event and Booking).
|
|
455
|
+
- name: products[].description.nodes[].appEmbedData.hideDuration | type: boolean | description: Whether to hide the duration (Booking).
|
|
456
|
+
- name: products[].description.nodes[].appEmbedData.hideImage | type: boolean | description: Whether to hide the image.
|
|
457
|
+
- name: products[].description.nodes[].appEmbedData.hideLocation | type: boolean | description: Whether to hide the location (Event).
|
|
458
|
+
- name: products[].description.nodes[].appEmbedData.hidePrice | type: boolean | description: Whether to hide the price.
|
|
459
|
+
- name: products[].description.nodes[].appEmbedData.hideRibbon | type: boolean | description: Whether to hide the ribbon.
|
|
460
|
+
- name: products[].description.nodes[].appEmbedData.hideTitle | type: boolean | description: Whether to hide the title.
|
|
461
|
+
- name: products[].description.nodes[].appEmbedData.image | type: V1Media | description: An image for the embedded content.
|
|
462
|
+
- name: products[].description.nodes[].appEmbedData.image.duration | type: number | description: Media duration in seconds. Only relevant for audio and video files.
|
|
463
|
+
- name: products[].description.nodes[].appEmbedData.image.height | type: number | description: Media height in pixels.
|
|
464
|
+
- name: products[].description.nodes[].appEmbedData.image.src | type: FileSource | description: The source for the media's data.
|
|
465
|
+
- name: products[].description.nodes[].appEmbedData.image.src.private | type: boolean | description: Indicates whether the file's source is private. Defaults to `false`.
|
|
466
|
+
- ONE-OF:
|
|
467
|
+
- name: products[].description.nodes[].appEmbedData.image.src.custom | type: string | description: Custom GUID. Use `id` instead.
|
|
468
|
+
- name: products[].description.nodes[].appEmbedData.image.src.id | type: string | description: An GUID that's resolved to a URL by a resolver function.
|
|
469
|
+
- name: products[].description.nodes[].appEmbedData.image.src.url | type: string | description: The absolute URL for the file's source.
|
|
470
|
+
- name: products[].description.nodes[].appEmbedData.image.width | type: number | description: Media width in pixels.
|
|
471
|
+
- name: products[].description.nodes[].appEmbedData.imageStyles | type: ImageStyles | description: Image styling options.
|
|
472
|
+
- name: products[].description.nodes[].appEmbedData.imageStyles.aspectRatio | type: AspectRatio | description: Aspect ratio for the image. Defaults to `SQUARE`.
|
|
473
|
+
enum:
|
|
474
|
+
RECTANGLE: 16:9 aspect ratio
|
|
475
|
+
SQUARE: 1:1 aspect ratio
|
|
476
|
+
- name: products[].description.nodes[].appEmbedData.imageStyles.borderColor | type: string | description: Image border color as a hexadecimal value.
|
|
477
|
+
- name: products[].description.nodes[].appEmbedData.imageStyles.borderRadius | type: number | description: Image border radius in pixels.
|
|
478
|
+
- name: products[].description.nodes[].appEmbedData.imageStyles.borderWidth | type: number | description: Image border width in pixels.
|
|
479
|
+
- name: products[].description.nodes[].appEmbedData.imageStyles.hideImage | type: boolean | description: Whether to hide the image.
|
|
480
|
+
- name: products[].description.nodes[].appEmbedData.imageStyles.imagePosition | type: Position | description: Position of image. Defaults to `START`.
|
|
481
|
+
enum:
|
|
482
|
+
END: Image positioned at the end (right in LTR layouts, left in RTL layouts)
|
|
483
|
+
START: Image positioned at the start (left in LTR layouts, right in RTL layouts)
|
|
484
|
+
TOP: Image positioned at the top
|
|
485
|
+
- name: products[].description.nodes[].appEmbedData.imageStyles.resizing | type: Resizing | description: How the image should be resized. Defaults to `FILL`.
|
|
486
|
+
enum:
|
|
487
|
+
FILL: Fill the container, may crop the image
|
|
488
|
+
FIT: Fit the image within the container
|
|
489
|
+
- name: products[].description.nodes[].appEmbedData.itemId | type: string | description: The GUID of the embedded content.
|
|
490
|
+
- name: products[].description.nodes[].appEmbedData.name | type: string | description: The name of the embedded content.
|
|
491
|
+
- name: products[].description.nodes[].appEmbedData.pricingData | type: PricingData | description: Pricing data for embedded Wix App content.
|
|
492
|
+
- name: products[].description.nodes[].appEmbedData.pricingData.currency | type: string | description: Currency of the value in ISO 4217 format (e.g., "USD", "EUR").
|
|
493
|
+
- name: products[].description.nodes[].appEmbedData.pricingData.discountedValue | type: string | description: Numeric price value as string after discount application (e.g., "15.99").
|
|
494
|
+
- name: products[].description.nodes[].appEmbedData.pricingData.pricingPlanId | type: string | description: Pricing plan GUID.
|
|
495
|
+
- name: products[].description.nodes[].appEmbedData.pricingData.valueFrom | type: string | description: Minimum numeric price value as string (e.g., "10.99").
|
|
496
|
+
- name: products[].description.nodes[].appEmbedData.pricingData.valueTo | type: string | description: Maximum numeric price value as string (e.g., "19.99").
|
|
497
|
+
- name: products[].description.nodes[].appEmbedData.ribbonStyles | type: RibbonStyles | description: Ribbon styling options.
|
|
498
|
+
- name: products[].description.nodes[].appEmbedData.ribbonStyles.backgroundColor | type: string | description: Ribbon background color as a hexadecimal value.
|
|
499
|
+
- name: products[].description.nodes[].appEmbedData.ribbonStyles.borderColor | type: string | description: Ribbon border color as a hexadecimal value.
|
|
500
|
+
- name: products[].description.nodes[].appEmbedData.ribbonStyles.borderRadius | type: number | description: Ribbon border radius in pixels.
|
|
501
|
+
- name: products[].description.nodes[].appEmbedData.ribbonStyles.borderWidth | type: number | description: Ribbon border width in pixels.
|
|
502
|
+
- name: products[].description.nodes[].appEmbedData.ribbonStyles.ribbonPlacement | type: Placement | description: Placement of the ribbon. Defaults to `IMAGE`.
|
|
503
|
+
enum:
|
|
504
|
+
IMAGE: Ribbon placed on the image
|
|
505
|
+
PRODUCT_INFO: Ribbon placed on the product information
|
|
506
|
+
- name: products[].description.nodes[].appEmbedData.ribbonStyles.ribbonText | type: string | description: Text to display on the ribbon.
|
|
507
|
+
- name: products[].description.nodes[].appEmbedData.ribbonStyles.textColor | type: string | description: Ribbon text color as a hexadecimal value.
|
|
508
|
+
- name: products[].description.nodes[].appEmbedData.type | type: AppType | description: The type of Wix App content being embedded.
|
|
509
|
+
enum: BOOKING, EVENT, PRODUCT
|
|
510
|
+
- name: products[].description.nodes[].appEmbedData.url | type: string | description: The URL for the embedded content.
|
|
511
|
+
- ONE-OF:
|
|
512
|
+
- name: products[].description.nodes[].appEmbedData.bookingData | type: BookingData | description: Data for embedded Wix Bookings content.
|
|
513
|
+
- name: products[].description.nodes[].appEmbedData.bookingData.durations | type: string | description: Booking duration in minutes.
|
|
514
|
+
- name: products[].description.nodes[].appEmbedData.eventData | type: EventData | description: Data for embedded Wix Events content.
|
|
515
|
+
- name: products[].description.nodes[].appEmbedData.eventData.location | type: string | description: Event location.
|
|
516
|
+
- name: products[].description.nodes[].appEmbedData.eventData.scheduling | type: string | description: Event schedule.
|
|
517
|
+
- name: products[].description.nodes[].audioData | type: AudioData | description: Data for an audio node.
|
|
518
|
+
- name: products[].description.nodes[].audioData.audio | type: V1Media | description: Audio file details.
|
|
519
|
+
- name: products[].description.nodes[].audioData.authorName | type: string | description: Author name.
|
|
520
|
+
- name: products[].description.nodes[].audioData.containerData | type: PluginContainerData | description: Styling for the audio node's container.
|
|
521
|
+
- name: products[].description.nodes[].audioData.coverImage | type: V1Media | description: Cover image.
|
|
522
|
+
- name: products[].description.nodes[].audioData.disableDownload | type: boolean | description: Sets whether the audio node's download button is disabled. Defaults to `false`.
|
|
523
|
+
- name: products[].description.nodes[].audioData.html | type: string | description: An HTML version of the audio node.
|
|
524
|
+
- name: products[].description.nodes[].audioData.name | type: string | description: Track name.
|
|
525
|
+
- name: products[].description.nodes[].blockquoteData | type: BlockquoteData | description: Data for a block quote node.
|
|
526
|
+
- name: products[].description.nodes[].blockquoteData.indentation | type: number | description: Indentation level from 1-4.
|
|
527
|
+
- name: products[].description.nodes[].bulletedListData | type: BulletedListData | description: Data for a bulleted list node.
|
|
528
|
+
- name: products[].description.nodes[].bulletedListData.indentation | type: number | description: Indentation level from 0-4.
|
|
529
|
+
- name: products[].description.nodes[].bulletedListData.offset | type: number | description: Offset level from 0-4.
|
|
530
|
+
- name: products[].description.nodes[].buttonData | type: ButtonData | description: Data for a button node.
|
|
531
|
+
- name: products[].description.nodes[].buttonData.containerData | type: PluginContainerData | description: Styling for the button's container.
|
|
532
|
+
- name: products[].description.nodes[].buttonData.link | type: Link | description: Button link details.
|
|
533
|
+
- name: products[].description.nodes[].buttonData.styles | type: Styles | description: Styling for the button.
|
|
534
|
+
- name: products[].description.nodes[].buttonData.styles.backgroundColor | type: string | description: Background color as a hexadecimal value.
|
|
535
|
+
- name: products[].description.nodes[].buttonData.styles.backgroundColorHover | type: string | description: Background color as a hexadecimal value (hover state).
|
|
536
|
+
- name: products[].description.nodes[].buttonData.styles.borderColor | type: string | description: Border color as a hexadecimal value.
|
|
537
|
+
- name: products[].description.nodes[].buttonData.styles.borderColorHover | type: string | description: Border color as a hexadecimal value (hover state).
|
|
538
|
+
- name: products[].description.nodes[].buttonData.styles.borderRadius | type: number | description: Border radius in pixels.
|
|
539
|
+
- name: products[].description.nodes[].buttonData.styles.borderWidth | type: number | description: Border width in pixels.
|
|
540
|
+
- name: products[].description.nodes[].buttonData.styles.buttonSize | type: string | description: Button size option, one of `SMALL`, `MEDIUM` or `LARGE`. Defaults to `MEDIUM`.
|
|
541
|
+
- name: products[].description.nodes[].buttonData.styles.textColor | type: string | description: Text color as a hexadecimal value.
|
|
542
|
+
- name: products[].description.nodes[].buttonData.styles.textColorHover | type: string | description: Text color as a hexadecimal value (hover state).
|
|
543
|
+
- name: products[].description.nodes[].buttonData.text | type: string | description: The text to display on the button.
|
|
544
|
+
- name: products[].description.nodes[].buttonData.type | type: ButtonDataType | description: The button type.
|
|
545
|
+
enum:
|
|
546
|
+
ACTION: Triggers custom action that is defined in plugin configuration by the consumer
|
|
547
|
+
LINK: Regular link button
|
|
548
|
+
- name: products[].description.nodes[].captionData | type: CaptionData | description: Data for a caption node.
|
|
549
|
+
- name: products[].description.nodes[].captionData.textStyle | type: TextStyle | description: none
|
|
550
|
+
- name: products[].description.nodes[].captionData.textStyle.lineHeight | type: string | description: A CSS `line-height` value for the text expressed as a ratio relative to the font size. For example, if the font size is 20px, a `lineHeight` value of `'1.5'`` results in a line height of 30px.
|
|
551
|
+
- name: products[].description.nodes[].captionData.textStyle.textAlignment | type: TextAlignment | description: Text alignment. Defaults to `AUTO`.
|
|
552
|
+
enum:
|
|
553
|
+
AUTO: browser default, eqivalent to `initial`
|
|
554
|
+
CENTER: Center align
|
|
555
|
+
JUSTIFY: Text is spaced to line up its left and right edges to the left and right edges of the line box, except for the last line
|
|
556
|
+
LEFT: Left align
|
|
557
|
+
RIGHT: Right align
|
|
558
|
+
- name: products[].description.nodes[].codeBlockData | type: CodeBlockData | description: Data for a code block node.
|
|
559
|
+
- name: products[].description.nodes[].codeBlockData.textStyle | type: TextStyle | description: Styling for the code block's text.
|
|
560
|
+
- name: products[].description.nodes[].collapsibleListData | type: CollapsibleListData | description: Data for a collapsible list node.
|
|
561
|
+
- name: products[].description.nodes[].collapsibleListData.containerData | type: PluginContainerData | description: Styling for the collapsible list's container.
|
|
562
|
+
- name: products[].description.nodes[].collapsibleListData.direction | type: Direction | description: The direction of the text in the list. Either left-to-right or right-to-left.
|
|
563
|
+
enum:
|
|
564
|
+
LTR: Left-to-right
|
|
565
|
+
RTL: Right-to-left
|
|
566
|
+
- name: products[].description.nodes[].collapsibleListData.expandOnlyOne | type: boolean | description: If `true`, only one item can be expanded at a time. Defaults to `false`.
|
|
567
|
+
- name: products[].description.nodes[].collapsibleListData.initialExpandedItems | type: InitialExpandedItems | description: Sets which items are expanded when the page loads.
|
|
568
|
+
enum:
|
|
569
|
+
ALL: All items will expended initally
|
|
570
|
+
FIRST: First item will be expended initally
|
|
571
|
+
NONE: All items collapsed initally
|
|
572
|
+
- name: products[].description.nodes[].collapsibleListData.isQapageData | type: boolean | description: If `true`, The collapsible item will appear in search results as an FAQ.
|
|
573
|
+
- name: products[].description.nodes[].dividerData | type: DividerData | description: Data for a divider node.
|
|
574
|
+
- name: products[].description.nodes[].dividerData.alignment | type: DividerDataAlignment | description: Divider alignment.
|
|
575
|
+
enum:
|
|
576
|
+
CENTER: Center alignment
|
|
577
|
+
LEFT: Left alignment
|
|
578
|
+
RIGHT: Right alignment
|
|
579
|
+
- name: products[].description.nodes[].dividerData.containerData | type: PluginContainerData | description: Styling for the divider's container.
|
|
580
|
+
- name: products[].description.nodes[].dividerData.lineStyle | type: LineStyle | description: Divider line style.
|
|
581
|
+
enum:
|
|
582
|
+
DASHED: Dashed Line
|
|
583
|
+
DOTTED: Dotted Line
|
|
584
|
+
DOUBLE: Double Line
|
|
585
|
+
SINGLE: Single Line
|
|
586
|
+
- name: products[].description.nodes[].dividerData.width | type: Width | description: Divider width.
|
|
587
|
+
enum:
|
|
588
|
+
LARGE: Large line
|
|
589
|
+
MEDIUM: Medium line
|
|
590
|
+
SMALL: Small line
|
|
591
|
+
- name: products[].description.nodes[].embedData | type: EmbedData | description: Data for an oEmbed node.
|
|
592
|
+
- name: products[].description.nodes[].embedData.containerData | type: PluginContainerData | description: Styling for the oEmbed node's container.
|
|
593
|
+
- name: products[].description.nodes[].embedData.oembed | type: Oembed | description: An [oEmbed](https://www.oembed.com) object.
|
|
594
|
+
- name: products[].description.nodes[].embedData.oembed.authorName | type: string | description: The name of the author or owner of the resource.
|
|
595
|
+
- name: products[].description.nodes[].embedData.oembed.authorUrl | type: string | description: The URL for the author or owner of the resource.
|
|
596
|
+
- name: products[].description.nodes[].embedData.oembed.height | type: number | description: The height of the resource specified in the `url` property in pixels.
|
|
597
|
+
- name: products[].description.nodes[].embedData.oembed.html | type: string | description: HTML for embedding a video player. The HTML should have no padding or margins.
|
|
598
|
+
- name: products[].description.nodes[].embedData.oembed.providerName | type: string | description: The name of the resource provider.
|
|
599
|
+
- name: products[].description.nodes[].embedData.oembed.providerUrl | type: string | description: The URL for the resource provider.
|
|
600
|
+
- name: products[].description.nodes[].embedData.oembed.thumbnailHeight | type: string | description: The height of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailWidth`must also be defined.
|
|
601
|
+
- name: products[].description.nodes[].embedData.oembed.thumbnailUrl | type: string | description: The URL for a thumbnail image for the resource. If this property is defined, `thumbnailWidth` and `thumbnailHeight` must also be defined.
|
|
602
|
+
- name: products[].description.nodes[].embedData.oembed.thumbnailWidth | type: string | description: The width of the resource's thumbnail image. If this property is defined, `thumbnailUrl` and `thumbnailHeight` must also be defined.
|
|
603
|
+
- name: products[].description.nodes[].embedData.oembed.title | type: string | description: Resource title.
|
|
604
|
+
- name: products[].description.nodes[].embedData.oembed.type | type: string | description: The resource type.
|
|
605
|
+
- name: products[].description.nodes[].embedData.oembed.url | type: string | description: The source URL for the resource.
|
|
606
|
+
- name: products[].description.nodes[].embedData.oembed.version | type: string | description: The oEmbed version number. This value must be `1.0`.
|
|
607
|
+
- name: products[].description.nodes[].embedData.oembed.videoUrl | type: string | description: The URL for an embedded viedo.
|
|
608
|
+
- name: products[].description.nodes[].embedData.oembed.width | type: number | description: The width of the resource specified in the `url` property in pixels.
|
|
609
|
+
- name: products[].description.nodes[].embedData.src | type: string | description: Origin asset source.
|
|
610
|
+
- name: products[].description.nodes[].externalData | type: Record<string, any> | description: Data for a custom external node.
|
|
611
|
+
- name: products[].description.nodes[].fileData | type: FileData | description: Data for a file node.
|
|
612
|
+
- name: products[].description.nodes[].fileData.containerData | type: PluginContainerData | description: Styling for the file's container.
|
|
613
|
+
- name: products[].description.nodes[].fileData.mimeType | type: string | description: File MIME type.
|
|
614
|
+
- name: products[].description.nodes[].fileData.name | type: string | description: File name.
|
|
615
|
+
- name: products[].description.nodes[].fileData.path | type: string | description: File path.
|
|
616
|
+
- name: products[].description.nodes[].fileData.pdfSettings | type: PDFSettings | description: Settings for PDF files.
|
|
617
|
+
- name: products[].description.nodes[].fileData.pdfSettings.disableDownload | type: boolean | description: Sets whether the PDF download button is disabled. Defaults to `false`.
|
|
618
|
+
- name: products[].description.nodes[].fileData.pdfSettings.disablePrint | type: boolean | description: Sets whether the PDF print button is disabled. Defaults to `false`.
|
|
619
|
+
- name: products[].description.nodes[].fileData.pdfSettings.viewMode | type: ViewMode | description: PDF view mode. One of the following: `NONE` : The PDF isn't displayed. `FULL` : A full page view of the PDF is displayed. `MINI` : A mini view of the PDF is displayed.
|
|
620
|
+
enum:
|
|
621
|
+
FULL: Full PDF view
|
|
622
|
+
MINI: Mini PDF view
|
|
623
|
+
NONE: No PDF view
|
|
624
|
+
- name: products[].description.nodes[].fileData.sizeInKb | type: string | description: File size in KB.
|
|
625
|
+
- name: products[].description.nodes[].fileData.src | type: FileSource | description: The source for the file's data.
|
|
626
|
+
- name: products[].description.nodes[].fileData.type | type: string | description: File type.
|
|
627
|
+
- name: products[].description.nodes[].galleryData | type: GalleryData | description: Data for a gallery node.
|
|
628
|
+
- name: products[].description.nodes[].galleryData.containerData | type: PluginContainerData | description: Styling for the gallery's container.
|
|
629
|
+
- name: products[].description.nodes[].galleryData.disableDownload | type: boolean | description: Sets whether the gallery's download button is disabled. Defaults to `false`.
|
|
630
|
+
- name: products[].description.nodes[].galleryData.disableExpand | type: boolean | description: Sets whether the gallery's expand button is disabled. Defaults to `false`.
|
|
631
|
+
- name: products[].description.nodes[].galleryData.items | type: Array<Item> | description: The items in the gallery.
|
|
632
|
+
- name: products[].description.nodes[].galleryData.items[].altText | type: string | description: Item's alternative text.
|
|
633
|
+
- name: products[].description.nodes[].galleryData.items[].title | type: string | description: Item title.
|
|
634
|
+
- ONE-OF:
|
|
635
|
+
- name: products[].description.nodes[].galleryData.items[].image | type: Image | description: An image item.
|
|
636
|
+
- name: products[].description.nodes[].galleryData.items[].image.link | type: Link | description: Link details for images that are links.
|
|
637
|
+
- name: products[].description.nodes[].galleryData.items[].image.media | type: V1Media | description: Image file details.
|
|
638
|
+
- name: products[].description.nodes[].galleryData.items[].video | type: Video | description: A video item.
|
|
639
|
+
- name: products[].description.nodes[].galleryData.items[].video.media | type: V1Media | description: Video file details.
|
|
640
|
+
- name: products[].description.nodes[].galleryData.items[].video.thumbnail | type: V1Media | description: Video thumbnail file details.
|
|
641
|
+
- name: products[].description.nodes[].galleryData.options | type: GalleryOptions | description: Options for defining the gallery's appearance.
|
|
642
|
+
- name: products[].description.nodes[].galleryData.options.item | type: ItemStyle | description: Styling for gallery items.
|
|
643
|
+
- name: products[].description.nodes[].galleryData.options.item.crop | type: Crop | description: Sets how item images are cropped.
|
|
644
|
+
enum:
|
|
645
|
+
FILL: Crop to fill
|
|
646
|
+
FIT: Crop to fit
|
|
647
|
+
- name: products[].description.nodes[].galleryData.options.item.ratio | type: number | description: Item ratio
|
|
648
|
+
- name: products[].description.nodes[].galleryData.options.item.spacing | type: number | description: The spacing between items in pixels.
|
|
649
|
+
- name: products[].description.nodes[].galleryData.options.item.targetSize | type: number | description: Desirable dimension for each item in pixels (behvaior changes according to gallery type)
|
|
650
|
+
- name: products[].description.nodes[].galleryData.options.layout | type: GalleryOptionsLayout | description: Gallery layout.
|
|
651
|
+
- name: products[].description.nodes[].galleryData.options.layout.horizontalScroll | type: boolean | description: Sets whether horizontal scroll is enabled. Defaults to `true` unless the layout `type` is set to `GRID` or `COLLAGE`.
|
|
652
|
+
- name: products[].description.nodes[].galleryData.options.layout.mobileNumberOfColumns | type: number | description: The number of columns to display on mobile screens.
|
|
653
|
+
- name: products[].description.nodes[].galleryData.options.layout.numberOfColumns | type: number | description: The number of columns to display on full size screens.
|
|
654
|
+
- name: products[].description.nodes[].galleryData.options.layout.orientation | type: Orientation | description: Gallery orientation.
|
|
655
|
+
enum:
|
|
656
|
+
COLUMNS: Columns Orientation
|
|
657
|
+
ROWS: Rows Orientation
|
|
658
|
+
- name: products[].description.nodes[].galleryData.options.layout.type | type: LayoutType | description: Gallery layout type.
|
|
659
|
+
enum:
|
|
660
|
+
COLLAGE: Collage type
|
|
661
|
+
COLUMN: Column type
|
|
662
|
+
FULLSIZE: Fullsize images type
|
|
663
|
+
GRID: Grid type
|
|
664
|
+
MAGIC: Magic type
|
|
665
|
+
MASONRY: Masonry type
|
|
666
|
+
PANORAMA: Panorama type
|
|
667
|
+
SLIDER: Slider type
|
|
668
|
+
SLIDESHOW: Slideshow type
|
|
669
|
+
THUMBNAIL: Thumbnail type
|
|
670
|
+
- name: products[].description.nodes[].galleryData.options.thumbnails | type: Thumbnails | description: Styling for gallery thumbnail images.
|
|
671
|
+
- name: products[].description.nodes[].galleryData.options.thumbnails.placement | type: ThumbnailsAlignment | description: Thumbnail alignment.
|
|
672
|
+
enum:
|
|
673
|
+
BOTTOM: Bottom alignment
|
|
674
|
+
LEFT: Left alignment
|
|
675
|
+
NONE: No thumbnail
|
|
676
|
+
RIGHT: Right alignment
|
|
677
|
+
TOP: Top alignment
|
|
678
|
+
- name: products[].description.nodes[].galleryData.options.thumbnails.spacing | type: number | description: Spacing between thumbnails in pixels.
|
|
679
|
+
- name: products[].description.nodes[].gifData | type: GIFData | description: Data for a GIF node.
|
|
680
|
+
- name: products[].description.nodes[].gifData.containerData | type: PluginContainerData | description: Styling for the GIF's container.
|
|
681
|
+
- name: products[].description.nodes[].gifData.downsized | type: GIF | description: The source of the downsized GIF.
|
|
682
|
+
- name: products[].description.nodes[].gifData.downsized.gif | type: string | description: GIF format URL.
|
|
683
|
+
- name: products[].description.nodes[].gifData.downsized.mp4 | type: string | description: MP4 format URL.
|
|
684
|
+
- name: products[].description.nodes[].gifData.downsized.still | type: string | description: Thumbnail URL.
|
|
685
|
+
- name: products[].description.nodes[].gifData.gifType | type: GIFType | description: Type of GIF (Sticker or NORMAL). Defaults to `NORMAL`.
|
|
686
|
+
enum: NORMAL, STICKER
|
|
687
|
+
- name: products[].description.nodes[].gifData.height | type: number | description: Height in pixels.
|
|
688
|
+
- name: products[].description.nodes[].gifData.original | type: GIF | description: The source of the full size GIF.
|
|
689
|
+
- name: products[].description.nodes[].gifData.width | type: number | description: Width in pixels.
|
|
690
|
+
- name: products[].description.nodes[].headingData | type: HeadingData | description: Data for a heading node.
|
|
691
|
+
- name: products[].description.nodes[].headingData.indentation | type: number | description: Indentation level from 1-4.
|
|
692
|
+
- name: products[].description.nodes[].headingData.level | type: number | description: Heading level from 1-6.
|
|
693
|
+
- name: products[].description.nodes[].headingData.textStyle | type: TextStyle | description: Styling for the heading text.
|
|
694
|
+
- name: products[].description.nodes[].htmlData | type: HTMLData | description: Data for an embedded HTML node.
|
|
695
|
+
- name: products[].description.nodes[].htmlData.autoHeight | type: boolean | description: If container height is aligned with its content height. Defaults to `true`.
|
|
696
|
+
- name: products[].description.nodes[].htmlData.containerData | type: PluginContainerData | description: Styling for the HTML node's container. Height property is irrelevant for HTML embeds when autoHeight is set to `true`.
|
|
697
|
+
- name: products[].description.nodes[].htmlData.source | type: Source | description: The type of HTML code.
|
|
698
|
+
enum: ADSENSE, AI, HTML
|
|
699
|
+
- ONE-OF:
|
|
700
|
+
- name: products[].description.nodes[].htmlData.html | type: string | description: The HTML code for the node.
|
|
701
|
+
- name: products[].description.nodes[].htmlData.isAdsense | type: boolean | description: Whether this is an AdSense element. Use `source` instead.
|
|
702
|
+
- name: products[].description.nodes[].htmlData.url | type: string | description: The URL for the HTML code for the node.
|
|
703
|
+
- name: products[].description.nodes[].imageData | type: ImageData | description: Data for an image node.
|
|
704
|
+
- name: products[].description.nodes[].imageData.altText | type: string | description: Image's alternative text.
|
|
705
|
+
- name: products[].description.nodes[].imageData.containerData | type: PluginContainerData | description: Styling for the image's container.
|
|
706
|
+
- name: products[].description.nodes[].imageData.decorative | type: boolean | description: Sets whether the image is decorative and does not need an explanation. Defaults to `false`.
|
|
707
|
+
- name: products[].description.nodes[].imageData.disableDownload | type: boolean | description: Sets whether the image's download button is disabled. Defaults to `false`.
|
|
708
|
+
- name: products[].description.nodes[].imageData.disableExpand | type: boolean | description: Sets whether the image expands to full screen when clicked. Defaults to `false`.
|
|
709
|
+
- name: products[].description.nodes[].imageData.image | type: V1Media | description: Image file details.
|
|
710
|
+
- name: products[].description.nodes[].imageData.link | type: Link | description: Link details for images that are links.
|
|
711
|
+
- name: products[].description.nodes[].imageData.styles | type: ImageDataStyles | description: Styling for the image.
|
|
712
|
+
- name: products[].description.nodes[].imageData.styles.border | type: StylesBorder | description: Border attributes.
|
|
713
|
+
- name: products[].description.nodes[].imageData.styles.border.color | type: string | description: Border color as a hexadecimal value.
|
|
714
|
+
- name: products[].description.nodes[].imageData.styles.border.radius | type: number | description: Border radius in pixels.
|
|
715
|
+
- name: products[].description.nodes[].imageData.styles.border.width | type: number | description: Border width in pixels.
|
|
716
|
+
- name: products[].description.nodes[].layoutCellData | type: LayoutCellData | description: Data for a cell node.
|
|
717
|
+
- name: products[].description.nodes[].layoutCellData.colSpan | type: number | description: Size of the cell in 12 columns grid.
|
|
718
|
+
- name: products[].description.nodes[].layoutData | type: LayoutData | description: Data for a layout node. Reserved for future use.
|
|
719
|
+
- name: products[].description.nodes[].layoutData.backdropColor | type: string | description: Backdrop color as a hexadecimal value.
|
|
720
|
+
- name: products[].description.nodes[].layoutData.backdropImage | type: BackgroundImage | description: Backdrop image.radius in pixels.
|
|
721
|
+
- name: products[].description.nodes[].layoutData.backdropImage.media | type: V1Media | description: Background image.
|
|
722
|
+
- name: products[].description.nodes[].layoutData.backdropImage.opacity | type: number | description: Background image opacity.
|
|
723
|
+
- name: products[].description.nodes[].layoutData.backdropImage.position | type: ImagePosition | description: Position of background. Defaults to `CENTER`.
|
|
724
|
+
enum:
|
|
725
|
+
BOTTOM: Image positioned at the center bottom
|
|
726
|
+
BOTTOM_LEFT: Image positioned at the bottom left
|
|
727
|
+
BOTTOM_RIGHT: Image positioned at the bottom right
|
|
728
|
+
CENTER: Image positioned at the center
|
|
729
|
+
CENTER_LEFT: Image positioned on the left
|
|
730
|
+
CENTER_RIGHT: Image positioned on the right
|
|
731
|
+
TOP: Image positioned at the center top
|
|
732
|
+
TOP_LEFT: Image positioned at the top left
|
|
733
|
+
TOP_RIGHT: Image positioned at the top right
|
|
734
|
+
- name: products[].description.nodes[].layoutData.backdropImage.scaling | type: Scaling | description: Background image scaling.
|
|
735
|
+
enum:
|
|
736
|
+
AUTO: Auto image scaling
|
|
737
|
+
CONTAIN: Contain image scaling
|
|
738
|
+
COVER: Cover image scaling
|
|
739
|
+
- name: products[].description.nodes[].layoutData.backdropPaddingBottom | type: number | description: Backdrop bottom padding
|
|
740
|
+
- name: products[].description.nodes[].layoutData.backdropPaddingTop | type: number | description: Backdrop top padding.
|
|
741
|
+
- name: products[].description.nodes[].layoutData.backgroundColor | type: string | description: Background color as a hexadecimal value.
|
|
742
|
+
- name: products[].description.nodes[].layoutData.backgroundImage | type: BackgroundImage | description: Background image.
|
|
743
|
+
- name: products[].description.nodes[].layoutData.borderColor | type: string | description: Border color as a hexadecimal value.
|
|
744
|
+
- name: products[].description.nodes[].layoutData.borderRadius | type: number | description: Border
|
|
745
|
+
- name: products[].description.nodes[].layoutData.borderWidth | type: number | description: Border width in pixels.
|
|
746
|
+
- name: products[].description.nodes[].layoutData.cellPadding | type: Array<number> | description: Padding in pixels for cells. Follows CSS order: top, right, bottom, left
|
|
747
|
+
- name: products[].description.nodes[].layoutData.cellVerticalAlignment | type: VerticalAlignmentAlignment | description: Vertical alignment for the cell's items.
|
|
748
|
+
enum:
|
|
749
|
+
BOTTOM: Bottom alignment
|
|
750
|
+
MIDDLE: Middle alignment
|
|
751
|
+
TOP: Top alignment
|
|
752
|
+
- name: products[].description.nodes[].layoutData.containerData | type: PluginContainerData | description: Styling for the layout's container.
|
|
753
|
+
- name: products[].description.nodes[].layoutData.gap | type: number | description: Horizontal and vertical gap between columns
|
|
754
|
+
- name: products[].description.nodes[].layoutData.responsivenessBehaviour | type: ResponsivenessBehaviour | description: Responsiveness behaviour of columns when responsiveness applies. Either stacks or wrappers.
|
|
755
|
+
enum:
|
|
756
|
+
STACK: Stacking of columns
|
|
757
|
+
WRAP: Wrapping of columns
|
|
758
|
+
- name: products[].description.nodes[].layoutData.responsivenessBreakpoint | type: number | description: Size in pixels when responsiveness_behaviour applies
|
|
759
|
+
- name: products[].description.nodes[].linkPreviewData | type: LinkPreviewData | description: Data for a link preview node.
|
|
760
|
+
- name: products[].description.nodes[].linkPreviewData.containerData | type: PluginContainerData | description: Styling for the link preview's container.
|
|
761
|
+
- name: products[].description.nodes[].linkPreviewData.description | type: string | description: Preview description.
|
|
762
|
+
- name: products[].description.nodes[].linkPreviewData.html | type: string | description: The preview content as HTML.
|
|
763
|
+
- name: products[].description.nodes[].linkPreviewData.link | type: Link | description: Link details.
|
|
764
|
+
- name: products[].description.nodes[].linkPreviewData.styles | type: LinkPreviewDataStyles | description: Styling for the link preview.
|
|
765
|
+
- name: products[].description.nodes[].linkPreviewData.styles.backgroundColor | type: string | description: Background color as a hexadecimal value.
|
|
766
|
+
- name: products[].description.nodes[].linkPreviewData.styles.borderColor | type: string | description: Border color as a hexadecimal value.
|
|
767
|
+
- name: products[].description.nodes[].linkPreviewData.styles.borderRadius | type: number | description: Border radius in pixels.
|
|
768
|
+
- name: products[].description.nodes[].linkPreviewData.styles.borderWidth | type: number | description: Border width in pixels.
|
|
769
|
+
- name: products[].description.nodes[].linkPreviewData.styles.linkColor | type: string | description: Link color as a hexadecimal value.
|
|
770
|
+
- name: products[].description.nodes[].linkPreviewData.styles.subtitleColor | type: string | description: Subtitle color as a hexadecimal value.
|
|
771
|
+
- name: products[].description.nodes[].linkPreviewData.styles.thumbnailPosition | type: StylesPosition | description: Position of thumbnail. Defaults to `START`.
|
|
772
|
+
enum:
|
|
773
|
+
END: Thumbnail positioned at the end (right in LTR layouts, left in RTL layouts)
|
|
774
|
+
HIDDEN: Thumbnail hidden and not displayed
|
|
775
|
+
START: Thumbnail positioned at the start (left in LTR layouts, right in RTL layouts)
|
|
776
|
+
TOP: Thumbnail positioned at the top
|
|
777
|
+
- name: products[].description.nodes[].linkPreviewData.styles.titleColor | type: string | description: Title color as a hexadecimal value.
|
|
778
|
+
- name: products[].description.nodes[].linkPreviewData.thumbnailUrl | type: string | description: Preview thumbnail URL.
|
|
779
|
+
- name: products[].description.nodes[].linkPreviewData.title | type: string | description: Preview title.
|
|
780
|
+
- name: products[].description.nodes[].mapData | type: MapData | description: none
|
|
781
|
+
- name: products[].description.nodes[].mapData.containerData | type: PluginContainerData | description: Styling for the map's container.
|
|
782
|
+
- name: products[].description.nodes[].mapData.mapSettings | type: MapSettings | description: Map settings.
|
|
783
|
+
- name: products[].description.nodes[].mapData.mapSettings.address | type: string | description: The address to display on the map.
|
|
784
|
+
- name: products[].description.nodes[].mapData.mapSettings.draggable | type: boolean | description: Sets whether the map is draggable.
|
|
785
|
+
- name: products[].description.nodes[].mapData.mapSettings.initialZoom | type: number | description: Initial zoom value.
|
|
786
|
+
- name: products[].description.nodes[].mapData.mapSettings.lat | type: number | description: Location latitude.
|
|
787
|
+
- name: products[].description.nodes[].mapData.mapSettings.lng | type: number | description: Location longitude.
|
|
788
|
+
- name: products[].description.nodes[].mapData.mapSettings.locationName | type: string | description: Location name.
|
|
789
|
+
- name: products[].description.nodes[].mapData.mapSettings.mapType | type: MapType | description: Map type. `HYBRID` is a combination of the `ROADMAP` and `SATELLITE` map types.
|
|
790
|
+
enum:
|
|
791
|
+
HYBRID: Hybrid map type
|
|
792
|
+
ROADMAP: Roadmap map type
|
|
793
|
+
SATELITE: Satellite map type
|
|
794
|
+
TERRAIN: Terrain map type
|
|
795
|
+
- name: products[].description.nodes[].mapData.mapSettings.marker | type: boolean | description: Sets whether the location marker is visible.
|
|
796
|
+
- name: products[].description.nodes[].mapData.mapSettings.streetViewControl | type: boolean | description: Sets whether street view control is enabled.
|
|
797
|
+
- name: products[].description.nodes[].mapData.mapSettings.viewModeControl | type: boolean | description: Sets whether view mode control is enabled.
|
|
798
|
+
- name: products[].description.nodes[].mapData.mapSettings.zoomControl | type: boolean | description: Sets whether zoom control is enabled.
|
|
799
|
+
- name: products[].description.nodes[].orderedListData | type: OrderedListData | description: Data for an ordered list node.
|
|
800
|
+
- name: products[].description.nodes[].orderedListData.indentation | type: number | description: Indentation level from 0-4.
|
|
801
|
+
- name: products[].description.nodes[].orderedListData.offset | type: number | description: Offset level from 0-4.
|
|
802
|
+
- name: products[].description.nodes[].orderedListData.start | type: number | description: List start number.
|
|
803
|
+
- name: products[].description.nodes[].paragraphData | type: ParagraphData | description: Data for a paragraph node.
|
|
804
|
+
- name: products[].description.nodes[].paragraphData.indentation | type: number | description: Indentation level from 1-4.
|
|
805
|
+
- name: products[].description.nodes[].paragraphData.level | type: number | description: Paragraph level
|
|
806
|
+
- name: products[].description.nodes[].paragraphData.textStyle | type: TextStyle | description: Styling for the paragraph text.
|
|
807
|
+
- name: products[].description.nodes[].pollData | type: PollData | description: Data for a poll node.
|
|
808
|
+
- name: products[].description.nodes[].pollData.containerData | type: PluginContainerData | description: Styling for the poll's container.
|
|
809
|
+
- name: products[].description.nodes[].pollData.design | type: Design | description: Styling for the poll and voting options.
|
|
810
|
+
- name: products[].description.nodes[].pollData.design.options | type: OptionDesign | description: Styling for voting options.
|
|
811
|
+
- name: products[].description.nodes[].pollData.design.options.borderRadius | type: number | description: Border radius in pixels.
|
|
812
|
+
- name: products[].description.nodes[].pollData.design.poll | type: PollDesign | description: Styling for the poll.
|
|
813
|
+
- name: products[].description.nodes[].pollData.design.poll.background | type: Background | description: Background styling.
|
|
814
|
+
- name: products[].description.nodes[].pollData.design.poll.background.type | type: BackgroundType | description: Background type. For each option, include the relevant details.
|
|
815
|
+
enum:
|
|
816
|
+
COLOR: Color background type
|
|
817
|
+
GRADIENT: Gradiant background type
|
|
818
|
+
IMAGE: Image background type
|
|
819
|
+
- ONE-OF:
|
|
820
|
+
- name: products[].description.nodes[].pollData.design.poll.background.color | type: string | description: The background color as a hexademical value.
|
|
821
|
+
- name: products[].description.nodes[].pollData.design.poll.background.gradient | type: Gradient | description: Details for a gradient background.
|
|
822
|
+
- name: products[].description.nodes[].pollData.design.poll.background.gradient.angle | type: number | description: The gradient angle in degrees.
|
|
823
|
+
- name: products[].description.nodes[].pollData.design.poll.background.gradient.lastColor | type: string | description: The end color as a hexademical value.
|
|
824
|
+
- name: products[].description.nodes[].pollData.design.poll.background.gradient.startColor | type: string | description: The start color as a hexademical value.
|
|
825
|
+
- name: products[].description.nodes[].pollData.design.poll.background.image | type: V1Media | description: An image to use for the background.
|
|
826
|
+
- name: products[].description.nodes[].pollData.design.poll.borderRadius | type: number | description: Border radius in pixels.
|
|
827
|
+
- name: products[].description.nodes[].pollData.layout | type: PollDataLayout | description: Layout settings for the poll and voting options.
|
|
828
|
+
- name: products[].description.nodes[].pollData.layout.options | type: OptionLayout | description: Voting otpions layout settings.
|
|
829
|
+
- name: products[].description.nodes[].pollData.layout.options.enableImage | type: boolean | description: Sets whether to display option images. Defaults to `false`.
|
|
830
|
+
- name: products[].description.nodes[].pollData.layout.poll | type: PollLayout | description: Poll layout settings.
|
|
831
|
+
- name: products[].description.nodes[].pollData.layout.poll.direction | type: PollLayoutDirection | description: The direction of the text displayed in the voting options. Text can be displayed either right-to-left or left-to-right.
|
|
832
|
+
enum:
|
|
833
|
+
LTR: Left-to-right
|
|
834
|
+
RTL: Right-to-left
|
|
835
|
+
- name: products[].description.nodes[].pollData.layout.poll.enableImage | type: boolean | description: Sets whether to display the main poll image. Defaults to `false`.
|
|
836
|
+
- name: products[].description.nodes[].pollData.layout.poll.type | type: PollLayoutType | description: The layout for displaying the voting options.
|
|
837
|
+
enum:
|
|
838
|
+
GRID: Grid
|
|
839
|
+
LIST: List
|
|
840
|
+
- name: products[].description.nodes[].pollData.poll | type: Poll | description: Poll data.
|
|
841
|
+
- name: products[].description.nodes[].pollData.poll.creatorId | type: string | description: Poll creator GUID.
|
|
842
|
+
- name: products[].description.nodes[].pollData.poll.id | type: string | description: Poll GUID.
|
|
843
|
+
- name: products[].description.nodes[].pollData.poll.image | type: V1Media | description: Main poll image.
|
|
844
|
+
- name: products[].description.nodes[].pollData.poll.options | type: Array<Option> | description: Voting options.
|
|
845
|
+
- name: products[].description.nodes[].pollData.poll.options[].id | type: string | description: Option GUID.
|
|
846
|
+
- name: products[].description.nodes[].pollData.poll.options[].image | type: V1Media | description: The image displayed with the option.
|
|
847
|
+
- name: products[].description.nodes[].pollData.poll.options[].title | type: string | description: Option title.
|
|
848
|
+
- name: products[].description.nodes[].pollData.poll.settings | type: PollSettings | description: The poll's permissions and display settings.
|
|
849
|
+
- name: products[].description.nodes[].pollData.poll.settings.permissions | type: Permissions | description: Permissions settings for voting.
|
|
850
|
+
- name: products[].description.nodes[].pollData.poll.settings.permissions.allowMultipleVotes | type: boolean | description: Sets whether one voter can vote multiple times. Defaults to `false`.
|
|
851
|
+
- name: products[].description.nodes[].pollData.poll.settings.permissions.view | type: ViewRole | description: Sets who can view the poll results.
|
|
852
|
+
enum:
|
|
853
|
+
CREATOR: Only Poll creator can view the results
|
|
854
|
+
EVERYONE: Anyone can see the results, even if one didn't vote
|
|
855
|
+
VOTERS: Anyone who voted can see the results
|
|
856
|
+
- name: products[].description.nodes[].pollData.poll.settings.permissions.vote | type: VoteRole | description: Sets who can vote.
|
|
857
|
+
enum:
|
|
858
|
+
ALL: Anyone
|
|
859
|
+
SITE_MEMBERS: Logged in member
|
|
860
|
+
- name: products[].description.nodes[].pollData.poll.settings.showVoters | type: boolean | description: Sets whether voters are displayed in the vote results. Defaults to `true`.
|
|
861
|
+
- name: products[].description.nodes[].pollData.poll.settings.showVotesCount | type: boolean | description: Sets whether the vote count is displayed. Defaults to `true`.
|
|
862
|
+
- name: products[].description.nodes[].pollData.poll.title | type: string | description: Poll title.
|
|
863
|
+
- name: products[].description.nodes[].tableCellData | type: TableCellData | description: Data for a table cell node.
|
|
864
|
+
- name: products[].description.nodes[].tableCellData.borderColors | type: BorderColors | description: The cell's border colors.
|
|
865
|
+
- name: products[].description.nodes[].tableCellData.borderColors.bottom | type: string | description: Bottom border color as a hexadecimal value.
|
|
866
|
+
- name: products[].description.nodes[].tableCellData.borderColors.left | type: string | description: Left border color as a hexadecimal value.
|
|
867
|
+
- name: products[].description.nodes[].tableCellData.borderColors.right | type: string | description: Right border color as a hexadecimal value.
|
|
868
|
+
- name: products[].description.nodes[].tableCellData.borderColors.top | type: string | description: Top border color as a hexadecimal value.
|
|
869
|
+
- name: products[].description.nodes[].tableCellData.borderWidths | type: BorderWidths | description: The cell's border widths.
|
|
870
|
+
- name: products[].description.nodes[].tableCellData.borderWidths.bottom | type: number | description: Bottom border width in pixels.
|
|
871
|
+
- name: products[].description.nodes[].tableCellData.borderWidths.left | type: number | description: Left border width in pixels.
|
|
872
|
+
- name: products[].description.nodes[].tableCellData.borderWidths.right | type: number | description: Right border width in pixels.
|
|
873
|
+
- name: products[].description.nodes[].tableCellData.borderWidths.top | type: number | description: Top border width in pixels.
|
|
874
|
+
- name: products[].description.nodes[].tableCellData.cellStyle | type: CellStyle | description: Styling for the cell's background color and text alignment.
|
|
875
|
+
- name: products[].description.nodes[].tableCellData.cellStyle.backgroundColor | type: string | description: Cell background color as a hexadecimal value.
|
|
876
|
+
- name: products[].description.nodes[].tableCellData.cellStyle.verticalAlignment | type: VerticalAlignment | description: Vertical alignment for the cell's text.
|
|
877
|
+
enum:
|
|
878
|
+
BOTTOM: Bottom alignment
|
|
879
|
+
MIDDLE: Middle alignment
|
|
880
|
+
TOP: Top alignment
|
|
881
|
+
- name: products[].description.nodes[].tableCellData.colspan | type: number | description: Defines how many columns the cell spans. Default: 1.
|
|
882
|
+
- name: products[].description.nodes[].tableCellData.rowspan | type: number | description: Defines how many rows the cell spans. Default: 1.
|
|
883
|
+
- name: products[].description.nodes[].tableData | type: TableData | description: Data for a table node.
|
|
884
|
+
- name: products[].description.nodes[].tableData.cellPadding | type: Array<number> | description: Padding in pixels for cells. Follows CSS order: top, right, bottom, left.
|
|
885
|
+
- name: products[].description.nodes[].tableData.cellSpacing | type: number | description: The spacing between cells in pixels. Defaults to `0`.
|
|
886
|
+
- name: products[].description.nodes[].tableData.columnHeader | type: boolean | description: Sets whether the table's first column is a header. Defaults to `false`.
|
|
887
|
+
- name: products[].description.nodes[].tableData.containerData | type: PluginContainerData | description: Styling for the table's container.
|
|
888
|
+
- name: products[].description.nodes[].tableData.dimensions | type: Dimensions | description: The table's dimensions.
|
|
889
|
+
- name: products[].description.nodes[].tableData.dimensions.colsMinWidth | type: Array<number> | description: An array representing the minimum width of each column in pixels.
|
|
890
|
+
- name: products[].description.nodes[].tableData.dimensions.colsWidthRatio | type: Array<number> | description: An array representing relative width of each column in relation to the other columns.
|
|
891
|
+
- name: products[].description.nodes[].tableData.dimensions.rowsHeight | type: Array<number> | description: An array representing the height of each row in pixels.
|
|
892
|
+
- name: products[].description.nodes[].tableData.rowHeader | type: boolean | description: Sets whether the table's first row is a header. Defaults to `false`.
|
|
893
|
+
- name: products[].description.nodes[].textData | type: TextData | description: Data for a text node. Used to apply decorations to text.
|
|
894
|
+
- name: products[].description.nodes[].textData.decorations | type: Array<Decoration> | description: The decorations to apply.
|
|
895
|
+
- name: products[].description.nodes[].textData.text | type: string | description: The text to apply decorations to.
|
|
896
|
+
- name: products[].description.nodes[].videoData | type: VideoData | description: Data for a video node.
|
|
897
|
+
- name: products[].description.nodes[].videoData.containerData | type: PluginContainerData | description: Styling for the video's container.
|
|
898
|
+
- name: products[].description.nodes[].videoData.disableDownload | type: boolean | description: Sets whether the video's download button is disabled. Defaults to `false`.
|
|
899
|
+
- name: products[].description.nodes[].videoData.options | type: PlaybackOptions | description: Video options.
|
|
900
|
+
- name: products[].description.nodes[].videoData.options.autoPlay | type: boolean | description: Sets whether the media will automatically start playing.
|
|
901
|
+
- name: products[].description.nodes[].videoData.options.playInLoop | type: boolean | description: Sets whether media's will be looped.
|
|
902
|
+
- name: products[].description.nodes[].videoData.options.showControls | type: boolean | description: Sets whether media's controls will be shown.
|
|
903
|
+
- name: products[].description.nodes[].videoData.thumbnail | type: V1Media | description: Video thumbnail details.
|
|
904
|
+
- name: products[].description.nodes[].videoData.title | type: string | description: Video title.
|
|
905
|
+
- name: products[].description.nodes[].videoData.video | type: V1Media | description: Video details.
|
|
906
|
+
- name: products[].directCategoriesInfo | type: ProductCategoriesInfo | description: List of categories that directly contain this product. Updated automatically when a product is added/removed from a category, when an item is moved within a category, or when a category is deleted. > **Note:** Returned only when you pass `"DIRECT_CATEGORIES_INFO"` to the `fields` array in Products API requests.
|
|
907
|
+
- name: products[].extendedFields | type: ExtendedFields | description: Custom extended fields for the product object. [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
908
|
+
- name: products[].extendedFields.namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
909
|
+
- name: products[].handle | type: string | description: A unique human-friendly identifier for the product. Unlike the product GUID, the handle can be set by the user to ensure consistency across multiple platforms. In case handle wasn't given, the handle will be automatically generated.
|
|
910
|
+
- name: products[].infoSections | type: Array<InfoSection> | description: Product info section. + Pass `infoSection.uniqueName`, `infoSection.title`, and `infoSection.description` to add a new info section while creating a product. + Pass an existing info section's `id` or `uniqueName` to assign that info section to the product.
|
|
911
|
+
- name: products[].infoSections[]._id | type: string | description: Info section GUID.
|
|
912
|
+
- name: products[].infoSections[].description | type: RichContent | description: Info section description using rich content. > **Note:** Returned only when you pass `"INFO_SECTION_DESCRIPTION"` to the `fields` array in Products API requests. <widget src="https://apps.wix.com/_serverless/ricos-playground-services/goto/api-component" plugins="indent.emoji.divider.codeBlock.file.gallery.giphy.image.table.link.textHighlight.textColor" exampleid="7dc9240e-d548-417a-abcf-0291b68b4303"> <a href="https://dev.wix.com/docs/ricos/api-reference/ricos-document">See Ricos document reference</a> </widget>
|
|
913
|
+
- name: products[].infoSections[].plainDescription | type: string | description: Info section description in HTML. When provided on create/update, this string must be a valid HTML. It will then be converted to rich content. `plainDescription` is ignored when value is also passed to the `description` field. > **Note:** Returned only when you pass `"INFO_SECTION_PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
|
|
914
|
+
- name: products[].infoSections[].title | type: string | description: Info section title. > **Note:** Returned only when you pass `"INFO_SECTION"` to the `fields` array in Products API requests.
|
|
915
|
+
- name: products[].infoSections[].uniqueName | type: string | description: Info section unique name. > **Note:** Returned only when you pass `"INFO_SECTION"` to the `fields` array in Products API requests.
|
|
916
|
+
- name: products[].inventory | type: Inventory | description: Product inventory info.
|
|
917
|
+
- name: products[].inventory.availabilityStatus | type: InventoryAvailabilityStatus | description: Current availability status.
|
|
918
|
+
enum:
|
|
919
|
+
IN_STOCK: All variants are in stock and available for purchase.
|
|
920
|
+
OUT_OF_STOCK: All variants are out of stock.
|
|
921
|
+
PARTIALLY_OUT_OF_STOCK: Some variants are out of stock and some are in stock and available for purchase.
|
|
922
|
+
UNKNOWN_AVAILABILITY_STATUS
|
|
923
|
+
- name: products[].inventory.preorderAvailability | type: ProductPreorderAvailability | description: Preorder availability status.
|
|
924
|
+
enum:
|
|
925
|
+
ALL_VARIANTS: All the product variants are available for preorder.
|
|
926
|
+
NO_VARIANTS: None of the product variants are available for preorder.
|
|
927
|
+
SOME_VARIANTS: Some of the product variants are available for preorder.
|
|
928
|
+
UNKNOWN_PREORDER_AVAILABILITY_STATUS
|
|
929
|
+
- name: products[].inventory.preorderStatus | type: PreorderStatus | description: Current preorder status.
|
|
930
|
+
enum:
|
|
931
|
+
DISABLED: All variants are disabled for preorder.
|
|
932
|
+
ENABLED: All variants are enabled for preorder.
|
|
933
|
+
PARTIALLY_ENABLED: Some variants are disabled and some are enabled for preorder.
|
|
934
|
+
UNKNOWN_PREORDER_STATUS
|
|
935
|
+
- name: products[].mainCategoryId | type: string | description: The GUID of the product's primary direct category, which defines the product’s breadcrumbs path. For example, if the product's main category is "T-Shirts" (which is a subcategory of "Clothing"), the breadcrumbs path will be "Clothing > T-Shirts".
|
|
936
|
+
- name: products[].media | type: Media | description: Product media items.
|
|
937
|
+
- name: products[].media.itemsInfo | type: MediaItemsInfo | description: All media items. > **Note:** Returned only when you pass `"MEDIA_ITEMS_INFO"` to the `fields` array in Products API requests.
|
|
938
|
+
- name: products[].media.itemsInfo.items | type: Array<ProductMedia> | description: All media items (images, videos etc) associated with this product.
|
|
939
|
+
- name: products[].media.itemsInfo.items[].altText | type: string | description: Image alt text.
|
|
940
|
+
- name: products[].media.itemsInfo.items[].displayName | type: string | description: Media display name. Allows to override the default media name. Can be passed only when `setBy: url`.
|
|
941
|
+
- name: products[].media.itemsInfo.items[].mediaType | type: MediaType | description: Media type.
|
|
942
|
+
enum:
|
|
943
|
+
IMAGE: Image media type.
|
|
944
|
+
UNKNOWN_MEDIA_TYPE, VIDEO: Video media type.
|
|
945
|
+
- name: products[].media.itemsInfo.items[].thumbnail | type: Thumbnail | description: Media thumbnail. > **Note:** Returned only when you pass `"THUMBNAIL"` to the `fields` array in Products API requests.
|
|
946
|
+
- name: products[].media.itemsInfo.items[].thumbnail.altText | type: string | description: Thumbnail alt text.
|
|
947
|
+
- name: products[].media.itemsInfo.items[].thumbnail.height | type: number | description: Thumbnail height.
|
|
948
|
+
- name: products[].media.itemsInfo.items[].thumbnail.url | type: string | description: Thumbnail url.
|
|
949
|
+
- name: products[].media.itemsInfo.items[].thumbnail.width | type: number | description: Thumbnail width.
|
|
950
|
+
- name: products[].media.itemsInfo.items[].uploadId | type: string | description: GUID used to upload media to Wix Media Manager.
|
|
951
|
+
- ONE-OF:
|
|
952
|
+
- name: products[].media.itemsInfo.items[]._id | type: string | description: Set media by GUID of an existing file in Wix Media Manager.
|
|
953
|
+
- name: products[].media.itemsInfo.items[].url | type: string | description: Set media using an external media URL.
|
|
954
|
+
- ONE-OF:
|
|
955
|
+
- name: products[].media.itemsInfo.items[].image | type: string | description: Product image.
|
|
956
|
+
- name: products[].media.itemsInfo.items[].video | type: string | description: Product video.
|
|
957
|
+
- name: products[].media.main | type: ProductMedia | description: Main media (image, video, etc.) associated with this product.
|
|
958
|
+
- name: products[].modifiers | type: Array<ConnectedModifier> | description: Product modifiers. Allows the customer to customize product, e.g. select Color, Size and so on similarly to `options` but with one main difference - `modifiers` never generate any variants.
|
|
959
|
+
- name: products[].modifiers[]._id | type: string | description: GUID of a customization with `customizationType: MODIFIER`.
|
|
960
|
+
- name: products[].modifiers[].mandatory | type: boolean | description: Whether customer input is required for this modifier.
|
|
961
|
+
- name: products[].modifiers[].modifierRenderType | type: ModifierRenderType | description: Modifier render type.
|
|
962
|
+
enum:
|
|
963
|
+
FREE_TEXT: Free text.
|
|
964
|
+
SWATCH_CHOICES: Swatch choices.
|
|
965
|
+
TEXT_CHOICES: Text choices.
|
|
966
|
+
UNKNOWN_MODIFIER_RENDER_TYPE: Not implemented.
|
|
967
|
+
- name: products[].modifiers[].name | type: string | description: Modifier title.
|
|
968
|
+
- ONE-OF:
|
|
969
|
+
- name: products[].modifiers[].choicesSettings | type: ModifierChoicesSettings | description: Choice settings.
|
|
970
|
+
- name: products[].modifiers[].choicesSettings.choices | type: Array<ConnectedModifierChoice> | description: List of modifier choices.
|
|
971
|
+
- name: products[].modifiers[].choicesSettings.choices[].addedPrice | type: string | description: Added price.
|
|
972
|
+
- name: products[].modifiers[].choicesSettings.choices[].choiceId | type: string | description: Choice GUID.
|
|
973
|
+
- name: products[].modifiers[].choicesSettings.choices[].choiceType | type: ChoiceType | description: Choice type.
|
|
974
|
+
enum:
|
|
975
|
+
CHOICE_TEXT: Text choice.
|
|
976
|
+
IMAGE: Image choice.
|
|
977
|
+
MULTIPLE_COLORS: Multiple colors choice.
|
|
978
|
+
ONE_COLOR: Single color choice.
|
|
979
|
+
UNKNOWN_CHOICE_TYPE
|
|
980
|
+
- name: products[].modifiers[].choicesSettings.choices[].key | type: string | description: Modifier key. Used for eCommerce integration.
|
|
981
|
+
- name: products[].modifiers[].choicesSettings.choices[].linkedMedia | type: Array<ProductMedia> | description: Product media.
|
|
982
|
+
- name: products[].modifiers[].choicesSettings.choices[].name | type: string | description: Choice name.
|
|
983
|
+
- ONE-OF:
|
|
984
|
+
- name: products[].modifiers[].choicesSettings.choices[].colorCode | type: string | description: Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
985
|
+
- name: products[].modifiers[].freeTextSettings | type: FreeTextSettings | description: Free text modifier settings.
|
|
986
|
+
- name: products[].modifiers[].freeTextSettings.defaultAddedPrice | type: string | description: Default amount to be added to the product's price.
|
|
987
|
+
- name: products[].modifiers[].freeTextSettings.maxCharCount | type: number | description: Maximum number of characters.
|
|
988
|
+
- name: products[].modifiers[].freeTextSettings.minCharCount | type: number | description: Minimum number of characters.
|
|
989
|
+
- name: products[].modifiers[].freeTextSettings.title | type: string | description: Title of the text to be input by the customer.
|
|
990
|
+
- name: products[].name | type: string | description: Product name. Translatable.
|
|
991
|
+
- name: products[].options | type: Array<ConnectedOption> | description: Product options. Allows the customer to customize the product. For example, selecting color, size, and more. Always generates variants: every variant must have exactly one choice related to each option. Since options and variants tightly coupled and rely on each other they usually should be provided together in all operations.
|
|
992
|
+
- name: products[].options[]._id | type: string | description: GUID of a customization with `customizationType: PRODUCT_OPTION`.
|
|
993
|
+
- name: products[].options[].name | type: string | description: Option name.
|
|
994
|
+
- name: products[].options[].optionRenderType | type: ProductOptionRenderType | description: Option render type.
|
|
995
|
+
enum:
|
|
996
|
+
SWATCH_CHOICES: Swatch choices.
|
|
997
|
+
TEXT_CHOICES: Text choices.
|
|
998
|
+
UNKNOWN_OPTION_RENDER_TYPE: Not implemented.
|
|
999
|
+
- ONE-OF:
|
|
1000
|
+
- name: products[].options[].choicesSettings | type: ChoicesSettings | description: Choices settings.
|
|
1001
|
+
- name: products[].options[].choicesSettings.choices | type: Array<ConnectedOptionChoice> | description: List of available choices for the option.
|
|
1002
|
+
- name: products[].options[].choicesSettings.choices[].choiceId | type: string | description: The id of the choice.
|
|
1003
|
+
- name: products[].options[].choicesSettings.choices[].choiceType | type: ChoiceType | description: The type of this choice.
|
|
1004
|
+
- name: products[].options[].choicesSettings.choices[].inStock | type: boolean | description: A flag that indicates if at least one variant with this choice is in stock in the default store's location. For example, a product with 'Color' and 'Size' options with variants: [Blue, Small] which is out of stock and [Red Large] which is in stock. For choice 'Blue' ths flag will be 'false' and for 'Red' the flag will be true
|
|
1005
|
+
- name: products[].options[].choicesSettings.choices[].linkedMedia | type: Array<ProductMedia> | description: Product media overrides. When not empty only these images will be shown when such choices selected by customer. Otherwise all images of product. When several choices from different options selected only media filter present in `media_overrides` of ALL choices will be shown. For example if Color:red has images 1,2,3 and Material:Silk has images 2,3,5 then only images 2,3 will be shown when both of them selected.
|
|
1006
|
+
- name: products[].options[].choicesSettings.choices[].name | type: string | description: Choice name.
|
|
1007
|
+
- name: products[].options[].choicesSettings.choices[].visible | type: boolean | description: Whether at least one variant with this choice is visible. Default: `false`
|
|
1008
|
+
- ONE-OF:
|
|
1009
|
+
- name: products[].options[].choicesSettings.choices[].colorCode | type: string | description: Color code in HEX format, [as described by MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/hex-color).
|
|
1010
|
+
- name: products[].plainDescription | type: string | description: Product description in HTML. + When provided on create/update, this string must be a valid HTML. It will then be converted to rich content. + `plainDescription` is ignored when value is also passed to the `description` field. > **Note:** Returned only when you pass `"PLAIN_DESCRIPTION"` to the `fields` array in Products API requests.
|
|
1011
|
+
- name: products[].productType | type: ProductType | description: Product type. When passing `productType: PHYSICAL`, you must also pass `physicalProperties`.
|
|
1012
|
+
enum:
|
|
1013
|
+
DIGITAL: Digital product.
|
|
1014
|
+
PHYSICAL: Physical product.
|
|
1015
|
+
UNKNOWN_PRODUCT_TYPE: Not implemented.
|
|
1016
|
+
- name: products[].revision | type: string | description: Revision number, which increments by 1 each time the product is updated. To prevent conflicting changes, the current revision must be passed when updating the product. Ignored when creating a product.
|
|
1017
|
+
- name: products[].ribbon | type: Ribbon | description: Product ribbon. + Pass `ribbon.name` to add a new ribbon while creating a product. + Pass an existing ribbon's `id` or `name` to assign that ribbon to the product.
|
|
1018
|
+
- name: products[].ribbon._id | type: string | description: Ribbon GUID.
|
|
1019
|
+
- name: products[].ribbon.name | type: string | description: Ribbon name.
|
|
1020
|
+
- name: products[].seoData | type: SeoSchema | description: Product SEO data.
|
|
1021
|
+
- name: products[].seoData.settings | type: Settings | description: SEO general settings.
|
|
1022
|
+
- name: products[].seoData.settings.keywords | type: Array<Keyword> | description: User-selected keyword terms for a specific page.
|
|
1023
|
+
- name: products[].seoData.settings.keywords[].isMain | type: boolean | description: Whether the keyword is the main focus keyword.
|
|
1024
|
+
- name: products[].seoData.settings.keywords[].origin | type: string | description: The source that added the keyword terms to the SEO settings.
|
|
1025
|
+
- name: products[].seoData.settings.keywords[].term | type: string | description: Keyword value.
|
|
1026
|
+
- name: products[].seoData.settings.preventAutoRedirect | type: boolean | description: Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled. Default: `false` (automatical redirect is enabled).
|
|
1027
|
+
- name: products[].seoData.tags | type: Array<Tag> | description: SEO tag information.
|
|
1028
|
+
- name: products[].seoData.tags[].children | type: string | description: SEO tag inner content. For example, `<title> inner content </title>`.
|
|
1029
|
+
- name: products[].seoData.tags[].custom | type: boolean | description: Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages).
|
|
1030
|
+
- name: products[].seoData.tags[].disabled | type: boolean | description: Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines.
|
|
1031
|
+
- name: products[].seoData.tags[].meta | type: Record<string, any> | description: SEO tag metadata. For example, `{"height": 300, "width": 240}`.
|
|
1032
|
+
- name: products[].seoData.tags[].props | type: Record<string, any> | description: A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value. For example: `{"name": "description", "content": "the description itself"}`.
|
|
1033
|
+
- name: products[].seoData.tags[].type | type: string | description: SEO tag type. Supported values: `title`, `meta`, `script`, `link`.
|
|
1034
|
+
- name: products[].slug | type: string | description: Product slug. If not provided, the slug is autogenerated based on the product name.
|
|
1035
|
+
- name: products[].subscriptionDetails | type: SubscriptionDetails | description: Product subscriptions.
|
|
1036
|
+
- name: products[].subscriptionDetails.allowOneTimePurchases | type: boolean | description: Whether to allow one-time purchases in addition to subscription-based purchases. Default: `false`
|
|
1037
|
+
- name: products[].subscriptionDetails.subscriptions | type: Array<Subscription> | description: Subscriptions.
|
|
1038
|
+
- name: products[].subscriptionDetails.subscriptions[]._id | type: string | description: Subscription GUID.
|
|
1039
|
+
- name: products[].subscriptionDetails.subscriptions[].description | type: string | description: Subscription description.
|
|
1040
|
+
- name: products[].subscriptionDetails.subscriptions[].discount | type: SubscriptionDiscount | description: Discount info (optional). For example, a $20 discount would be `amount: 20`, `type: AMOUNT`.
|
|
1041
|
+
- name: products[].subscriptionDetails.subscriptions[].discount.type | type: DiscountType | description: Discount type.
|
|
1042
|
+
enum:
|
|
1043
|
+
AMOUNT: Discount by a specific amount.
|
|
1044
|
+
PERCENT: Discount by a percentage.
|
|
1045
|
+
UNKNOWN_DISCOUNT
|
|
1046
|
+
- ONE-OF:
|
|
1047
|
+
- name: products[].subscriptionDetails.subscriptions[].discount.amountOff | type: string | description: Amount to discount from the variant discounted_price.
|
|
1048
|
+
- name: products[].subscriptionDetails.subscriptions[].discount.percentOff | type: number | description: Percentage to discount from variant discounted_price.
|
|
1049
|
+
- name: products[].subscriptionDetails.subscriptions[].frequency | type: SubscriptionFrequency | description: Frequency of recurring payment. For example, if `frequency: MONTH` and `billingCycles: 6`; payment will be made monthly for 6 months.
|
|
1050
|
+
enum: DAY, MONTH, UNDEFINED, WEEK, YEAR
|
|
1051
|
+
- name: products[].subscriptionDetails.subscriptions[].interval | type: number | description: Interval of recurring payment. Default: `1`. For example, if `frequency: MONTH`, `billingCycles: 3` and `interval: 2`; payment will be made every 2 months for a total of 6 months.
|
|
1052
|
+
- name: products[].subscriptionDetails.subscriptions[].title | type: string | description: Subscription title.
|
|
1053
|
+
- name: products[].subscriptionDetails.subscriptions[].visible | type: boolean | description: Whether the subscription is visible to site visitors. Default: `true`
|
|
1054
|
+
- ONE-OF:
|
|
1055
|
+
- name: products[].subscriptionDetails.subscriptions[].autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period. Cannot be `false`, instead set `billingCycles`.
|
|
1056
|
+
- name: products[].subscriptionDetails.subscriptions[].billingCycles | type: number | description: Number of billing cycles before subscription ends.
|
|
1057
|
+
- name: products[].taxGroupId | type: string | description: Tax group GUID.
|
|
1058
|
+
- name: products[].url | type: string | description: URL to the site's product page. > **Note:** Returned only when you pass `"URL"` to the `fields` array in Products API requests.
|
|
1059
|
+
- name: products[].variantSummary | type: VariantSummary | description: The total number of variants for the product.
|
|
1060
|
+
- name: products[].variantSummary.variantCount | type: number | description: The total number of variants for the product.
|
|
1061
|
+
- name: products[].variantsInfo | type: VariantsInfo | description: Product variants. Each variant must reference all product options via its `choices` array. Each choice references an option using `optionChoiceNames` for all requests.
|
|
1062
|
+
- name: products[].variantsInfo.variants | type: Array<Variant> | description: List of related variants.
|
|
1063
|
+
- name: products[].variantsInfo.variants[]._id | type: string | description: Variant GUID.
|
|
1064
|
+
- name: products[].variantsInfo.variants[].barcode | type: string | description: Variant barcode.
|
|
1065
|
+
- name: products[].variantsInfo.variants[].choices | type: Array<OptionChoice> | description: List of choices that define the product's variant, which requires exactly one choice per product option. Must use `optionChoiceNames` in all requests this field is required. Empty only for default variants of unmanaged products.
|
|
1066
|
+
- name: products[].variantsInfo.variants[].choices[].optionChoiceIds | type: OptionChoiceIds | description: Option and choice GUIDs. These match the GUIDs of the option and choice from the product's options field.
|
|
1067
|
+
- name: products[].variantsInfo.variants[].choices[].optionChoiceIds.choiceId | type: string | description: Choice GUID.
|
|
1068
|
+
- name: products[].variantsInfo.variants[].choices[].optionChoiceIds.optionId | type: string | description: Option GUID.
|
|
1069
|
+
- name: products[].variantsInfo.variants[].choices[].optionChoiceNames | type: OptionChoiceNames | description: Option and choice names. This needs to be used in all requests `OptionChoice` is needed, and all `OptionChoiceNames` fields are required. > **Note:** Returned only when you pass `"VARIANT_OPTION_CHOICE_NAMES"` to the `fields` array in Products API requests.
|
|
1070
|
+
- name: products[].variantsInfo.variants[].choices[].optionChoiceNames.choiceName | type: string | description: Choice name.
|
|
1071
|
+
- name: products[].variantsInfo.variants[].choices[].optionChoiceNames.optionName | type: string | description: Option name.
|
|
1072
|
+
- name: products[].variantsInfo.variants[].choices[].optionChoiceNames.renderType | type: ProductOptionRenderType | description: Render type.
|
|
1073
|
+
- name: products[].variantsInfo.variants[].inventoryStatus | type: InventoryStatus | description: Variant inventory status.
|
|
1074
|
+
- name: products[].variantsInfo.variants[].inventoryStatus.inStock | type: boolean | description: Whether the variant is in stock.
|
|
1075
|
+
- name: products[].variantsInfo.variants[].inventoryStatus.preorderEnabled | type: boolean | description: Whether preorder is enabled for this variant.
|
|
1076
|
+
- name: products[].variantsInfo.variants[].media | type: ProductMedia | description: Variant media.
|
|
1077
|
+
- name: products[].variantsInfo.variants[].price | type: PriceInfo | description: Variant price.
|
|
1078
|
+
- name: products[].variantsInfo.variants[].price.actualPrice | type: FixedMonetaryAmount | description: Variant price. Must be greater or equal to 0.
|
|
1079
|
+
- name: products[].variantsInfo.variants[].price.compareAtPrice | type: FixedMonetaryAmount | description: The compare-at-price represents the original price of a product before any discount. It is optional and should only be set if a discount applies. When set, it must be higher than the current price to reflect accurate savings.
|
|
1080
|
+
- name: products[].variantsInfo.variants[].revenueDetails | type: RevenueDetails | description: Variant revenue details. > **Note:** Returned only when the following conditions are met: > + You pass `"MERCHANT_DATA"` to the `fields` array in Products API requests. > + Your app has the required `SCOPE.STORES.PRODUCT_READ_ADMIN` permission scope.
|
|
1081
|
+
- name: products[].variantsInfo.variants[].revenueDetails.cost | type: FixedMonetaryAmount | description: Item cost.
|
|
1082
|
+
- name: products[].variantsInfo.variants[].revenueDetails.profit | type: FixedMonetaryAmount | description: Profit. Calculated by reducing `cost` from `discountedPrice`.
|
|
1083
|
+
- name: products[].variantsInfo.variants[].revenueDetails.profitMargin | type: number | description: Profit Margin. Calculated by dividing `profit` by `discountedPrice`. The result is rounded to 4 decimal places.
|
|
1084
|
+
- name: products[].variantsInfo.variants[].sku | type: string | description: Variant SKU (stock keeping unit).
|
|
1085
|
+
- name: products[].variantsInfo.variants[].subscriptionPricesInfo | type: SubscriptionPricesInfo | description: Subscription prices calculated by applying subscription discount to the variant `price.actual_price`. > **Note:** Returned only when you pass `"SUBSCRIPTION_PRICES_INFO"` to the `fields` array in Products API requests.
|
|
1086
|
+
- name: products[].variantsInfo.variants[].subscriptionPricesInfo.subscriptionPrices | type: Array<SubscriptionPrice> | description: Subscription prices.
|
|
1087
|
+
- name: products[].variantsInfo.variants[].subscriptionPricesInfo.subscriptionPrices[].price | type: FixedMonetaryAmount | description: Subscription price calculated by applying subscription discount to the variant `price.actual_price`
|
|
1088
|
+
- name: products[].variantsInfo.variants[].subscriptionPricesInfo.subscriptionPrices[].pricePerUnit | type: SubscriptionPricePerUnit | description: Price per unit info.
|
|
1089
|
+
- name: products[].variantsInfo.variants[].subscriptionPricesInfo.subscriptionPrices[].pricePerUnit.description | type: string | description: Price per unit description. > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
|
|
1090
|
+
- name: products[].variantsInfo.variants[].subscriptionPricesInfo.subscriptionPrices[].pricePerUnit.value | type: string | description: Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, `pricePerUnit` settings of this variant, and the variant subscription price.
|
|
1091
|
+
- name: products[].variantsInfo.variants[].subscriptionPricesInfo.subscriptionPrices[].subscriptionId | type: string | description: Subscription GUID.
|
|
1092
|
+
- name: products[].variantsInfo.variants[].visible | type: boolean | description: Whether the variant is visible to site visitors. Default: `true`
|
|
1093
|
+
- ONE-OF:
|
|
1094
|
+
- name: products[].variantsInfo.variants[].digitalProperties | type: VariantDigitalProperties | description: Digital properties. Must be passed when `productType: DIGITAL`
|
|
1095
|
+
- name: products[].variantsInfo.variants[].digitalProperties.digitalFile | type: SecuredMedia | description: Digital file which will be downloaded by customer after successful purchase.
|
|
1096
|
+
- name: products[].variantsInfo.variants[].digitalProperties.digitalFile._id | type: string | description: Media GUID in media manager.
|
|
1097
|
+
- name: products[].variantsInfo.variants[].digitalProperties.digitalFile.fileName | type: string | description: Original file name.
|
|
1098
|
+
- name: products[].variantsInfo.variants[].digitalProperties.digitalFile.fileSize | type: string | description: Original file size.
|
|
1099
|
+
- name: products[].variantsInfo.variants[].digitalProperties.digitalFile.fileType | type: FileType | description: File type.
|
|
1100
|
+
enum:
|
|
1101
|
+
SECURE_ARCHIVE: Secure archive file.
|
|
1102
|
+
SECURE_DOCUMENT: Secure document file.
|
|
1103
|
+
SECURE_MUSIC: Secure music file.
|
|
1104
|
+
SECURE_PICTURE: Secure picture file.
|
|
1105
|
+
SECURE_VIDEO: Secure video file.
|
|
1106
|
+
UNSPECIFIED: Unspecified file type.
|
|
1107
|
+
- name: products[].variantsInfo.variants[].physicalProperties | type: VariantPhysicalProperties | description: Physical properties. Must be passed when `productType: PHYSICAL`
|
|
1108
|
+
- name: products[].variantsInfo.variants[].physicalProperties.pricePerUnit | type: PricePerUnit | description: Price per unit info, in order to show price per unit on the product page. For example if one sells cheese and defines 100g here then we know that buying this variant buyer receives 100g of cheese. But on product page price will be displayed for units defined on product level. See `pricePerUnit.value` to understand how it's calculated.
|
|
1109
|
+
- name: products[].variantsInfo.variants[].physicalProperties.pricePerUnit.description | type: string | description: Price per unit description. > **Note:** Returned only when you pass `"CURRENCY"` to the `fields` array in Products API requests.
|
|
1110
|
+
- name: products[].variantsInfo.variants[].physicalProperties.pricePerUnit.settings | type: PricePerUnitSettings | description: Price per unit data for this variant. `measurementUnit` value must correspond to the measurement unit set on the product.
|
|
1111
|
+
- name: products[].variantsInfo.variants[].physicalProperties.pricePerUnit.settings.measurementUnit | type: MeasurementUnit | description: Measurement unit. For example, to define price per 100 grams, set this field to "G".
|
|
1112
|
+
enum: CBM, CL, CM, FLOZ, FT, G, GAL, IN, KG, L, LB, M, MG, ML, MM, OZ, PT, QT, SQFT, SQM, UNSPECIFIED, YD
|
|
1113
|
+
- name: products[].variantsInfo.variants[].physicalProperties.pricePerUnit.settings.quantity | type: number | description: Quantity. For example, to define price per per 100 grams, set this field to `100`.
|
|
1114
|
+
- name: products[].variantsInfo.variants[].physicalProperties.pricePerUnit.value | type: string | description: Calculated value of price per unit. Takes into account `pricePerUnit` settings of parent product, of this variant, and discounted price of variant. For example if discounted price is 2$, product's price per unit setting is 1 Kg, variant price per unit setting is 0.5 Kg then this value is 4$ (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).
|
|
1115
|
+
- name: products[].variantsInfo.variants[].physicalProperties.weight | type: number | description: Variant shipping weight. product.physicalProperties.shipping_weight_range values are taken from here.
|
|
1116
|
+
- name: products[].visible | type: boolean | description: Whether the product is visible to site visitors on the site. Default: `true`
|
|
1117
|
+
- name: products[].visibleInPos | type: boolean | description: Whether the product is visible in POS (point of sale). Default: `true` > **Note:** Always `false` for `productType: DIGITAL`.
|
|
1118
|
+
- ONE-OF:
|
|
1119
|
+
- name: products[].physicalProperties | type: PhysicalProperties | description: Physical properties. Required when `productType: PHYSICAL`.
|
|
1120
|
+
- name: products[].physicalProperties.deliveryProfileId | type: string | description: Delivery profile GUID.
|
|
1121
|
+
- name: products[].physicalProperties.fulfillerId | type: string | description: Fulfiller GUID.
|
|
1122
|
+
- name: products[].physicalProperties.pricePerUnit | type: PricePerUnitSettings | description: Price per unit settings. > **Note:** Use this field only when relevant. For example, for products that are sold by weight, volume, or length.
|
|
1123
|
+
- name: products[].physicalProperties.pricePerUnitRange | type: PricePerUnitRange | description: Product price per unit range. The minimum and maximum price per unit of all the variants.
|
|
1124
|
+
- name: products[].physicalProperties.pricePerUnitRange.maxValue | type: PricePerUnitRangePricePerUnit | description: Maximum price per unit across all variants.
|
|
1125
|
+
- name: products[].physicalProperties.pricePerUnitRange.maxValue.description | type: string | description: Price per unit info in the format of variant specific data / product setting, for example €4.00 / 1 Kg. > **Note:** This field is returned by the API only when you pass `fields: "CURRENCY"` in a request.
|
|
1126
|
+
- name: products[].physicalProperties.pricePerUnitRange.maxValue.value | type: string | description: Calculated value of price per unit. Takes into account pricePerUnit settings of product and variants and price of variants. For example if discounted price is 2$, product's price per unit setting is 1 Kg, variant price per unit setting is 0.5 Kg then this value is 4$ (means variant weight is 0.5 Kg and it costs 2$ but we want to show price per 1 Kg so we show 4$).
|
|
1127
|
+
- name: products[].physicalProperties.pricePerUnitRange.minValue | type: PricePerUnitRangePricePerUnit | description: Minimum price per unit across all variants.
|
|
1128
|
+
- name: products[].physicalProperties.shippingWeightRange | type: WeightRange | description: Product shipping weight range - Calculated from the lightest and heaviest variant shipping weights.
|
|
1129
|
+
- name: products[].physicalProperties.shippingWeightRange.maxValue | type: number | description: Maximum weight across all variants associated with this product.
|
|
1130
|
+
- name: products[].physicalProperties.shippingWeightRange.minValue | type: number | description: Minimum weight across all variants associated with this product.
|
|
1131
|
+
- name: products[].physicalProperties.weightMeasurementUnitInfo | type: WeightMeasurementUnitInfo | description: Weight measurement unit. > **Note:** Returned only when you pass `"WEIGHT_MEASUREMENT_UNIT_INFO"` to the `fields` array in Products API requests.
|
|
1132
|
+
- name: products[].physicalProperties.weightMeasurementUnitInfo.weightMeasurementUnit | type: WeightUnit | description: Weight measurement unit.
|
|
1133
|
+
enum:
|
|
1134
|
+
KG: Kilograms.
|
|
1135
|
+
LB: Pounds.
|
|
1136
|
+
UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
|
|
1137
|
+
Possible Errors:
|
|
1138
|
+
HTTP Code: 403 | Status Code: PERMISSION_DENIED | Application Code: NO_PERMISSION_TO_INCLUDE_NOT_VISIBLE_PRODUCTS
|
|
1139
|
+
HTTP Code: 403 | Status Code: PERMISSION_DENIED | Application Code: NO_PERMISSION_TO_READ_MERCHANT_DATA
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
```
|
|
1143
|
+
</type_definition>
|
|
1144
|
+
</stores_productsV3_searchProducts>
|