{"id":"291f3b50-1df2-4289-b6d8-bbdb4af56a99","createdDate":"2024-06-10T10:26:27.467Z","updatedDate":"2024-06-10T10:26:27.467Z","resourceId":"72b8e585-ba44-4b5a-beb8-a76e1d6e8038","sdk":{"schema":{"name":"velo-deps_wix-ecom-backend_back-in-stock-notifications","fqn":"","slug":"velo-deps-wix-ecom-backend-back-in-stock-notifications","typesMap":{"BackInStockNotificationRequest":{"name":"BackInStockNotificationRequest","fqn":"BackInStockNotificationRequest","slug":"back-in-stock-notification-request","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the notification request was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Request ID."},{"name":"autoNotified","slug":"auto-notified","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether a notification was sent automatically.\n\n`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.\n\n`autoNotified` sets to `true` if the notification is sent through the site, either automatically or with the `reportItemsBackInStock()` function. If the notification email is sent offline but the `status` is updated with the `markAsNotificationSent()` function, then `autoNotified` sets to `false`."},{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"CatalogReference"},"description":"Catalog and item reference that the notification request is for.\n\nIncludes IDs for the catalog and item it came from, as well as additional, optional information."},{"name":"contactId","slug":"contact-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID for the contact with this `email`.\n\nIf a contact does not already exist with the email address submitted when creating this request, then a new contact is created.\nFor more information about contacts, see the Contacts API."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email address to send notification to about item being back in stock."},{"name":"itemUrl","slug":"item-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item URL for this request."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"Status"},"description":"Status of the notification.\n\n`status` is set to `RECEIVED` when the notification request is created. The `status` changes once a notification email is sent for this request object:\n+ When a notification email is sent through the site, either automatically or with the `reportItemsBackInStock()` function, then the `status` is briefly set to `PROCESSING` and then set to `NOTIFICATION_SENT` if the email is successul, and `FAILED` if it fails.\n+ When a notification email is sent offline, use the `markAsNotificationSent()` function to set `status` to `NOTIFICATION_SENT`."}]},"CatalogReference":{"name":"CatalogReference","fqn":"CatalogReference","slug":"catalog-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`"},{"name":"catalogItemId","slug":"catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the item within the catalog it belongs to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)."}]},"Status":{"name":"Status","fqn":"Status","slug":"status","actions":[],"enumValues":["FAILED","NOTIFICATION_SENT","PROCESSING","RECEIVED","UNSPECIFIED"],"properties":[]},"BackInStockItemDetails":{"name":"BackInStockItemDetails","fqn":"BackInStockItemDetails","slug":"back-in-stock-item-details","actions":[],"properties":[{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item image."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item name."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item price."}]},"GetBackInStockNotificationRequestsCountByCatalogReferencesResponse":{"name":"GetBackInStockNotificationRequestsCountByCatalogReferencesResponse","fqn":"GetBackInStockNotificationRequestsCountByCatalogReferencesResponse","slug":"get-back-in-stock-notification-requests-count-by-catalog-references-response","actions":[],"properties":[{"name":"countsPerCatalogReference","slug":"counts-per-catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BackInStockNotificationRequestsCount","referenceFqn":"BackInStockNotificationRequestsCount"}},"description":"Amount of back in stock notifications for each of the retrieved `catalogReference` items."}]},"BackInStockNotificationRequestsCount":{"name":"BackInStockNotificationRequestsCount","fqn":"BackInStockNotificationRequestsCount","slug":"back-in-stock-notification-requests-count","actions":[],"properties":[{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"CatalogReference"},"description":"Catalog and item reference.\n\nIncludes IDs and additional, optional information related to the item."},{"name":"count","slug":"count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of unique back in stock requests for given `catalogReference`."}]},"MarkAsNotificationSentResponse":{"name":"MarkAsNotificationSentResponse","fqn":"MarkAsNotificationSentResponse","slug":"mark-as-notification-sent-response","actions":[],"properties":[{"name":"request","slug":"request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockNotificationRequest","referenceFqn":"BackInStockNotificationRequest"},"description":"Marked back in stock notification request."}]},"RequestsQueryBuilder":{"name":"RequestsQueryBuilder","fqn":"RequestsQueryBuilder","slug":"requests-query-builder","actions":[{"name":"ascending","fqn":"RequestsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query =\n backInStockNotifications.queryBackInStockNotificationRequests.ascending(\n '_id'\n );\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .ascending('_id')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\n\nThe `ascending()` function refines a `RequestsQueryBuilder` to sort by the value of `propertyName` in ascending order.\nYou can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"descending","fqn":"RequestsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query =\n backInStockNotifications.queryBackInStockNotificationRequests.descending(\n '_id'\n );\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .descending('_id')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\n\nThe `descending()` function refines a `RequestsQueryBuilder` to sort by the value of `propertyName` in descending order.\nYou can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"eq","fqn":"RequestsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = backInStockNotifications.queryBackInStockNotificationRequests.eq(\n '_id',\n 'some-id'\n);\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property equals the specified value.\n\nThe `eq()` function refines a `RequestsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"exists","fqn":"RequestsQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query =\n backInStockNotifications.queryBackInStockNotificationRequests.exists(\n 'description',\n 'some-description'\n );\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .exists('description', 'some-description')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}],"description":"Refines a query to match items where the specified property contains a value.\n\nThe `exists()` function refines a `RequestsQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolen parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned."},{"name":"find","fqn":"RequestsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"RequestsQueryResult","referenceFqn":"RequestsQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query =\n backInStockNotifications.queryBackInStockNotificationRequests.find();\n"},{"title":"Perform a `find` on a query","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"description":"Returns the query results.\n\nThe `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid."},{"name":"ge","fqn":"RequestsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = backInStockNotifications.queryBackInStockNotificationRequests.ge(\n '_createdDate',\n '2021-03-01'\n);\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .ge('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than or equal to the specified value.\n\nThe `ge()` function refines a `RequestsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`.\n`ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`."},{"name":"gt","fqn":"RequestsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = backInStockNotifications.queryBackInStockNotificationRequests.gt(\n '_createdDate',\n '2021-03-01'\n);\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .gt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than the specified value.\n\nThe `gt()` function refines a `RequestsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`.\n`gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`."},{"name":"hasSome","fqn":"RequestsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add a `hasSome` filter to a query","content":"const query =\n backInStockNotifications.queryBackInStockNotificationRequests.hasSome(\n 'labelIds',\n ['red', 'blue', 'purple']\n );\n"},{"title":"Create a query, add a `hasSome` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .hasSome('labelIds', ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `values`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}}}],"description":"Refines a query to match items whose specified property contains any of the specified values.\n\nThe `hasSome()` function refines a `RequestsQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.\nMatching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values."},{"name":"in","fqn":"RequestsQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = backInStockNotifications.queryBackInStockNotificationRequests.in(\n ['labelIds', 'colors'],\n ['red', 'blue', 'purple']\n);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"}}],"description":"Refines a query to only match items where the specified property conatins any of the values in the provided array of values.\n\nThe `in()` function refines a `RequestsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"le","fqn":"RequestsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = backInStockNotifications.queryBackInStockNotificationRequests.le(\n '_createdDate',\n '2021-03-01'\n);\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .le('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than or equal to the specified value.\n\nThe `le()` function refines a `RequestsQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`."},{"name":"limit","fqn":"RequestsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query =\n backInStockNotifications.queryBackInStockNotificationRequests.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .limit(10)\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `limit` to a query","content":"const query =\n backInStockNotifications.queryBackInStockNotificationRequests.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .limit(10)\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return, which is also the `pageSize` of the results object."}],"description":"Limits the number of items the query returns.\n\nThe `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result."},{"name":"lt","fqn":"RequestsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = backInStockNotifications.queryBackInStockNotificationRequests.lt(\n '_createdDate',\n '2021-03-01'\n);\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .lt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than the specified value.\n\nThe `le()` function refines a `RequestsQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`."},{"name":"ne","fqn":"RequestsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = backInStockNotifications.queryBackInStockNotificationRequests.ne(\n '_id',\n 'bb19b637-74ce-55d3-ae32-430b588051da'\n);\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property doesn't equal the specified value.\n\nThe `ne()` function refines a `RequestsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"skipTo","fqn":"RequestsQueryBuilder.skipTo","slug":"skip-to","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Perform a query and skip to the next cursor","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n const nextCursor = results.cursors.next;\n return backInStockNotifications\n .queryBackInStockNotificationRequests()\n .skipTo(nextCursor)\n .find();\n}\n"},{"title":"Perform a query and skip to the previous cursor","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n const prevCursor = results.cursors.prev;\n return backInStockNotifications\n .queryBackInStockNotificationRequests()\n .skipTo(prevCursor)\n .find();\n}\n"}],"actionParams":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A pointer to specific record"}],"description":"Refines a query that skips to a specific record.\n\nThe `skipTo()` function refines a `RequestsQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.\n \nWhen using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed."},{"name":"startsWith","fqn":"RequestsQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"Add a `startsWith` filter to a query","content":"const query =\n backInStockNotifications.queryBackInStockNotificationRequests.startsWith(\n '_id',\n 'L'\n );\n"},{"title":"Create a query, add a `startsWith` filter, and run it","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results =\n await backInStockNotifications.queryBackInStockNotificationRequests();\n startsWith('_id', 'L').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `string`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}],"description":"Refines a query to match items where the specified property starts with the specified value.\n\nThe `startsWith()` function refines a `RequestsQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.\nMatching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.\nYou can only use `startsWith()` with a property whose value is a string."}],"properties":[]},"RequestsQueryResult":{"name":"RequestsQueryResult","fqn":"RequestsQueryResult","slug":"requests-query-result","actions":[{"name":"hasNext","fqn":"RequestsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has more results","content":"const hasNext = results.hasNext();\n"},{"title":"Perform a query and get `hasNext` from the result","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n return results.hasNext();\n}\n"}],"description":"Indicates whether the query has more results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `backInStockNotifications` to navigate the pages of a query result."},{"name":"hasPrev","fqn":"RequestsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has previous results","content":"const hasPrev = results.hasPrev();\n"},{"title":"Perform a query and get `hasPrev` from the result","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n return results.hasPrev();\n}\n"}],"description":"Indicates whether the query has previous results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `backInStockNotifications` to navigate the pages of a query result."},{"name":"next","fqn":"RequestsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"RequestsQueryResult","referenceFqn":"RequestsQueryResult"}},"examples":[{"title":"Get `next` from a query result","content":"const nextPage = results.next();\n"},{"title":"Perform a query and get `next` from the result","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .limit(1000)\n .find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\n\nThe `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](wix-ecom-backend.Requests.RequestsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `backInStockNotifications` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `RequestsQueryBuilder` may change."},{"name":"prev","fqn":"RequestsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"RequestsQueryResult","referenceFqn":"RequestsQueryResult"}},"examples":[{"title":"Get `prev` from a query result","content":"const previousPage = results.prev();\n"},{"title":"Perform a query and get `prev` from the result","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n return results.prev();\n}\n"}],"description":"Retrieves the previous page of query results.\n\nThe `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](wix-ecom-backend.Requests.RequestsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `backInStockNotifications` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change."}],"properties":[{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's cursors","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n const cursors = results.cursors;\n}\n"}],"type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Returns the query cursors.\n\n`cursors` returns the query's `next` and `prev` cursors."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `items` from a query result","content":"const returnedItems = results.items;\n"},{"title":"Perform a query and get `items` from the result","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"BackInStockNotificationRequest","referenceFqn":"BackInStockNotificationRequest"}},"description":"Returns an array of `backInStockNotifications` items that match the query.\n\n`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](wix-ecom-backend.Requests.RequestsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `backInStockNotifications` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `length` from a query result","content":"const resultLength = results.length;\n"},{"title":"Perform a query and get `length` from the result","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n return results.length;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current page of results.\n\n`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).\nThe page size is defined by the [`limit()`](wix-ecom-backend.Requests.RequestsQueryBuilder#limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `backInStockNotifications` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's page size","content":"const requestedPageSize = results.pageSize;\n"},{"title":"Perform a query and get `pageSize` from the result","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n return results.pageSize;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the requested page size.\n\n`pageSize` returns the page size set in [`limit()`](wix-ecom-backend.Requests.RequestsQueryBuilder#limit) in `RequestsQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `query` that produced the current result","content":"const originalQuery = results.query;\n"},{"title":"Perform a query and get `query` from the result","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nexport async function myQueryFunction() {\n const results = await backInStockNotifications\n .queryBackInStockNotificationRequests()\n .find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"description":"Returns the `RequestsQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `RequestsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `RequestsQueryBuilder`."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor string pointing to the next page in the list of results."},{"name":"prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to the previous page in the list of results."}]},"ReportItemsBackInStockOptions":{"name":"ReportItemsBackInStockOptions","fqn":"ReportItemsBackInStockOptions","slug":"report-items-back-in-stock-options","actions":[],"properties":[{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"CatalogReference"},"description":"`catalogReference` item to send notifications for.\n\nCannot be used with `requestIds`."},{"name":"extraAutomationTemplateParameters","slug":"extra-automation-template-parameters","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"string"}},"description":"Additional key-value pairs to pass to the back in stock notification template."},{"name":"requestIds","slug":"request-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of requests to send notifications for.\n\nCannot be used with `catalogReference`."}]}},"actions":[{"name":"createBackInStockNotificationRequest","fqn":"createBackInStockNotificationRequest","slug":"create-back-in-stock-notification-request","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["itemDetails","itemDetails.name","itemDetails.price","request","request.catalogReference","request.catalogReference.appId","request.catalogReference.catalogItemId","request.email"],"permissions":["Manage Stores - all permissions"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES"],"applicableIdentities":["APP","MEMBER","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BackInStockNotificationRequest","referenceFqn":"BackInStockNotificationRequest"},"description":"Created back in stock notification request."},"examples":[{"title":"createBackInStockNotificationRequest example","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nasync function createBackInStockNotificationRequest(request, itemDetails) {\n try {\n const result = await backInStockNotifications.createBackInStockNotificationRequest(request, itemDetails);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"createBackInStockNotificationRequest example for exporting from backend code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\nimport { webMethod, Permissions } from 'wix-web-module';\n\nexport const createBackInStockNotificationRequest = webMethod(\n Permissions.Anyone,\n async (request, itemDetails) => {\n try {\n const result = await backInStockNotifications.createBackInStockNotificationRequest(request, itemDetails);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"request","slug":"request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockNotificationRequest","referenceFqn":"BackInStockNotificationRequest"},"description":"Notification request information.\n\nIncludes details for the out of stock item and the email address\nrequesting to be notified when it's back in stock."},{"name":"itemDetails","slug":"item-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockItemDetails","referenceFqn":"BackInStockItemDetails"},"description":"Item details to include in the notification when the item is back in stock."}],"description":"Creates a back in stock notification request.\n\nIf a notification request already exists for the same `catalogReference` and `email`,\nthen a new one isn't created and the existing request is returned."},{"name":"deleteBackInStockNotificationRequest","fqn":"deleteBackInStockNotificationRequest","slug":"delete-back-in-stock-notification-request","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["_id"],"permissions":["Manage Stores - all permissions"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"deleteBackInStockNotificationRequest example for dashboard page code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nasync function deleteBackInStockNotificationRequest(id) {\n try {\n const result = await backInStockNotifications.deleteBackInStockNotificationRequest(id);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"deleteBackInStockNotificationRequest example for exporting from backend code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteBackInStockNotificationRequest = elevate(backInStockNotifications.deleteBackInStockNotificationRequest);\n\nexport const deleteBackInStockNotificationRequest = webMethod(\n Permissions.Anyone,\n async (id) => {\n try {\n const result = await elevatedDeleteBackInStockNotificationRequest(id);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the notification request to delete."}],"description":"Deletes a back in stock notification request."},{"name":"getBackInStockNotificationRequest","fqn":"getBackInStockNotificationRequest","slug":"get-back-in-stock-notification-request","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["_id"],"permissions":["Manage Stores - all permissions"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"BackInStockNotificationRequest","referenceFqn":"BackInStockNotificationRequest"},"description":"Retrieved back in stock notification request."},"examples":[{"title":"getBackInStockNotificationRequest example for dashboard page code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nasync function getBackInStockNotificationRequest(id) {\n try {\n const result = await backInStockNotifications.getBackInStockNotificationRequest(id);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"getBackInStockNotificationRequest example for exporting from backend code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedGetBackInStockNotificationRequest = elevate(backInStockNotifications.getBackInStockNotificationRequest);\n\nexport const getBackInStockNotificationRequest = webMethod(\n Permissions.Anyone,\n async (id) => {\n try {\n const result = await elevatedGetBackInStockNotificationRequest(id);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the notification request to retrieve."}],"description":"Retrieves a back in stock notification request."},{"name":"getBackInStockNotificationRequestsCountByCatalogReferences","fqn":"getBackInStockNotificationRequestsCountByCatalogReferences","slug":"get-back-in-stock-notification-requests-count-by-catalog-references","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["catalogReferences"],"permissions":["Manage Stores - all permissions"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"GetBackInStockNotificationRequestsCountByCatalogReferencesResponse","referenceFqn":"GetBackInStockNotificationRequestsCountByCatalogReferencesResponse"}},"examples":[{"title":"getBackInStockNotificationRequestsCountByCatalogReferences example for dashboard page code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nasync function getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences) {\n try {\n const result = await backInStockNotifications.getBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"getBackInStockNotificationRequestsCountByCatalogReferences example for exporting from backend code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedGetBackInStockNotificationRequestsCountByCatalogReferences = elevate(backInStockNotifications.getBackInStockNotificationRequestsCountByCatalogReferences);\n\nexport const getBackInStockNotificationRequestsCountByCatalogReferences = webMethod(\n Permissions.Anyone,\n async (catalogReferences) => {\n try {\n const result = await elevatedGetBackInStockNotificationRequestsCountByCatalogReferences(catalogReferences);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"catalogReferences","slug":"catalog-references","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"CatalogReference"}},"description":"`catalogReference` items to retrieve the notification request for."}],"description":"Retrieves the amount of back in stock requests for a given `catalogReference` item."},{"name":"markAsNotificationSent","fqn":"markAsNotificationSent","slug":"mark-as-notification-sent","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["_id"],"permissions":["Manage Stores - all permissions"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"MarkAsNotificationSentResponse","referenceFqn":"MarkAsNotificationSentResponse"}},"examples":[{"title":"markAsNotificationSent example for dashboard page code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nasync function markAsNotificationSent(id) {\n try {\n const result = await backInStockNotifications.markAsNotificationSent(id);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"markAsNotificationSent example for exporting from backend code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedMarkAsNotificationSent = elevate(backInStockNotifications.markAsNotificationSent);\n\nexport const markAsNotificationSent = webMethod(\n Permissions.Anyone,\n async (id) => {\n try {\n const result = await elevatedMarkAsNotificationSent(id);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the notification request to mark."}],"description":"Sets `status` of a back in stock request to `NOTIFICATION_SENT`.\n\nUse this function if the notification is sent manually offline. If the notification is sent automatically or with the `reportItemsBackInStock()` function, then `status` updates on its own."},{"name":"queryBackInStockNotificationRequests","fqn":"queryBackInStockNotificationRequests","slug":"query-back-in-stock-notification-requests","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","permissions":["Manage Stores - all permissions"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},"examples":[{"title":"queryBackInStockNotificationRequests example for dashboard page code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nasync function queryBackInStockNotificationRequests() {\n const { items } = backInStockNotifications.queryBackInStockNotificationRequests().find();\n}\n"},{"title":"queryBackInStockNotificationRequests example for exporting from backend code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedQueryBackInStockNotificationRequests = elevate(backInStockNotifications.queryBackInStockNotificationRequests);\n\nexport const queryBackInStockNotificationRequests = webMethod(\n Permissions.Anyone,\n async (query) => {\n try {\n const result = await elevatedQueryBackInStockNotificationRequests(query);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"description":"Creates a query to retrieve a list of back in stock notification requests. \n\nThe `queryBackInStockNotificationRequests()` method builds a query to retrieve a list of back in stock notification requests and returns a `RequestsQueryBuilder` object. \n\nThe returned object contains the query definition, which is typically used to run the query using the `find()` method. \n\nYou can refine the query by chaining `RequestsQueryBuilder` methods onto the query. `RequestsQueryBuilder` methods enable you to sort, filter, and control the results that `queryBackInStockNotificationRequests()` returns. \n\nThe following `RequestsQueryBuilder` methods are supported for `queryBackInStockNotificationRequests()`. For a full description of the Requests object, see the object returned for the `items` property in `RequestsQueryResult`.\"\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/back-in-stock-notifications/requests-query-builder/eq),[`ne()`](/back-in-stock-notifications/requests-query-builder/ne),[`exists()`](/back-in-stock-notifications/requests-query-builder/exists),[`in()`](/back-in-stock-notifications/requests-query-builder/in),[`hasSome()`](/back-in-stock-notifications/requests-query-builder/has-some),[`startsWith()`](/back-in-stock-notifications/requests-query-builder/starts-with),[`ascending()`](/back-in-stock-notifications/requests-query-builder/ascending),[`descending()`](/back-in-stock-notifications/requests-query-builder/descending)|\n|`contactId`|[`eq()`](/back-in-stock-notifications/requests-query-builder/eq),[`ne()`](/back-in-stock-notifications/requests-query-builder/ne),[`exists()`](/back-in-stock-notifications/requests-query-builder/exists),[`in()`](/back-in-stock-notifications/requests-query-builder/in),[`hasSome()`](/back-in-stock-notifications/requests-query-builder/has-some),[`startsWith()`](/back-in-stock-notifications/requests-query-builder/starts-with),[`ascending()`](/back-in-stock-notifications/requests-query-builder/ascending),[`descending()`](/back-in-stock-notifications/requests-query-builder/descending)|\n|`status`|[`eq()`](/back-in-stock-notifications/requests-query-builder/eq),[`ne()`](/back-in-stock-notifications/requests-query-builder/ne),[`exists()`](/back-in-stock-notifications/requests-query-builder/exists),[`in()`](/back-in-stock-notifications/requests-query-builder/in),[`hasSome()`](/back-in-stock-notifications/requests-query-builder/has-some),[`ascending()`](/back-in-stock-notifications/requests-query-builder/ascending),[`descending()`](/back-in-stock-notifications/requests-query-builder/descending)|\n|`autoNotified`|[`eq()`](/back-in-stock-notifications/requests-query-builder/eq),[`ne()`](/back-in-stock-notifications/requests-query-builder/ne),[`exists()`](/back-in-stock-notifications/requests-query-builder/exists),[`in()`](/back-in-stock-notifications/requests-query-builder/in),[`hasSome()`](/back-in-stock-notifications/requests-query-builder/has-some),[`ascending()`](/back-in-stock-notifications/requests-query-builder/ascending),[`descending()`](/back-in-stock-notifications/requests-query-builder/descending)|\n|`_createdDate`|[`eq()`](/back-in-stock-notifications/requests-query-builder/eq),[`ne()`](/back-in-stock-notifications/requests-query-builder/ne),[`exists()`](/back-in-stock-notifications/requests-query-builder/exists),[`in()`](/back-in-stock-notifications/requests-query-builder/in),[`hasSome()`](/back-in-stock-notifications/requests-query-builder/has-some),[`lt()`](/back-in-stock-notifications/requests-query-builder/lt),[`le()`](/back-in-stock-notifications/requests-query-builder/le),[`gt()`](/back-in-stock-notifications/requests-query-builder/gt),[`ge()`](/back-in-stock-notifications/requests-query-builder/ge),[`ascending()`](/back-in-stock-notifications/requests-query-builder/ascending),[`descending()`](/back-in-stock-notifications/requests-query-builder/descending)|\n|`itemUrl`|[`eq()`](/back-in-stock-notifications/requests-query-builder/eq),[`ne()`](/back-in-stock-notifications/requests-query-builder/ne),[`exists()`](/back-in-stock-notifications/requests-query-builder/exists),[`in()`](/back-in-stock-notifications/requests-query-builder/in),[`hasSome()`](/back-in-stock-notifications/requests-query-builder/has-some),[`startsWith()`](/back-in-stock-notifications/requests-query-builder/starts-with),[`ascending()`](/back-in-stock-notifications/requests-query-builder/ascending),[`descending()`](/back-in-stock-notifications/requests-query-builder/descending)|"},{"name":"reportItemsBackInStock","fqn":"reportItemsBackInStock","slug":"report-items-back-in-stock","isDeprecated":false,"isInternal":false,"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["itemDetails","itemDetails.name","itemDetails.price"],"permissions":["Manage Stores - all permissions"],"permissionsScopesIds":["SCOPE.DC-STORES-MEGA.MANAGE-STORES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"reportItemsBackInStock example for dashboard page code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\n\nasync function reportItemsBackInStock(itemDetails, options) {\n try {\n const result = await backInStockNotifications.reportItemsBackInStock(itemDetails, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"reportItemsBackInStock example for exporting from backend code","content":"import { backInStockNotifications } from 'wix-ecom-backend';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedReportItemsBackInStock = elevate(backInStockNotifications.reportItemsBackInStock);\n\nexport const reportItemsBackInStock = webMethod(\n Permissions.Anyone,\n async (itemDetails, options) => {\n try {\n const result = await elevatedReportItemsBackInStock(itemDetails, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"itemDetails","slug":"item-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockItemDetails","referenceFqn":"BackInStockItemDetails"},"description":"Item details to use in notifications.\n\n`itemDetails` may populate dynamic valyes in the notification template, as follows:\n+ `itemDetails.name` passes to the template as `item.name`\n+ `itemDetails.price` passes to the template as `item.price`\n+ `itemDetails.image.url` passes to the template as `item.image.url`\n\nUse `extraAutomationTemplateParameters` to pass additional dynamic values."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ReportItemsBackInStockOptions","referenceFqn":"ReportItemsBackInStockOptions"},"description":"Report options."}],"description":"Sends notifications for back in stock requests.\n\n> **Important:**\n> Automations must be turned on in a [site's dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Go%20to%20Back-in-Stock&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/store/back-in-stock) for notifications to send.\n\nThis endpoint triggers notifications for requests in 1 of 2 ways:\n1. For a specific item, with the `catalogReference` information.\n2. For specific requests, with `requestIds`.\n\n`itemDetails` are required and may populate dynamic values in the notification template, as follows:\n+ `itemDetails.name` passes to the template as `item.name`\n+ `itemDetails.price` passes to the template as `item.price`\n+ `itemDetails.image.url` passes to the template as `item.image.url`\n\nIf the notification template doesn't include `item.price`, `item.name`, or `item.image.url`, values should\nbe passed in `extraAutomationTemplateParameters`.\n\nAfter this endpoint is called, the `status` for the request will update to `NOTIFICATION_SENT` if it sends\nsuccessfully, or to `FAILED` if it fails to send."}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# Introduction\n\n

\n Developer Preview\n
\n APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.\n

\n\n \n> **Note:** This module is\n> [universal](/api-overview/api-versions#universal-modules).\n> Functions in this module can run on both the backend and frontend,\n> unless specified otherwise. \n\nThe Back In Stock Notifications API allows you to manage customer requests to receive notifications when out-of-stock items become available. \n\nWith this API, you can:\n+ Increase sales and customer satisfaction with personalized notifications.\n+ Collect insights on requested items that are currently unavailable.\n+ Effectively manage inventory and adjust restocking strategy.\n\nLearn more about [notifying customers when products are back in stock](https://support.wix.com/en/article/wix-stores-notifying-customers-when-products-are-back-in-stock).\n\nTo use the Back In Stock Notifications API, import { backInStockNotifications } from the ‘wix-ecom-backend’ module:\n``` javascript \nimport { backInStockNotifications } from `wix-ecom-backend`;\n```\n\n## Before you begin\nIt’s important to note the following points before starting to code:\n+ To start collecting back in stock requests, the `collectionStates` must be set to `true`. Use [`startCollectingRequests()`](/back-in-stock-settings/start-collecting-requests) to update collection states, or [update in a site’s dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Go%20to%20Back-in-Stock&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/store/back-in-stock).\n+ For emails to send with the [`reportItemsBackInStock()`](/back-in-stock-notifications/report-items-back-in-stock) function, automations must be [activated in the site’s dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Go%20to%20Back-in-Stock&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https://www.wix.com/dashboard/{{metaSiteId}}/store/back-in-stock) first.\n+ [Customize the design of the notification email](https://support.wix.com/en/article/wix-stores-notifying-customers-when-products-are-back-in-stock#customizing-the-notification-email) that will be sent.\n\n## Terminology\n+ **Notification request:** The object that is created when a customer wants to be notified when an out-of-stock item becomes available. The back in stock notification request contains information about the item and an email address to contact when it’s back in stock.\n\n## Permissions information\nThe following functions in Back In Stock Notifications API are restricted and only run if you elevate permissions using the `wix-auth` [`elevate()`](https://www.wix.com/velo/reference/wix-auth/elevate) function:\n\n+ [`deleteBackInStockNotificationRequest()`](/back-in-stock-notifications/delete-back-in-stock-notification-request)\n+ [`getBackInStockNotificationRequest()`](/back-in-stock-notifications/get-back-in-stock-notification-request)\n+ [`getBackInStockNotificationRequestsCountByCatalogReferences()`](/back-in-stock-notifications/get-back-in-stock-notification-requests-count-by-catalog-references)\n+ [`markAsNotificationSent()`](/back-in-stock-notifications/mark-as-notification-sent)\n+ [`queryBackInStockNotificationRequests()`](/back-in-stock-notifications/query-back-in-stock-notification-requests)\n+ [`reportItemsBackInStock()`](/back-in-stock-notifications/report-items-back-in-stock)\n\n

\n
Warning: Elevating a function allows it to be called by any site visitor. Exercise caution to prevent security vulnerabilities.
\n

\n","displayName":"Introduction","slugifyName":"introduction","fqn":"Introduction60"}],"builderTypes":[{"kind":"REFERENCE","name":"RequestsQueryBuilder","referenceFqn":"RequestsQueryBuilder"},{"kind":"REFERENCE","name":"RequestsQueryResult","referenceFqn":"RequestsQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.170"},"resourceMetadata":{"lastModifiedBy":"","sourcePath":"","yamlPath":"","name":"BackInStockNotifications","yamlTitle":"Wix Ecom Backend","kind":"VELO","fqdn":"wix.ecom.v1.back_in_stock_notification_request"}}