@wix/ditto-codegen-public 1.0.162 → 1.0.164

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

@@ -0,0 +1,139 @@
+<stores_inventoryItemsV3_updateInventoryItem>
+<description>
+# Method name:
+
+stores.inventoryItemsV3.updateInventoryItem(_id: string, inventoryItem: UpdateInventoryItem, options: UpdateInventoryItemOptions)
+
+# Method Link:
+
+https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/inventory-items-v3/update-inventory-item
+
+# Method Description:
+
+Updates an inventory item.
+
+
+Each time the inventory item is updated, `revision` increments by 1.
+The current `revision` must be passed when updating the inventory item.
+This ensures you're working with the latest inventory item and prevents unintended overwrites.
+
+# Method Permissions:
+
+- WIX_STORES.INVENTORY_UPDATE
+
+# Method Permissions Scopes IDs:
+
+undefined
+
+
+
+# Method Code Examples:
+
+## updateInventoryItem
+
+```javascript
+import { inventoryItemsV3 } from '@wix/stores';
+
+async function updateInventoryItem(id, inventoryItem, options) {
+ const response = await inventoryItemsV3.updateInventoryItem(id, inventoryItem, options);
+};
+```
+
+## updateInventoryItem (with elevated permissions)
+
+```javascript
+import { inventoryItemsV3 } from '@wix/stores';
+import { auth } from '@wix/essentials';
+
+async function myUpdateInventoryItemMethod(id, inventoryItem, options) {
+ const elevatedUpdateInventoryItem = auth.elevate(inventoryItemsV3.updateInventoryItem);
+ const response = await elevatedUpdateInventoryItem(id, inventoryItem, options);
+}
+```
+
+
+
+## default
+
+```javascript
+try {
+     const result = await inventoryItemsV3.updateInventoryItem(
+       "ca3ed606-73ca-43d2-a22e-274a42d2d135",
+       {
+         inStock: true,
+         locationId: "7dbb10d8-62ca-4b24-8143-7872a01d667f",
+         productId: "9545a9f6-779f-4b92-ab2c-67c5551d0bde",
+         revision: "1",
+         extendedFields: {}
+       },
+       { reason: "MANUAL" }
+     );
+     return result;
+   } catch (error) {
+     console.error(error);
+     throw error;
+  }
+```
+</description>
+<type_definition>
+```
+Method: stores.inventoryItemsV3.updateInventoryItem(_id, inventoryItem, options)
+Description: Updates an inventory item.   Each time the inventory item is updated, `revision` increments by 1. The current `revision` must be passed when updating the inventory item. This ensures you're working with the latest inventory item and prevents unintended overwrites.
+Method parameters:
+  param name:  _id | type: string | description:  Inventory item GUID. | required: true
+  param name:  inventoryItem | type: UpdateInventoryItem | description:  none | required: true
+      - name: 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: 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: inStock  | type: boolean | description:  Tracking method - in stock.  When set to `true`, the item is available for sale without a quantity limit. 
+      - name: locationId  | type: string | description:  Stores location GUID. 
+      - name: preorderInfo  | type: PreorderInfo | description:  Item preorder info. 
+          - name: enabled  | type: boolean | description:  Whether preorder is enabled for the product.  Default: `false` 
+          - name: 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: message  | type: string | description:  A message the customer will see when the item is out of stock and preorder is enabled. 
+      - name: productId  | type: string | description:  Product GUID. 
+      - name: 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: 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. | required: true
+      - name: variantId  | type: string | description:  Variant GUID. 
+  param name:  options | type: UpdateInventoryItemOptions | description:  none 
+      - name: reason  | type: ReasonType | description:  Reason for update. 
+          enum: MANUAL, ORDER, REVERT_INVENTORY_CHANGE, UNKNOWN
+Return type: PROMISE<InventoryItem>
+      - name: _createdDate  | type: Date | description:  Date and time the inventory item was created. 
+      - name: _id  | type: string | description:  Inventory item GUID. 
+      - name: _updatedDate  | type: Date | description:  Date and time the inventory item was created. 
+      - name: 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: 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: 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: locationId  | type: string | description:  Stores location GUID. 
+      - name: preorderInfo  | type: PreorderInfo | description:  Item preorder info. 
+          - name: preorderInfo.counter  | type: number | description:  Number of times the product was preordered.  Supported only for inventory items with `trackQuantity = true`. 
+          - name: preorderInfo.enabled  | type: boolean | description:  Whether preorder is enabled for the product.  Default: `false` 
+          - name: 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: preorderInfo.message  | type: string | description:  A message the customer will see when the item is out of stock and preorder is enabled. 
+          - name: preorderInfo.quantity  | type: number | description:  Quantity of products that can be preordered.  Supported only for inventory items with `trackQuantity = true`. 
+      - name: product  | type: Product | description:  Product. 
+          - name: product.directCategoryIds  | type: Array<string> | description:  List of category GUIDs that this product is included in directly. 
+          - name: product.name  | type: string | description:  Product name. 
+          - name: product.variantName  | type: string | description:  Variant name. 
+          - name: product.variantSku  | type: string | description:  Variant SKU (stock keeping unit). 
+          - name: product.variantVisible  | type: boolean | description:  Variant visible. 
+      - name: productId  | type: string | description:  Product GUID. 
+      - name: 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: trackQuantity  | type: boolean | description:  Whether the quantity is being tracked. 
+      - name: variantId  | type: string | description:  Variant GUID. 
+      - ONE-OF: 
+        - name: inStock  | type: boolean | description:  Tracking method - in stock.  When set to `true`, the item is available for sale without a quantity limit. 
+        - name: 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. 
+Possible Errors:
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: PRE_ORDER_VALIDATION
+  HTTP Code: 428 | Status Code: FAILED_PRECONDITION | Application Code: REQUESTED_QUANTITY_MUST_BE_NON_NEGATIVE_DECREASING
+
+
+```
+</type_definition>
+</stores_inventoryItemsV3_updateInventoryItem>