Interface StagedOrderRemoveCustomLineItemAction

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

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

Properties

action customLineItemId? customLineItemKey?

Properties

Readonlyaction

action: "removeCustomLineItem"

Optional ReadonlycustomLineItemId

customLineItemId?: string

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

Optional ReadonlycustomLineItemKey

customLineItemKey?: string

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

Settings

Member Visibility

On This Page

Properties