Cart Actions

• addCouponsToCart
• addProductsToCart
• deleteCouponsFromCart
• deleteProductsFromCart
• fetchCart
• updateProductsInCart

addCouponsToCart

Adds coupons to the cart.

Usage

import { addCouponsToCart } from '@shopgate/engage/cart';

const couponIds = ['someCouponId', 'anotherCouponId'];

dispatch(addCouponsToCart(couponIds));

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

Parameters

• couponIds (Array<string>): The IDs of the coupons to add to the cart.

---

addProductsToCart

Adds products to the cart. For each product that is added, this action determines if the product is a product variant or a base product by the input productId. Metadata is then updated appropriately based off of the productId.

Usage

import { addProductsToCart } from '@shopgate/engage/cart';

const productsData = [
  {
    productId: '1',
    quantity: 1,
  },
  {
    productId: '2',
    quantity: 5,
  }
];

dispatch(addProductsToCart(productsData));

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

Parameters

• data (Array<Object>) required: The data necessary for the products to be added to the cart.
  • productId (string) required: can be a base product ID or variant product ID.
  • quantity (number) required: any number greater than 0.
  • options (Array<Object>) Required when a product with options is added to the cart.
    • type (string) required: Option type (select or text).
    • id (string) required: Option ID.
    • value (string) required: Option value (ID of an option value for select options, input value for text options.)

---

deleteCouponsFromCart

Removes coupons from the cart.

Usage

import { deleteCouponsFromCart } from '@shopgate/engage/cart';

const couponIds = ['someCouponId', 'anotherCouponId'];

dispatch(deleteCouponsFromCart(couponIds));

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

Parameters

• couponIds (Array<string>) required: The IDs of the coupons to be removed from the cart.

---

deleteProductsFromCart

Removes products from the cart.

Usage

import { deleteProductsFromCart } from '@shopgate/engage/cart';

const cartItemIds = ['1', '2', '5'];

dispatch(deleteProductsFromCart(cartItemIds));

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

Parameters

• cartItemIds (Array<string>) required: The IDs of the cart items to be removed from the cart.

---

fetchCart

Retrieves the current cart for the user.

Usage

import { fetchCart } from '@shopgate/engage/cart';

dispatch(fetchCart());

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

---

updateProductsInCart

Updates the quantity of a product in the cart. The input can be an array of multiple products.

Usage

import { updateProductsInCart } from '@shopgate/engage/cart';

const updateData = [
  {
    cartItemId: '20',
    quantity: 2,
  },
  {
    cartItemId: '21',
    quantity: 4,
  }
]

dispatch(updateProductsInCart(updateData));

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

Parameters

• updateData (Array<Object>) required: The data required to update the products in the cart.
  • cartItemId (string) required: The ID of the cart item to be updated.
  • quantity (number) required: Any number greater than 0.