Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

Retrieves back in stock request settings.

import { backInStockSettings } from 'wix-ecom-backend';

async function getSettings() {
  try {
    const result = await backInStockSettings.getSettings();
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


getSettings example

import { backInStockSettings } from 'wix-ecom-backend';
import { webMethod, Permissions } from 'wix-web-module';

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


getSettings example for exporting from backend code

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

async function startCollectingRequests(appId) {
  try {
    const result = await backInStockSettings.startCollectingRequests(appId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


startCollectingRequests example for dashboard page code

import { backInStockSettings } from 'wix-ecom-backend';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedStartCollectingRequests = elevate(backInStockSettings.startCollectingRequests);

export const startCollectingRequests = webMethod(
  Permissions.Anyone,
  async (appId) => {
    try {
      const result = await elevatedStartCollectingRequests(appId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


startCollectingRequests example for exporting from backend code

startCollectingRequests

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

async function stopCollectingRequests(appId) {
  try {
    const result = await backInStockSettings.stopCollectingRequests(appId);
    return result;
  } catch (error) {
    console.error(error);
    // Handle the error
  }
}


stopCollectingRequests example for dashboard page code

import { backInStockSettings } from 'wix-ecom-backend';
import { webMethod, Permissions } from 'wix-web-module';
import { elevate } from 'wix-auth';

const elevatedStopCollectingRequests = elevate(backInStockSettings.stopCollectingRequests);

export const stopCollectingRequests = webMethod(
  Permissions.Anyone,
  async (appId) => {
    try {
      const result = await elevatedStopCollectingRequests(appId);
      return result;
    } catch (error) {
      console.error(error);
      // Handle the error
    }
  }
);


stopCollectingRequests example for exporting from backend code

stopCollectingRequests

StopCollectingRequestsResponse

---
title: Introduction
---

# Introduction

<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;
> **Note:** This module is
> [universal](/api-overview/api-versions#universal-modules).
> Functions in this module can run on both the backend and frontend,
> unless specified otherwise.

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

To use the Back In Stock Settings API, import { backInStockSettings } from the ‘wix-ecom-backend’ module:
``` javascript 
import { backInStockSettings } from `wix-ecom-backend`;
```

## 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()`](/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.

## Permissions information
The following functions in Back In Stock Settings 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:

+ [`startCollectingRequests()`](/back-in-stock-settings/start-collecting-requests)
+ [`stopCollectingRequests()`](/back-in-stock-settings/stop-collecting-requests)

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

velo-deps_wix-ecom-backend_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.

getSettings( )