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)

Retrieves back in stock request settings.

import { backInStockSettings } from '@wix/ecom';

async function getSettings() {
  const response = await backInStockSettings.getSettings();
};

getSettings: Wix-hosted

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

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


async function getSettings() {
  const response = await myWixClient.backInStockSettings.getSettings();
};

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).

getSettings: Self-hosted

getSettings

GetSettingsResponse

ID of the app to start accepting notification requests for.

appId

string

Sets `settings.collectionStates.collectingRequests` to `true` for given `appId`.

When the collection state is set to `true`, collecting requests is enabled and customers may request
notifications for out of stock products. While collecting is enabled, customers see a "Notify When Available"
button on out-of-stock items. Customers can click the button to enter their email address, which creates the
notification request.

import { backInStockSettings } from '@wix/ecom';

async function startCollectingRequests(appId) {
  const response = await backInStockSettings.startCollectingRequests(appId);
};

startCollectingRequests: Wix-hosted

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

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


async function startCollectingRequests(appId) {
  const response = await myWixClient.backInStockSettings.startCollectingRequests(appId);
};

startCollectingRequests: Self-hosted

startCollectingRequests

Manage Stores - all permissions

StartCollectingRequestsResponse

ID of the app to stop accepting notification requests for.

Sets `settings.collectionStates.collectingRequests` to `false` for given `appId`.

When the collection state is set to `false`, collecting notification requests is disabled.

import { backInStockSettings } from '@wix/ecom';

async function stopCollectingRequests(appId) {
  const response = await backInStockSettings.stopCollectingRequests(appId);
};

stopCollectingRequests: Wix-hosted

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

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


async function stopCollectingRequests(appId) {
  const response = await myWixClient.backInStockSettings.stopCollectingRequests(appId);
};

stopCollectingRequests: Self-hosted

stopCollectingRequests

StopCollectingRequestsResponse

---
title: Introduction
---

# Introduction

The Back In Stock Settings API allows you to manage whether or not to collect requests from customers to receive back in stock notifications. 

Learn more about [back in stock notification settings](https://support.wix.com/en/article/wix-stores-notifying-customers-when-products-are-back-in-stock#collecting-customer-requests).

## Before you begin

It’s important to note the following points before starting to code:
+ To start collecting back in stock requests, the `collectionStates` must be set to `true`. Use [`startCollectingRequests()`](https://dev.wix.com/docs/sdk/api-reference/ecom/back-in-stock-settings/start-collecting-requests) to update collection states.
+ [Customize the design of the notification email](https://support.wix.com/en/article/wix-stores-notifying-customers-when-products-are-back-in-stock#customizing-the-notification-email) that will be sent.

## Terminology

+ **Collection state:** The collection state determines whether the selected app is actively collecting requests for back in stock notifications. When the collection state is set to `true``, collecting requests is enabled and customers may request notifications for out of stock products.


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

or

```console
yarn add @wix/ecom
```

Then import `{ backInStockSettings }` from `@wix/ecom`:

```js
import { backInStockSettings } from '@wix/ecom'
```
  

ecom_back-in-stock-settings

BackInStockCollectionState

ID of the app to receive notification requests for.

Whether to collect requests for items from this app.

collectingRequests

boolean

BackInStockSettings

Information about collecting customer requests to receive
back in stock notifications.

collectionStates

Retrieved back in stock request settings.