getInventoryItem( )

Developer Preview

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

Retrieves an inventory item.

Permissions
Manage Stores - all permissions
Read Stores - all read permissions
Manage Orders
Manage Products
Read Products
Manage Restaurants - all permissions
Read v3 catalog
Manage v3 catalog
Read inventory in v3 catalog
Learn more about app permissions.
Method Declaration
Copy
function getInventoryItem(inventoryItemId: string): Promise<InventoryItem>;
Method Parameters
inventoryItemIdstringRequired

Inventory item ID.

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

async function getInventoryItem(inventoryItemId) {
  const response = await inventoryItemsV3.getInventoryItem(inventoryItemId);
}
Errors

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

Did this help?