updateInventoryItem( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Manage Products
Manage Restaurants - all permissions
Manage v3 catalog
Inventory write in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
function updateInventoryItem(
  _id: string,
  inventoryItem: UpdateInventoryItem,
  options: UpdateInventoryItemOptions,
): Promise<InventoryItem>;
Method Parameters
_idstringRequired

Inventory item ID.

inventoryItemUpdateInventoryItemRequired
optionsUpdateInventoryItemOptions
Returns
Return Type:Promise<InventoryItem>
JavaScript
import { inventoryItemsV3 } from "@wix/stores";

async function updateInventoryItem(id, inventoryItem, options) {
  const response = await inventoryItemsV3.updateInventoryItem(
    id,
    inventoryItem,
    options,
  );
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?