startCollectingRequests( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Sets settings.collectionStates.collectingRequests to true for given appId.

When the collection state is set to true, collecting requests is enabled and customers may request notifications for out of stock products. While collecting is enabled, customers see a "Notify When Available" button on out-of-stock items. Customers can click the button to enter their email address, which creates the notification request.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Stores - all permissions
Learn more about app permissions.
Method Declaration
Copy
function startCollectingRequests(
  appId: string,
): Promise<StartCollectingRequestsResponse>;
Method Parameters
appIdstringRequired

ID of the app to start accepting notification requests for.

Returns
Return Type:Promise<StartCollectingRequestsResponse>
JavaScript
import { backInStockSettings } from "@wix/ecom";

async function startCollectingRequests(appId) {
  const response = await backInStockSettings.startCollectingRequests(appId);
}
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?