POST

Report Items Back In Stock


Sends notifications for back in stock requests.

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

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

  1. For a specific item, with the catalogReference information.
  2. 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.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Stores - all permissions
Manage Stores
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/back-in-stock-service/v1/back-in-stock-notification-requests/report-items-back-in-stock

Errors
400Invalid Argument

There are 2 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?