@wix/ditto-codegen-public 1.0.162 → 1.0.164

package/dist/docs-output/api-docs/stores-inventory-updateInventoryVariants-doc.txt

@@ -0,0 +1,249 @@
+<stores_inventory_updateInventoryVariants>
+<description>
+# Method name:
+
+stores.inventory.updateInventoryVariants(productId: string, inventoryItem: UpdateInventoryVariantsInventoryItem)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/inventory/update-inventory-variants
+
+# Method Description:
+
+Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.
+
+
+The `updateInventoryVariants()` function is a Promise that resolves to the updated inventory variant data.
+
+# Method Permissions:
+
+- WIX_STORES.MODIFY_INVENTORY
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## Update a variant's inventory information by product ID (with $w) 
+
+```javascript
+/**************************************
+* Backend code - inventory.web.js/ts *
+**************************************/
+
+import { Permissions, webMethod } from '@wix/web-methods';
+import { inventory } from '@wix/stores';
+
+export const updateInventoryVariantFieldsByProductId = webMethod(Permissions.Anyone, (productId, inventoryItem) => {
+ return inventory.updateInventoryVariants(productId, inventoryItem);
+});
+
+/*************
+* Page code *
+*************/
+
+import { updateInventoryVariantFieldsByProductId } from 'backend/inventory.web';
+
+$w.onReady(async function () {
+ const product = await $w('#productPage1').getProduct();
+ let options = product.variants;
+ let foundVariant = options.find((option) => {
+   return option.choices.Color === "red" && option.choices.Size === "large";
+ });
+ let inventoryItem = {
+   trackQuantity: false,
+   variants: [{
+     inStock: true,
+     variantId: foundVariant._id,
+   }]
+ };
+ updateInventoryVariantFieldsByProductId(product._id, inventoryItem);
+});
+
+/*  A sample inventory item with variants is:
+*
+* {
+*   "_id" : 133c6\-...-0fb2,
+*   "productId" : ecc3-...-1f04d,
+*   "trackQuantity" : true,
+*   "variants" : -[
+*     {
+*       "variantId" : 00000000-0000-0020-0005-9ec14dfb2270,
+*       "inStock" : false,
+*       "quantity" : 0
+*     },
+*     {
+*       "variantId" : 00000000-0000-0021-0005-9ec14dfb2270,
+*       "inStock" : false,
+*       "quantity" : 0
+*     },
+*     {
+*       "variantId" : 00000000-0000-0022-0005-9ec14dfb2270,
+*       "inStock" : true,
+*       "quantity" : 100
+*     },
+*     {
+*       "variantId" : 00000000-0000-003f-0005-9ec14dfb2270,
+*       "inStock" : true,
+*       "quantity" : 123
+*     },
+*     {
+*       "variantId" : 00000000-0000-0040-0005-9ec14dfb2270,
+*       "inStock" : false,
+*       "quantity" : 0
+*     },
+*     {
+*       "variantId" : 00000000-0000-0041-0005-9ec14dfb2270,
+*       "inStock" : true,
+*       "quantity" : 1
+*     }
+*   ],
+*   "_updatedDate" : 2020-02-17T08:25:57.734Z
+* }
+*/
+
+```
+
+## Update a variant's inventory information by product ID using user input (with $w) 
+
+```javascript
+/**************************************
+* Backend code - inventory.web.js/ts *
+**************************************/
+
+import { Permissions, webMethod } from '@wix/web-methods';
+import { inventory } from '@wix/stores';
+
+export const updateInventoryVariantFieldsByProductId = webMethod(Permissions.Anyone, (productId, inventoryItem) => {
+   return inventory.updateInventoryVariants(productId, inventoryItem);
+});
+
+/*************
+* Page code *
+*************/
+
+import { updateInventoryVariantFieldsByProductId } from 'backend/inventory.web';
+import { items } from '@wix/data';
+
+export function updateByProductIdButton_click(event) {
+   const productId = $w('#updateByProductIdInventoryId').value;
+   const trackQuantity = $w('#updateByProductIdTrackInventory').checked;
+   const variantId = $w('#updateByProductIdVariantId').value;
+   const inStock = $w('#updateByProductIdInStock').checked;
+   const quantity = $w('#updateByProductIdQuantity').value;
+
+   updateInventoryVariantFieldsByProductId(productId, {
+       trackQuantity,
+       variants: [{
+           variantId,
+           inStock,
+           quantity
+       }]
+   }).then(console.log("Variant inventory updated."));
+}
+
+// Populate variant dropdown options 
+// from which the user will choose.
+export async function updateByProductIdRefreshVariantId_click(event) {
+   const productId = $w('#updateByProductIdInventoryId').value;
+   const variantRefreshResults = await items.query('Stores/InventoryItems').eq('productId', productId).find();
+   const ids = variantRefreshResults.items[0].variants.map(variant => {
+       return { label: variant.variantId, value: variant.variantId };
+   });
+   $w('#updateByProductIdVariantId').options = ids;
+}
+
+/*  A sample inventory item with variants is:
+*
+* {
+*   "_id" : 133c6\-...-0fb2,
+*   "externalId" : ecc3-...-1f04d,
+*   "trackQuantity" : true,
+*   "variants" : -[
+*     {
+*       "variantId" : 00000000-0000-0020-0005-9ec14dfb2270,
+*       "inStock" : false,
+*       "quantity" : 0
+*     },
+*     {
+*       "variantId" : 00000000-0000-0021-0005-9ec14dfb2270,
+*       "inStock" : false,
+*       "quantity" : 0
+*     },
+*     {
+*       "variantId" : 00000000-0000-0022-0005-9ec14dfb2270,
+*       "inStock" : true,
+*       "quantity" : 100
+*     },
+*     {
+*       "variantId" : 00000000-0000-003f-0005-9ec14dfb2270,
+*       "inStock" : true,
+*       "quantity" : 123
+*     },
+*     {
+*       "variantId" : 00000000-0000-0040-0005-9ec14dfb2270,
+*       "inStock" : false,
+*       "quantity" : 0
+*     },
+*     {
+*       "variantId" : 00000000-0000-0041-0005-9ec14dfb2270,
+*       "inStock" : true,
+*       "quantity" : 1
+*     }
+*   ],
+*   "_updatedDate" : 2020-02-17T08:25:57.734Z
+* }
+*/
+
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await inventory.updateInventoryVariants("7bb38a7a-70b7-9cf3-fc80-584205694465", {
+         _id: "844c7585-8f48-630c-037f-a7bdfa96bb9a",
+         trackQuantity: true,
+         variants: [{
+           variantId: "00000000-0000-0000-0000-000000000000",
+           inStock: true,
+           quantity: 10
+         }],
+         preorderInfo: {
+           enabled: false
+         }
+       });
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+   }
+```
+</description>
+<type_definition>
+```
+Method: stores.inventory.updateInventoryVariants(productId, inventoryItem)
+Description: Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.   The `updateInventoryVariants()` function is a Promise that resolves to the updated inventory variant data.
+Method parameters:
+  param name:  productId | type: string | description:  Product GUID. | required: true
+  param name:  inventoryItem | type: UpdateInventoryVariantsInventoryItem | description:  Inventory item to update. | required: true
+      - name: _id  | type: string | description:  Inventory item GUID. 
+      - name: preorderInfo  | type: PreorderInfo | description:  Preorder information. 
+          - name: enabled  | type: boolean | description:  Whether the item is available for preorder. 
+          - name: limit  | type: number | description:  Number of products that can be preordered after stock reaches zero. 
+          - name: message  | type: string | description:  A message the buyer will see when the item is out of stock and preorder is enabled. 
+      - name: trackQuantity  | type: boolean | description:  Whether quantity is being tracked. 
+      - name: variants  | type: Array<InventoryVariantV2> | description:  Variants associated with this inventory item. 
+            - name: inStock  | type: boolean | description:  Whether the product is listed as in stock. 
+            - name: quantity  | type: number | description:  Quantity currently left in inventory. 
+            - name: variantId  | type: string | description:  Variant GUID. 
+Return type: PROMISE<void>
+
+```
+</type_definition>
+</stores_inventory_updateInventoryVariants>

package/dist/docs-output/api-docs/stores-inventoryItemsV3-queryInventoryItems-doc.txt

@@ -0,0 +1,236 @@
+<stores_inventoryItemsV3_queryInventoryItems>
+<description>
+# Method name:
+
+stores.inventoryItemsV3.queryInventoryItems()
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/inventory-items-v3/query-inventory-items
+
+# Method Description:
+
+Retrieves a list of up to 1,000 inventory items, given the provided filtering, sorting, and cursor paging.
+
+For field support for filters and sorting,
+see [Inventory Items: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/inventory-items-v3/supported-filters-and-sorting).
+
+To learn about working with _Query_ 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).
+
+
+|PROPERTY	|SUPPORTED FILTERS & SORTING	
+|:---:|:---:|
+|`inStock`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`quantity`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`gt()`](/inventory-items-query-builder/gt),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`_id`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge)|
+|`_createdDate`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`gt()`](/inventory-items-query-builder/gt),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`_updatedDate`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`gt()`](/inventory-items-query-builder/gt),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`variantId`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge)|
+|`locationId`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge)|
+|`productId`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`trackQuantity`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`availabilityStatus`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`preorderInfo.enabled`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`product.name`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`product.directCategoryIds`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`hasAll()`](/inventory-items-query-builder/has-all),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`product.variantName`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+|`product.variantSku`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+
+# Method Permissions:
+
+- WIX_STORES.INVENTORY_READ
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## queryInventoryItems
+
+```javascript
+import { inventoryItemsV3 } from '@wix/stores';
+
+async function queryInventoryItems() {
+ const { items } = await inventoryItemsV3.queryInventoryItems().find();
+};
+```
+
+## queryInventoryItems (with elevated permissions)
+
+```javascript
+import { inventoryItemsV3 } from '@wix/stores';
+import { auth } from '@wix/essentials';
+
+async function myQueryInventoryItemsMethod(query) {
+ const elevatedQueryInventoryItems = auth.elevate(inventoryItemsV3.queryInventoryItems);
+ const response = await elevatedQueryInventoryItems(query);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+     const { items } = await inventoryItemsV3.queryInventoryItems().find();
+     return items;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.inventoryItemsV3.queryInventoryItems()
+Description: Retrieves a list of up to 1,000 inventory items, given the provided filtering, sorting, and cursor paging.  For field support for filters and sorting, see [Inventory Items: Supported Filters and Sorting](https://dev.wix.com/docs/rest/business-solutions/stores/catalog-v3/inventory-items-v3/supported-filters-and-sorting).  To learn about working with _Query_ 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).   |PROPERTY	|SUPPORTED FILTERS & SORTING	 |:---:|:---:| |`inStock`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`quantity`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`gt()`](/inventory-items-query-builder/gt),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`_id`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge)| |`_createdDate`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`gt()`](/inventory-items-query-builder/gt),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`_updatedDate`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`gt()`](/inventory-items-query-builder/gt),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`variantId`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge)| |`locationId`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge)| |`productId`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`trackQuantity`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`availabilityStatus`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`preorderInfo.enabled`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`product.name`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`product.directCategoryIds`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`hasAll()`](/inventory-items-query-builder/has-all),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`product.variantName`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)| |`product.variantSku`|[`eq()`](/inventory-items-query-builder/eq),[`ne()`](/inventory-items-query-builder/ne),[`exists()`](/inventory-items-query-builder/exists),[`in()`](/inventory-items-query-builder/in),[`hasSome()`](/inventory-items-query-builder/has-some),[`startsWith()`](/inventory-items-query-builder/starts-with),[`gt()`](/inventory-items-query-builder/gt),[`lt()`](/inventory-items-query-builder/lt),[`le()`](/inventory-items-query-builder/le),[`ge()`](/inventory-items-query-builder/ge),[`ascending()`](/inventory-items-query-builder/ascending),[`descending()`](/inventory-items-query-builder/descending)|
+Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().ascending(propertyNames)
+    Description: Adds a sort to a query, sorting by the specified properties in ascending order.  The `ascending()` function refines a `InventoryItemsQueryBuilder` to sort by the value of `propertyName` in ascending order. You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed. You can sort the following types: - Number: Sorts numerically. - Date: Sorts by date and time. - String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`. If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
+    Method parameters:
+      param name:  propertyNames | type: Array<string> | description:  Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().descending(propertyNames)
+    Description: Adds a sort to a query, sorting by the specified properties in descending order.  The `descending()` function refines a `InventoryItemsQueryBuilder` to sort by the value of `propertyName` in descending order. You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed. You can sort the following types: - Number: Sorts numerically. - Date: Sorts by date and time. - String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`. If a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
+    Method parameters:
+      param name:  propertyNames | type: Array<string> | description:  Properties used in the sort. To sort by multiple properties, pass properties as additional arguments. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().eq(propertyName, value)
+    Description: Refines a query to match items where the specified property equals the specified value.  The `eq()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`. `eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. Matching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().exists(propertyName, value)
+    Description: Refines a query to match items where the specified property contains a value.  The `exists()` function refines a `InventoryItemsQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.  `exists()` checks for either existence or non-existence based on the boolean parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned.
+    Method parameters:
+      param name:  propertyName | type: string | description:  none 
+      param name:  value | type: boolean | description:  none 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().find()
+    Description: Returns the query results.  The `find()` function returns a Promise that resolves to the query results and metadata. The Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.
+    Return type: PROMISE<InventoryItemsQueryResult>
+          - name: cursors  | type: Cursors | description:  Returns the query cursors.  `cursors` returns the query's `next` and `prev` cursors. 
+              - name: cursors.next  | type: string | description:  Cursor string pointing to the next page in the list of results. 
+              - name: cursors.prev  | type: string | description:  Cursor pointing to the previous page in the list of results. 
+          - name: items  | type: Array<InventoryItem> | description:  Returns an array of `inventoryItemsV3` items that match the query.  `items` contains the current page of results retrieved by the query. If no results match the query, `items` is an empty array. The page size is defined by the [`limit()`](/inventory-items-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `inventoryItemsV3` to navigate the pages of a query result. 
+                - name: items[]._createdDate  | type: Date | description:  Date and time the inventory item was created. 
+                - name: items[]._id  | type: string | description:  Inventory item GUID. 
+                - name: items[]._updatedDate  | type: Date | description:  Date and time the inventory item was created. 
+                - name: items[].availabilityStatus  | type: AvailabilityStatus | description:  Inventory item availability status.  Supported values: + OUT_OF_STOCK: Product is out of stock. + IN_STOCK: Product is in stock. See `quantity` field for exact amount in stock. + PREORDER: Product is only available for preorder. See `preorderInfo` field for more info. 
+                    enum: 
+                         IN_STOCK: Product is in stock. See `quantity` field for exact amount in stock.
+                         OUT_OF_STOCK: Product is out of stock.
+                         PREORDER: Product is only available for preorder. See `preorderInfo` field for more info.
+                       UNKNOWN_AVAILABILITY_STATUS
+                - name: items[].extendedFields  | type: ExtendedFields | description:  Custom field data for the inventory item 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. 
+                    - name: items[].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). 
+                - name: items[].locationId  | type: string | description:  Stores location GUID. 
+                - name: items[].preorderInfo  | type: PreorderInfo | description:  Item preorder info. 
+                    - name: items[].preorderInfo.counter  | type: number | description:  Number of times the product was preordered.  Supported only for inventory items with `trackQuantity = true`. 
+                    - name: items[].preorderInfo.enabled  | type: boolean | description:  Whether preorder is enabled for the product.  Default: `false` 
+                    - name: items[].preorderInfo.limit  | type: number | description:  Number of products that can be preordered after stock reaches zero. Supported only for inventory items with `trackQuantity = true`.  Default: `100000` 
+                    - name: items[].preorderInfo.message  | type: string | description:  A message the customer will see when the item is out of stock and preorder is enabled. 
+                    - name: items[].preorderInfo.quantity  | type: number | description:  Quantity of products that can be preordered.  Supported only for inventory items with `trackQuantity = true`. 
+                - name: items[].product  | type: Product | description:  Product. 
+                    - name: items[].product.directCategoryIds  | type: Array<string> | description:  List of category GUIDs that this product is included in directly. 
+                    - name: items[].product.name  | type: string | description:  Product name. 
+                    - name: items[].product.variantName  | type: string | description:  Variant name. 
+                    - name: items[].product.variantSku  | type: string | description:  Variant SKU (stock keeping unit). 
+                    - name: items[].product.variantVisible  | type: boolean | description:  Variant visible. 
+                - name: items[].productId  | type: string | description:  Product GUID. 
+                - name: items[].revision  | type: string | description:  Revision number, which increments by 1 each time the inventory item is updated. To prevent conflicting changes, the current revision must be passed when updating the inventory item.  Ignored when creating an inventory item. 
+                - name: items[].trackQuantity  | type: boolean | description:  Whether the quantity is being tracked. 
+                - name: items[].variantId  | type: string | description:  Variant GUID. 
+                - ONE-OF: 
+                  - name: items[].inStock  | type: boolean | description:  Tracking method - in stock.  When set to `true`, the item is available for sale without a quantity limit. 
+                  - name: items[].quantity  | type: number | description:  Tracking method - quantity left in inventory.  Quantity can be negative when decrementing inventory for an order that has already been paid. 
+          - name: length  | type: number | description:  Returns the number of items in the current page of results.  `length` returns just the number of items in the current page, not the total number of items that match the query. The page size is defined by the [`limit()`](/inventory-items-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `inventoryItemsV3` to navigate the pages of a query result. 
+          - name: pageSize  | type: number | description:  Returns the requested page size.  `pageSize` returns the page size set in [`limit()`](/inventory-items-query-builder/limit) in `InventoryItemsQueryBuilder`. 
+          - name: query  | type: InventoryItemsQueryBuilder | description:  Returns the `InventoryItemsQueryBuilder` object used to get the current results.  Use `query` to create and run a new query by chaining additional `InventoryItemsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `InventoryItemsQueryBuilder`. 
+          Method: stores.inventoryItemsV3.hasNext()
+          Description: Indicates whether the query has more results.  You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `inventoryItemsV3` to navigate the pages of a query result.
+          Return type: PRIMITIVE<boolean>
+          Method: stores.inventoryItemsV3.hasPrev()
+          Description: Indicates whether the query has previous results.  You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `inventoryItemsV3` to navigate the pages of a query result.
+          Return type: PRIMITIVE<boolean>
+          Method: stores.inventoryItemsV3.queryInventoryItems().next()
+          Description: Retrieves the next page of query results.  The `next()` function retrieves the next page of query results. The page size is defined by the [`limit()`](/inventory-items-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `inventoryItemsV3` to navigate the pages of a query result. If items are added or removed between calls to `next()`, the values returned by `InventoryItemsQueryBuilder` may change.
+          Return type: PROMISE<InventoryItemsQueryResult>
+          Method: stores.inventoryItemsV3.queryInventoryItems().prev()
+          Description: Retrieves the previous page of query results.  The `prev()` function retrieves the previous page of query results. The page size is defined by the [`limit()`](/inventory-items-query-builder/limit) function and can be retrieved using the [`pageSize`](#page-size) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `inventoryItemsV3` to navigate the pages of a query result. If items are added or removed between calls to `prev()`, the values returned may change.
+          Return type: PROMISE<InventoryItemsQueryResult>
+    Method: stores.inventoryItemsV3.queryInventoryItems().ge(propertyName, value)
+    Description: Refines a query to match items where the specified property is greater than or equal to the specified value.  The `ge()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`. `ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects.  - String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().gt(propertyName, value)
+    Description: Refines a query to match items where the specified property is greater than the specified value.  The `gt()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`. `gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects.  - String: Compares lexicographically, so `'abc'` is greater than `'ABC'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().hasAll(propertyName, value)
+    Description: Refines a query to match items whose specified property contains all of the specified values.  The `hasAll()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` equals all of the specified `values`. Matching strings with `hasAll()` is case-sensitive, so `'text'` isn't equal to `'Text'`. If the specified property is an array, `hasAll()` matches if that array's elements match all of the specified values.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `values`. 
+      param name:  value | type: Array<any> | description:  none 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().hasSome(propertyName, value)
+    Description: Refines a query to match items whose specified property contains any of the specified values.  The `hasSome()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`. Matching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`. If the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `values`. 
+      param name:  value | type: Array<any> | description:  none 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().in(propertyName, value)
+    Description: Refines a query to only match items where the specified property contains any of the values in the provided array of values.  The `in()` function refines a `InventoryItemsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array. Matching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  none 
+      param name:  value | type: any | description:  none 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().le(propertyName, value)
+    Description: Refines a query to match items where the specified property is less than or equal to the specified value.  The `le()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`. `le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects.  - String: Compares lexicographically, so `'ABC'` is less than `'abc'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().limit(limit)
+    Description: Limits the number of items the query returns.  The `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time. You can use the `next()` and `prev()` functions to navigate the pages of a query result.
+    Method parameters:
+      param name:  limit | type: number | description:  Number of items to return, which is also the `pageSize` of the results object. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().lt(propertyName, value)
+    Description: Refines a query to match items where the specified property is less than the specified value.  The `le()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`. `le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. If a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared: - Number: Compares numerically. - Date: Compares JavaScript Date objects.  - String: Compares lexicographically, so `'ABC'` is less than `'abc'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().ne(propertyName, value)
+    Description: Refines a query to match items where the specified property doesn't equal the specified value.  The `ne()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`. `ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string. Matching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `value`. 
+      param name:  value | type: any | description:  Value to compare against. 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().skipTo(cursor)
+    Description: Refines a query that skips to a specific record.  The `skipTo()` function refines a `InventoryItemsQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.   When using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed.
+    Method parameters:
+      param name:  cursor | type: string | description:  A pointer to specific record 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+    Method: stores.inventoryItemsV3.queryInventoryItems().startsWith(propertyName, value)
+    Description: Refines a query to match items where the specified property starts with the specified value.  The `startsWith()` function refines a `InventoryItemsQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`. Matching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`. You can only use `startsWith()` with a property whose value is a string.
+    Method parameters:
+      param name:  propertyName | type: string | description:  Property whose value is compared with `string`. 
+      param name:  value | type: string | description:  none 
+    Return type: REFERENCE<InventoryItemsQueryBuilder>
+
+```
+</type_definition>
+</stores_inventoryItemsV3_queryInventoryItems>