reportItemsBackInStock( )

Developer Preview

Sends notifications for back in stock requests.

Description

Important: Automations must be turned on in a site's dashboard for notifications to send.

This endpoint triggers notifications for requests in 1 of 2 ways:

For a specific item, with the catalogReference information.
For specific requests, with requestIds.

itemDetails are required and may populate dynamic values in the notification template, as follows:

itemDetails.name passes to the template as item.name
itemDetails.price passes to the template as item.price
itemDetails.image.url passes to the template as item.image.url

If the notification template doesn't include item.price, item.name, or item.image.url, values should be passed in extraAutomationTemplateParameters.

After this endpoint is called, the status for the request will update to NOTIFICATION_SENT if it sends successfully, or to FAILED if it fails to send.

Admin Method

This function requires elevated permissions to run. This function is not universal and runs only on the backend.

Authorization

Request

This endpoint does not take any parameters

Response Object

Returns an empty object.

Status/Error Codes

Was this helpful?

reportItemsBackInStock example

Copy Code

1import { backInStockNotifications } from 'wix-ecom-backend';
2  
3 async function reportItemsBackInStock(itemDetails, options) {
4   try {
5     const result = await backInStockNotifications.reportItemsBackInStock(itemDetails, options);
6
7     return result;
8   } catch (error) {
9     console.error(error);
10     // Handle the error
11   }
12 }
13