Interface CartRemoveCustomLineItemAction

This update action does not support specifying quantities, unlike the Remove LineItem update action.

If `shippingDetails` must be partially removed, use the [Change CustomLineItem Quantity](ctp:api:type:CartChangeCustomLineItemQuantityAction) update action.
interface CartRemoveCustomLineItemAction {
    action: "removeCustomLineItem";
    customLineItemId?: string;
    customLineItemKey?: string;
}

Properties

action customLineItemId? customLineItemKey?

Properties

Readonly action

action: "removeCustomLineItem"

Optional Readonly customLineItemId

customLineItemId?: string

id of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Optional Readonly customLineItemKey

customLineItemKey?: string

key of the CustomLineItem to update. Either customLineItemId or customLineItemKey is required.

Settings

Member Visibility

Theme

On This Page

actioncustomLineItemIdcustomLineItemKey