onInventoryVariantUpdated( )


An event that fires when the inventory information of a product variant is updated.

The onInventoryVariantUpdated() event handler runs when inventory information for a product variant is updated in a store.

Note: Backend events don't work when previewing your site.

Method Declaration
Copy
function onInventoryVariantUpdated(event: InventoryVariantUpdatedEvent): void;
Method Parameters
eventInventoryVariantUpdatedEventRequired

Information about the updated variant.

An event when product variant inventory information is updated
JavaScript
// Place this code in the events.js file // of your site's Backend section. export function wixStores_onInventoryVariantUpdated(event) { let inventoryItemId = event.inventoryItemId; let firstVariant = event.variants[0]; let firstNewQuantity = firstVariant.newValue.quantity; } /* Full event object: * * { * "variants": [ * { * "oldValue": { * "inStock": true, * "quantity": 10 * }, * "newValue": { * "inStock": true, * "quantity": 50 * }, * "id": "00000000-0000-0000-0000-000000000000" * } * ], * "externalId": "8fe8f05f-951e-1563-b917-88adf8284543", * "inventoryItemId": "70170fa0-6ae1-ea9c-46e8-775207d7babc" * } * */
Errors

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

Did this help?