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

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';

async function decrementInventory(decrementData, options) {
  const response = await inventory.decrementInventory(decrementData, options);
};

decrementInventory: Wix-hosted

import { createClient } from '@wix/sdk';
import { inventory } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { inventory },
  // Include the auth strategy and host as relevant
});


async function decrementInventory(decrementData, options) {
  const response = await myWixClient.inventory.decrementInventory(decrementData, options);
};

Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client).

decrementInventory: Self-hosted

decrementInventory

Manage Stores - all permissions

Manage Products

void

inventoryId

string

options

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';

async function getInventoryVariants(inventoryId, options) {
  const response = await inventory.getInventoryVariants(inventoryId, options);
};

getInventoryVariants: Wix-hosted

import { createClient } from '@wix/sdk';
import { inventory } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { inventory },
  // Include the auth strategy and host as relevant
});


async function getInventoryVariants(inventoryId, options) {
  const response = await myWixClient.inventory.getInventoryVariants(inventoryId, options);
};

getInventoryVariants: Self-hosted

getInventoryVariants

Read Stores - all read permissions

Read Products

GetInventoryVariantsResponse

incrementData

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';

async function incrementInventory(incrementData, options) {
  const response = await inventory.incrementInventory(incrementData, options);
};

incrementInventory: Wix-hosted

import { createClient } from '@wix/sdk';
import { inventory } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { inventory },
  // Include the auth strategy and host as relevant
});


async function incrementInventory(incrementData, options) {
  const response = await myWixClient.inventory.incrementInventory(incrementData, options);
};

incrementInventory: Self-hosted

incrementInventory

QueryInventoryOptions

Returns a list of inventory items, given the provided paging, sorting and filtering.

import { inventory } from '@wix/stores';

async function queryInventory(options) {
  const response = await inventory.queryInventory(options);
};

queryInventory: Wix-hosted

import { createClient } from '@wix/sdk';
import { inventory } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { inventory },
  // Include the auth strategy and host as relevant
});


async function queryInventory(options) {
  const response = await myWixClient.inventory.queryInventory(options);
};

queryInventory: Self-hosted

queryInventory

QueryInventoryResponse

productId

inventoryItem

UpdateInventoryVariantsInventoryItem

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';

async function updateInventoryVariants(productId, inventoryItem, options) {
  const response = await inventory.updateInventoryVariants(productId, inventoryItem, options);
};

updateInventoryVariants: Wix-hosted

import { createClient } from '@wix/sdk';
import { inventory } from '@wix/stores';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { inventory },
  // Include the auth strategy and host as relevant
});


async function updateInventoryVariants(productId, inventoryItem, options) {
  const response = await myWixClient.inventory.updateInventoryVariants(productId, inventoryItem, options);
};

updateInventoryVariants: Self-hosted

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">
    <b>Developer Preview</b>
    <br/>
    <span>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.<br/><a href="mailto:velo-preview-feedback@wix.com">Send us</a> your suggestions for improving this API. Your feedback is valuable to us.</span>
</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




To use the Inventory API, install the `@wix/stores` package using npm or Yarn:
  ```console
npm install @wix/stores
```

or

```console
yarn add @wix/stores
```

Then import `{ inventory }` from `@wix/stores`:

```js
import { inventory } from '@wix/stores'
```
  

stores_inventory

BaseEventMetadata

eventType

The identification type and identity data.

identity

IdentificationData

instanceId

ChangedInventoryVariant

newValue

ChangedInventoryVariantData

oldValue

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

availableForPreorder

boolean

inStock

quantity

number

DecrementData

decrementBy

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

ID of a site visitor that has not logged in to the site.

anonymousVisitorId

appId

ID of a site visitor that has logged in to the site.

memberId

ID of a Wix user (site owner, contributor, etc.).

wixUserId

identityType

WebhookIdentityType

IncrementData

incrementBy

InventoryItemChanged

Date and time the inventory item was last updated.

_updatedDate

inventoryItemId

preorderInfo

PreorderInfo

trackInventory

InventoryItemChangedEnvelope

data

metadata

lastUpdated

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

numericId

trackQuantity

Variants associated with this inventory item.

variants

InventoryVariantV2

Whether the product is listed as in stock.

InventoryVariantsChanged

Date and time the inventory variant item was last updated.

InventoryVariantsChangedEnvelope

OnInventoryItemChangedHandler

event

OnInventoryVariantsChangedHandler

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.

message

Query

filter

Paging options to limit and skip the number of items.

paging

sort

Information about paging, filters, sorting.

query

inventoryItems

totalResults

handler

Triggered when an inventory item is changed.

import { inventory } from '@wix/stores';

inventory.onInventoryItemChanged((event) => {
    // handle your event here
});

onInventoryItemChanged: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { inventory } from '@wix/stores';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      inventory,
    },
});

wixClient.inventory.onInventoryItemChanged((event) => {
    // handle your event here
});

onInventoryItemChanged: Self-hosted

onInventoryItemChanged

Triggered when inventory variants are changed.

import { inventory } from '@wix/stores';

inventory.onInventoryVariantsChanged((event) => {
    // handle your event here
});

onInventoryVariantsChanged: Wix-hosted

import { createClient, AppStrategy } from '@wix/sdk';
import { inventory } from '@wix/stores';

const wixClient = createClient({
  auth: AppStrategy({
    appId: 'MY-APP-ID',
    publicKey: 'YOUR_APP_PUBLIC_KEY',
   }),
   modules: {
      inventory,
    },
});

wixClient.inventory.onInventoryVariantsChanged((event) => {
    // handle your event here
});

queryInventory( )