Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

decrementData

options

DecrementInventoryOptions

Subtracts a set number of items from inventory.


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

import { inventory } from 'wix-stores.v2';

async function decrementInventory(decrementData, options) {
  try {
    const result = await inventory.decrementInventory(decrementData, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


decrementInventory example for dashboard page code

import { inventory } from 'wix-stores.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedDecrementInventory = elevate(inventory.decrementInventory);

export const decrementInventory = webMethod(
  Permissions.Anyone,
  async (decrementData, options) => {
    try {
      const result = await elevatedDecrementInventory(decrementData, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


decrementInventory example for exporting from backend code

decrementInventory

void

inventoryId

string

GetInventoryVariantsOptions

Gets inventory variant information based on the specified option choices.


The `getInventoryVariants()` function returns a Promise that resolves to the specified inventory variant information.

import { inventory } from 'wix-stores.v2';

async function getInventoryVariants(inventoryId, options) {
  try {
    const result = await inventory.getInventoryVariants(inventoryId, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getInventoryVariants example for dashboard page code

import { inventory } from 'wix-stores.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedGetInventoryVariants = elevate(inventory.getInventoryVariants);

export const getInventoryVariants = webMethod(
  Permissions.Anyone,
  async (inventoryId, options) => {
    try {
      const result = await elevatedGetInventoryVariants(inventoryId, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


getInventoryVariants example for exporting from backend code

getInventoryVariants

GetInventoryVariantsResponse

incrementData

IncrementInventoryOptions

Adds a set number of items to inventory.


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

import { inventory } from 'wix-stores.v2';

async function incrementInventory(incrementData, options) {
  try {
    const result = await inventory.incrementInventory(incrementData, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


incrementInventory example for dashboard page code

import { inventory } from 'wix-stores.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedIncrementInventory = elevate(inventory.incrementInventory);

export const incrementInventory = webMethod(
  Permissions.Anyone,
  async (incrementData, options) => {
    try {
      const result = await elevatedIncrementInventory(incrementData, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


incrementInventory example for exporting from backend code

incrementInventory

productId

inventoryItem

UpdateInventoryVariantsInventoryItem

UpdateInventoryVariantsOptions

Updates product inventory, including total quantity, whether the product is in stock, and whether the product inventory is tracked.


The `updateInventoryVariants()` function is a Promise that resolves to the updated inventory variant data.

import { inventory } from 'wix-stores.v2';

async function updateInventoryVariants(productId, inventoryItem, options) {
  try {
    const result = await inventory.updateInventoryVariants(productId, inventoryItem, options);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


updateInventoryVariants example for dashboard page code

import { inventory } from 'wix-stores.v2';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedUpdateInventoryVariants = elevate(inventory.updateInventoryVariants);

export const updateInventoryVariants = webMethod(
  Permissions.Anyone,
  async (productId, inventoryItem, options) => {
    try {
      const result = await elevatedUpdateInventoryVariants(productId, inventoryItem, options);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


updateInventoryVariants example for exporting from backend code

updateInventoryVariants

---
title: Introduction
---

# Introduction

&nbsp;

<div style="background-color: #FEF1D1; padding: 18px 24px; border-radius: 6px; border: 1px solid #FDB10C; box-sizing: border-box; display: inline-block">
 Developer Preview
 
 APIs in <a href="https://www.wix.com/velo/reference/api-overview/developer-preview">Developer Preview</a> are subject to change and are not intended for use in production. <a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.
</div>

&nbsp;

This service allows you to query and modify the inventory for your store's products.

## Terminology
* **Item:** a product from the catalog.
* **Variant:** a product variant. The inventory is managed per variant.

A variant can override the following values from the parent product:
* Price
* SKU
* Weight
* Inventory

## Permissions information

Functions in the Inventory API are restricted and only run if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function.

<blockquote class='warning'>
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
</blockquote>

## Events

Inventory API events are fired on your site’s backend when certain events occur with Inventory.
See [`wix-stores-backend` events](https://www.wix.com/velo/reference/wix-stores-backend/events)
for more information related to these events.


To use the Inventory API,
import `inventory` from wix-stores.v2:

```js
import { inventory } from 'wix-stores.v2';
```

velo-deps_wix-stores.v2_inventory

BulkUpdateInventoryItemsOptions

trackInventory

boolean

BulkUpdateInventoryVariantsOptions

decrementBy

incrementBy

setInStock

setQuantity

DecrementData

number

Whether the request to decrement the item's inventory was made as part of a purchase that includes preorder items.
If true and the item is available for preorder, we allow negative inventory.
If false and the item is not available for preorder, we allow regular buy flow (no negative inventory).

preorderRequest

variantId

Variant IDs to query for this inventory item (optional).

variantIds

InventoryItemV2

IncrementData

lastUpdated

Inventory’s unique numeric ID (assigned in ascending order).
Primarily for sorting and filtering when crawling all inventories.

numericId

preorderInfo

PreorderInfo

trackQuantity

Variants associated with this inventory item.

variants

InventoryVariantV2

Whether the variant is available for preorder. When `true`, the variant is out of stock and preorder is enabled on inventory level.

availableForPreorder

Whether the product is listed as in stock.

inStock

quantity

Paging

limit

Number of items to skip in the display (relevant for all pages after the first)

offset

PagingMetadata

items

Whether the item is available for preorder.

enabled

Number of products that can be preordered after stock reaches zero.

A message the buyer will see when the item is out of stock and preorder is enabled.

decrementInventory( )