@gradientedge/commercetools-utils
    Preparing search index...

    Interface CartRemoveLineItemAction

    The LineItem price is updated as described in Line Item price selection.

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

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    action: "removeLineItem"
    externalPrice?: _Money

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

    externalTotalPrice?: ExternalLineItemTotalPrice

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

    lineItemId?: string

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

    lineItemKey?: string

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

    quantity?: number

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

    shippingDetailsToRemove?: ItemShippingDetailsDraft

    Container for Line Item-specific addresses to remove.

    Settings

    Member Visibility

    On This Page

    Properties