Skip to content

analytics.purchased

analytics.purchased is an event on the Event Bus that occurs after a user has made a purchase in the shop. This event only dispatches when analytics is enabled in the shop.

Event body

none

Example

In this example we listen to analytics.purchased event and perform an action whenever it's emitted.

useStorefront(async (storefront) => {
    storefront.eventBus.on('analytics.purchased', () => {
        console.log('A user has made a purchase in the shop')
    });
});

Example

In this example we use a Message Storage API to retrieve an array of past analytics.purchased events.

useStorefront((storefront) => {
    const messageStorageApi = storefront.getApiSync('messageStorageSystemApi');

    const pastPurchasedEvents = messageStorageApi.getChannelMessages('analytics.purchased');

    if (pastPurchasedEvents.length > 0) {
        pastPurchasedEvents.forEach(({ body: eventBody }) => {
            console.log('perform action on every past event');
        });
    }
});

JS API reference