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

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permissions
Manage Stores - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
appIdstringRequired

ID of the app to start accepting notification requests for.

Returns
Return Type:Promise<StartCollectingRequestsResponse>
Was this helpful?
Yes
No