Skip to content
  • Documentation >
  • Commerce >
  • Cart >
  • Cart

Cart

The cart component is a foundation of the Commerce offering delivered as part of Ibexa DXP. It covers actions related to the creation and handling of a list of products that the buyer intends to purchase.

The component exposes the following:

  • PHP API that allows for managing carts and cart entries, or checking cart validity
  • REST API that helps get cart and products information over HTTP
  • Twig functions that enable checking whether product can be added to cart and formatting the price

There is no specific configuration related to the cart component. All configuration is done at the checkout and storefront level.

Cart constructor takes the following arguments:

  • userId - by default, read from the header's meta element with name="UserId", where variable type must be integer
  • currencyCode - by default, read from the header's meta element with name="ActiveCurrencyCode"
  • lang - by default, read from the document element's lang attribute

Cart data handling

Cart data is handled by two storages, depending on whether the buyer is anonymous or has been authenticated. Information that relates to anonymous users is stored in the PHP session, while registered user data is stored in a database.

By default, anonymous users can add items to cart, but to display the cart view, they have to log in and transition into an authenticated user.

Note

For information about roles and permissions that control access to the cart, see Permission use cases.

Cart data merging

When a buyer browses the storefront anonymously and fills the cart with items, anonymous cart data is stored in the PHP session storage. Then, when an anonymous user logs into the storefront, cart data from the PHP session storage is persisted and merged with any cart information that might already exist in the database for this authenticated user.

If no previous cart data exists, a new cart is created.

Cart data validation

When a buyer tries to add products to the cart, increase cart item quantity or proceed to checkout, the cart component performs cart item validation and checks whether:

  • the product is available
  • the requested quantity of product is available
  • the product is available at a price in the currency selected for the cart

Front-end perspective

From the front-end perspective, the cart consists of a main Cart object and several widgets. Cart is a standalone JavaScript object that manages cart data and has no user interface, while widgets consist of JavaScript code and accompanying Twig templates.

Cart service object

The Cart service object stores cart entry data and a cart summary, which contains additional entry data, like, for example, formatted gross price or validation errors. The object exposes several methods, which you can use to get and modify cart entries. Only one instance of a Cart service object can be created.

Cart events

When cart data is changed or loaded, the ibexa-cart:cart-data-changed event is triggered on body. The reference to the Cart is sent in the event's detail.

1
2
3
4
5
6
7
document.body.addEventListener(
    'ibexa-cart:cart-data-changed',
    ({ detail: { cart } }) => {
        refreshMyWidget(cart);
    },
    false,
);

Cart service

The Cart package provides Ibexa\Contracts\Cart\CartServiceInterface Symfony service, which is the entrypoint for calling the backend API.

You can import the service using the following code:

1
import * as cartService from '@ibexa-cart/src/bundle/Resources/public/js/service/cart';

Use the service in your code as follows:

1
cartService.deleteCartEntry(cartIdentifier, entryIdentifier);

Every cart service function returns a Promise object with a parsed response. When the request is not OK, it can throw an error with the response statusText.

  • loadUserCarts(ownerId) - loads 10 user carts
  • loadCartSummary(cartIdentifier) - load cart summary data
  • createCart(currencyCode) - creates a new cart
  • deleteCart(cartIdentifier) - deletes the cart
  • createCartEntry(cartIdentifier, productCode, quantity) - creates a new cart entry for the specified product
  • updateProductQuantity(cartIdentifier, entryIdentifier, quantity) - updates product quantity to a new value
  • deleteCartEntry(cartIdentifier, entryIdentifier) - deletes cart entry
  • emptyCart(cartIdentifier) - empties cart by removing all entries, returns Promise

To import and initialize cart (without extending it or passing any options), add the following:

1
2
3
import Cart from '@ibexa-cart/src/bundle/Resources/public/js/component/cart';

new Cart();

Change request before sending

Before every request is sent by cartService, the ibexa-cart:prepare-request event is triggered on document, so you can change request object by assigning a new one to detail.request:

1
2
3
4
5
6
7
document.addEventListener(
    'ibexa-cart:prepare-request',
    (event) => {
        event.detail.request = modifiedRequest;
    },
    false,
);

Widgets

Ibexa DXP comes with a number of components that are interfaces to various functionalities exposed by the Cart. For a list of default components available in the storefront, see Default UI components.

To customize your store, you can override the Twig templates and extend their logic. For more information, see Customize storefront layout.