subscribeByMarker

Subscribe to an event to products. 🔐 This method requires authorization.

Description

This method subscribes the authorized user to an event for a specific product (e.g. price drop, status change). It returns a Promise that resolves to true if the subscription was created, or an IError object if there was an issue.

⚠️ With the default errors.isShell: true setting, a rejected request is returned rather than thrown: this method resolves to an IError object, never to false. Check result === true - an error object is truthy, so if (result) would treat a failure as success.

Events.subscribeByMarker(

marker*, productId*, langCode, threshold

);

Parameters schema

Schema

marker:* string
Event marker
example: test_event

productId:* string
Product id
example: 14

langCode: string
Language code
example: en_US

threshold: number
Threshold value for comparing numerical value
example: 0

Examples

Minimal example

const response = await Events.subscribeByMarker('test_event', 1, 1);

Example with attributes

const response = await Events.subscribeByMarker('test_event', 1, 1, 'en_US', 0);

Returns nothing if the subscription was successful.

---