Object representing a cart entry. Please notice, cart item may represent multiple bought items. CartItem.quantity provides a number of bought items.
• cartItemId: string
Globally unique identifier (GUID) of a cart item. This ID is unique per fresh impression of a catalog item. As such it can change on subsequent visits to the up-sale page where Rokt SDK presents items to a user. As usual in the case of a change to cart item Rokt will trigger [[Cart.onUpdateItem]], however in this particular case an updated item and an old item may have a different CartItem.cartItemId. Please be mindful of this behaviour if you use CartItem.cartItemId value to correlate items in your cart to the ones provided in [[Cart.onUpdateItem]] callback.
• catalogItemId: string
Unique identifier of a catalog item. The same catalog item is presented to different users and contrary to CartItem.cartItemId its value does not change between fresh impression of a catalog item. This can be thought of as SKU of a product.
• currency: string
ISO 4217 compliant currency code.
• description: string
Description of an item.
• linkedProductId: string | undefined
ID (SKU) of a product from partner's inventory linked to Rokt's cart item. If present it signifies that the cart item is attached to the product on the partner's side and the Rokt's item cannot be sold separately from the partner's product.
One example would be a user using Rokt's services to purchase a warranty for an item sold on partner's page. In this case
linkedProductId would represent ID of partner's item. If at any point of the transaction flow user chooses to remove the partner's item from their cart the Rokt's cart item should also be removed as warranty cannot be purchased without the item it covers.
• name: string
Name of an item.
• quantityMustBeSynchronized: boolean | undefined
One example would be a user buying a warranty from Rokt for a product sold on partner's page. In case of multiple items of the same product bought by a user, warranty would be represented by a single Rokt's cart item with a quantity matching the number of products added to the cart by user at the time of selection. If at any point of the transaction flow user chooses to change the quantity of the partner's item the quantity and thus the total price of Rokt's cart item needs to be updated.
• providerData: string
A JSON string containing arbitrary data provided by the item provider to pass through to the Partner.
• quantity: number
Quantity of requested items.
• totalPrice: number
Total price equal to unit price times quantity.
In case of quantityMustBeSynchronized being true the value may not represent the final total price if user makes changes to the linked product quantity.
• unitPrice: number
Price per item.