Interface CartRemoveLineItemAction

The LineItem price is updated as described in LineItem Price selection.

interface CartRemoveLineItemAction {
    action: "removeLineItem";
    externalPrice?: _Money;
    externalTotalPrice?: ExternalLineItemTotalPrice;
    lineItemId?: string;
    lineItemKey?: string;
    quantity?: number;
    shippingDetailsToRemove?: ItemShippingDetailsDraft;
}

Properties

action externalPrice? externalTotalPrice? lineItemId? lineItemKey? quantity? shippingDetailsToRemove?

Properties

Readonly action

action: "removeLineItem"

Optional Readonly externalPrice

externalPrice?: _Money

Sets the LineItem price to the given value when decreasing the quantity of a Line Item with the ExternalPrice LineItemPriceMode.

Optional Readonly externalTotalPrice

externalTotalPrice?: ExternalLineItemTotalPrice

Sets the LineItem price and totalPrice to the given value when decreasing the quantity of a Line Item with the ExternalTotal LineItemPriceMode.

Optional Readonly lineItemId

lineItemId?: string

id of the LineItem to update. Either lineItemId or lineItemKey is required.

Optional Readonly lineItemKey

lineItemKey?: string

key of the LineItem to update. Either lineItemId or lineItemKey is required.

Optional Readonly quantity

quantity?: number

Amount to subtract from the LineItem's quantity. If absent, the LineItem is removed from the Cart.

Optional Readonly shippingDetailsToRemove

shippingDetailsToRemove?: ItemShippingDetailsDraft

Container for Line Item-specific addresses to remove.

Settings

Member Visibility

Theme

On This Page

actionexternalPriceexternalTotalPricelineItemIdlineItemKeyquantityshippingDetailsToRemove