> 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 # GetBackInStockNotificationRequestsCountByCatalogReferences # Package: backInStock # Namespace: BackInStockNotificationRequestService # Method link: https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/other-services/back-in-stock/back-in-stock-notifications/get-back-in-stock-notification-requests-count-by-catalog-references.md ## Permission Scopes: Manage Stores - all permissions: SCOPE.DC-STORES-MEGA.MANAGE-STORES ## Introduction Retrieves the amount of back in stock requests for a given `catalogReference` item. --- ## REST API ### Schema ``` Method: getBackInStockNotificationRequestsCountByCatalogReferences Description: Retrieves the amount of back in stock requests for a given `catalogReference` item. URL: https://www.wixapis.com/v1/back-in-stock-notification-requests/count-by-catalog-reference Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: catalogReferences Method parameters: query param name: catalogReferences | type: array | description: `catalogReference` items to retrieve the notification request for. | required: true - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to. - name: appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID 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: object | 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). Return type: GetBackInStockNotificationRequestsCountByCatalogReferencesResponse - name: countsPerCatalogReference | type: array | description: Amount of back in stock notifications for each of the retrieved `catalogReference` items. - name: catalogReference | type: CatalogReference | description: Catalog and item reference. Includes GUIDs and additional, optional information related to the item. - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to. - name: appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID 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: object | 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: count | type: integer | description: The number of unique back in stock requests for given `catalogReference`. ``` ### Examples ### Count back in stock notification requests by catalog reference ```curl curl -X GET \ 'https://www.wixapis.com/back-in-stock-service/v1/back-in-stock-notification-requests/count-by-catalog-reference' \ -d '{ "catalogReferences": [ { "catalogItemId": "7424be76-d458-48bf-8ea6-76b71872979e", "appId": "1380b703-ce81-ff05-f115-39571d94dfcd", "options": { "variantId": "8e7dd8e3-9903-42cd-a5e2-edb821c4694c" } }, { "catalogItemId": "0b855151-79f7-4efb-a7a7-6d2709b890ec", "appId": "1380b703-ce81-ff05-f115-39571d94dfcd", "options": {} } ] }' \ -H 'Content-type: application/json' \ -H 'Authorization: ' ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.backInStock.BackInStockNotificationRequestService.getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences) Description: Retrieves the amount of back in stock requests for a given `catalogReference` item. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: catalogReferences Method parameters: param name: catalogReferences | type: array | description: `catalogReference` items to retrieve the notification request for. | required: true - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to. - name: appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID 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: object | 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). Return type: PROMISE - name: countsPerCatalogReference | type: array | description: Amount of back in stock notifications for each of the retrieved `catalogReference` items. - name: catalogReference | type: CatalogReference | description: Catalog and item reference. Includes GUIDs and additional, optional information related to the item. - name: catalogItemId | type: string | description: GUID of the item within the catalog it belongs to. - name: appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID 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: object | 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: count | type: integer | description: The number of unique back in stock requests for given `catalogReference`. ``` ### Examples ### getBackInStockNotificationRequestsCountByCatalogReferences ```javascript import { backInStockNotifications } from '@wix/ecom'; async function getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences) { const response = await backInStockNotifications.getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences); }; ``` ### getBackInStockNotificationRequestsCountByCatalogReferences (with elevated permissions) ```javascript import { backInStockNotifications } from '@wix/ecom'; import { auth } from '@wix/essentials'; async function myGetBackInStockNotificationRequestsCountByCatalogReferencesMethod(catalogReferences) { const elevatedGetBackInStockNotificationRequestsCountByCatalogReferences = auth.elevate(backInStockNotifications.getBackInStockNotificationRequestsCountByCatalogReferences); const response = await elevatedGetBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences); } ``` ### getBackInStockNotificationRequestsCountByCatalogReferences (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { backInStockNotifications } from '@wix/ecom'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { backInStockNotifications }, // Include the auth strategy and host as relevant }); async function getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences) { const response = await myWixClient.backInStockNotifications.getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences); }; ``` ---