Back In Stock Notification Request Object


The back in stock notification request allows a customer to receive a notification when a specific item is available again. The request includes information about the person making the request, the item they want to receive a notification for, and the status of the notification.

Properties
idstringRead-onlyformat GUID

Notification request ID.


catalogReferenceCatalogReference

Catalog and item reference that the notification request is for.

Includes IDs for the catalog and item it came from, as well as additional, optional information.

Back in stock notifications only work for Wix Stores. The appId for Wix Stores is "215238eb-22a5-4c36-9e7b-e7c08025e04e".


emailstringformat EMAIL

Email address to send notification to about item being back in stock.


contactIdstringRead-onlyformat GUID

Contact ID for the contact with this email.

If a contact does not already exist with the email address submitted when creating this notification request, then a new contact is created. For more information about contacts, see the Contacts API.


statusstringRead-only

Status of the notification.

status is set to RECEIVED when the notification request is created. The status changes once a notification email is sent for this request object:

  • When a notification email is sent through the site, either automatically or with the Report Items Back In Stock method, then the status is briefly set to PROCESSING and then set to NOTIFICATION_SENT if the email is successful, and FAILED if it fails.
  • When a notification email is sent offline, use the Mark As Notification Sent method to set status to NOTIFICATION_SENT.

autoNotifiedbooleanRead-only

Whether a notification was sent automatically.

autoNotified is empty when the notification request is created and is not returned until the field has a value. autoNotified receives a value when a notification email is sent for this request object.

autoNotified sets to TRUE if the notification is sent through the site, either automatically or with the Report Items Back In Stock method. If the notification email is sent offline but the status is updated with the Mark As Notification Sent method, then autoNotified sets to FALSE.


createdDatestringRead-onlyformat date-time

Date and time the notification request was created.


itemUrlstringformat WEB_URL

Item URL for this notification request.

Did this help?
OSZAR »