> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# Resource: Back In Stock Notifications

# Type: Back In Stock Notification Request Object

# Link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/other-services/back-in-stock/back-in-stock-notifications/back-in-stock-notification-request-object.md

## Description: 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.

## Schema:

```json
 Type: Back In Stock Notification Request Object | type: BackInStockNotificationRequest
 Description: 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.
       - name: id  | type: string | description: Notification request ID.
           - name: value  | type: string | description: 
       - name: catalogReference  | type: CatalogReference | description: 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](https://support.wix.com/en/article/wix-stores-about-wix-stores). The `appId` for Wix Stores is `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`.
           - name: catalogItemId  | type: string | description: ID of the item within the catalog it belongs to.
           - name: appId  | type: string | description: ID of the app providing the catalog.  You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).  For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
           - name: options  | type: Struct | description: Additional item details in `key:value` pairs.  Use this optional field for more specificity with item selection. The values of the `options` field differ depending on which catalog is providing the items.  For Wix Stores products, learn more about integrating with [Catalog V3](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v3/e-commerce-integration.md) or [Catalog V1](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-v1/catalog/e-commerce-integration.md), depending on [the version the site uses](https://dev.wix.com/docs/api-reference/business-solutions/stores/catalog-versioning/introduction.md).
               - name: fields  | type: object | description: 
       - name: email  | type: string | description: Email address to send notification to about item being back in stock.
       - name: contactId  | type: string | description: 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.
       - name: status  | type: string | description: 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`.
           enum: UNSPECIFIED, RECEIVED, PROCESSING, NOTIFICATION_SENT, FAILED
       - name: autoNotified  | type: boolean | description: 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`.
           - name: value  | type: boolean | description: 
       - name: createdDate  | type: string | description: Date and time the notification request was created.
           - name: seconds  | type: string | description: 
           - name: nanos  | type: number | description: 
       - name: itemUrl  | type: string | description: Item URL for this notification request.

```