Shopgate Developer Center
Introduction
Guides
Tutorials
References
Support
Login
No results found.
ENGAGE
HOCs
Hooks
App
Cart
Category
Error
Favorites
Filters
Main
Product
Reviews
Router
Scanner
Search
User
Tracking Events
Extensions
Plugin API
Merchant API

Cart Streams

cartWillEnter$

Triggers when a cart route prepares to enter.

Usage

import { cartWillEnter$ } from '@shopgate/engage/cart';

subscribe(cartWillEnter$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { cartWillEnter$ } from '@shopgate/pwa-common-commerce/cart'

cartDidEnter$

Triggers when the cart route enters.

Usage

import { cartDidEnter$ } from '@shopgate/engage/cart';

subscribe(cartDidEnter$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { cartDidEnter$ } from '@shopgate/pwa-common-commerce/cart'

cartWillLeave$

Triggers when the cart route prepares to leave.

Usage

import { cartWillLeave$ } from '@shopgate/engage/cart';

subscribe(cartWillLeave$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { cartWillLeave$ } from '@shopgate/pwa-common-commerce/cart'

cartDidLeave$

Triggers when the cart route leaves.

Usage

import { cartDidLeave$ } from '@shopgate/engage/cart';

subscribe(cartDidLeave$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { cartDidLeave$ } from '@shopgate/pwa-common-commerce/cart'

routeWithCouponWillEnter$

Triggers when route with a coupon query parameter prepares to enter.

Usage

import { routeWithCouponWillEnter$ } from '@shopgate/engage/cart';

subscribe(routeWithCouponWillEnter$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { routeWithCouponWillEnter$ } from '@shopgate/pwa-common-commerce/cart'

cartRequesting$

Triggers when the cart requests new data.

Usage

import { cartRequesting$ } from '@shopgate/engage/cart';

subscribe(cartRequesting$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { cartRequesting$ } from '@shopgate/pwa-common-commerce/cart'

cartReceived$

Triggers when the cart receives a response, or an error occurrs.

Usage

import { cartReceived$ } from '@shopgate/engage/cart';

subscribe(cartReceived$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { cartReceived$ } from '@shopgate/pwa-common-commerce/cart'

couponsAdded$

Triggers when coupons are added to the cart.

Usage

import { couponsAdded$ } from '@shopgate/engage/cart';

subscribe(couponsAdded$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { couponsAdded$ } from '@shopgate/pwa-common-commerce/cart'

couponsDeleted$

Triggers when coupons are deleted from the cart.

Usage

import { couponsDeleted$ } from '@shopgate/engage/cart';

subscribe(couponsDeleted$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { couponsDeleted$ } from '@shopgate/pwa-common-commerce/cart'

couponsUpdated$

Triggers when the backend responds for an add / delete request. Independent from a successful, or failed request.

Usage

import { couponsUpdated$ } from '@shopgate/engage/cart';

subscribe(couponsUpdated$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { couponsUpdated$ } from '@shopgate/pwa-common-commerce/cart'

productsAdded$

Triggers when products are added to the cart.

Usage

import { productsAdded$ } from '@shopgate/engage/cart';

subscribe(productsAdded$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { productsAdded$ } from '@shopgate/pwa-common-commerce/cart'

productsModified$

Triggers when quantities of products are updated within the cart.

Usage

import { productsModified$ } from '@shopgate/engage/cart';

subscribe(productsModified$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { productsModified$ } from '@shopgate/pwa-common-commerce/cart'

productsDeleted$

Triggers when products are deleted from the cart.

Usage

import { productsDeleted$ } from '@shopgate/engage/cart';

subscribe(productsDeleted$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { productsDeleted$ } from '@shopgate/pwa-common-commerce/cart'

cartUpdatedWhileVisible$

Triggers when the cart is updated while it is visible.

Usage

import { cartUpdatedWhileVisible$ } from '@shopgate/engage/cart';

subscribe(cartUpdatedWhileVisible$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { cartUpdatedWhileVisible$ } from '@shopgate/pwa-common-commerce/cart'

productsUpdated$

Triggers when the backend responds for an add / delete / update request. Independent from a successful, or failed request.

Usage

import { productsUpdated$ } from '@shopgate/engage/cart';

subscribe(productsUpdated$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { productsUpdated$ } from '@shopgate/pwa-common-commerce/cart'

remoteCartDidUpdate$

Triggers when the backend responds for product add / delete / update requests and coupon add / delete requests. Independent from a successful, or failed request.

Usage

import { remoteCartDidUpdate$ } from '@shopgate/engage/cart';

subscribe(remoteCartDidUpdate$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { remoteCartDidUpdate$ } from '@shopgate/pwa-common-commerce/cart'

cartUpdateFailed$

Triggers when product add / update / delete requests or coupon add / delete requests failed.

Usage

import { cartUpdateFailed$ } from '@shopgate/engage/cart';

subscribe(cartUpdateFailed$, ({ action, dispatch, getState, prevState, events }) => {
  // The code you want to perform when the stream triggers.
})

Attention: The path to the old modules is deprecated and will be removed in ENGAGE v7: import { cartUpdateFailed$ } from '@shopgate/pwa-common-commerce/cart'