decrementInventory( )

Subtracts a set number of items from inventory.

Description

The decrementInventory() function returns a Promise that is resolved when the specified item's quantity has been updated in the inventory.

Syntax

function decrementInventory(items: Array<DecrementInfo>): Promise<void>

decrementInventory Parameters

NAME

TYPE

DESCRIPTION

items

Array<DecrementInfo>

Inventory items to decrement.

Returns

Fulfilled - When the inventory is decremented.

Return Type:

Promise<void>

Decrement the inventory of a product's first variant

Code Example

Copy Code

1/*******************************
2 * Backend code - inventory.jsw *
3 *******************************/
4
5import wixStoresBackend from 'wix-stores-backend';
6
7export function decrementInventory(decrementInfo) {
8  return wixStoresBackend.decrementInventory(decrementInfo);
9}
10
11
12/**************
13 * Page code *
14 **************/
15
16import { decrementInventory } from 'backend/inventory';
17
18
19async function decrementHandler() {
20
21  const productId = "3fb6a3c8-988b-8755-04bd-ks75ae0b18ea"
22  let variants = await getProductVariants(productId);
23
24  decrementInventory(
25    [{
26      variantId: variants[0]._id,
27      productId: productId,
28      decrementBy: 1
29    }])
30    .then(() => {
31      console.log("Inventory decremented successfully")
32    })
33    .catch(error => {
34      // Inventory decrement failed
35      console.error(error);
36    })
37}