Interface StagedOrderRemoveLineItemAction

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

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

Properties

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

Properties

Readonlyaction

action: "removeLineItem"

Optional ReadonlyexternalPrice

externalPrice?: _Money

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

Optional ReadonlyexternalTotalPrice

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 ReadonlylineItemId

lineItemId?: string

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

Optional ReadonlylineItemKey

lineItemKey?: string

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

Optional Readonlyquantity

quantity?: number

New value to set. If absent or 0, the Line Item is removed from the Cart.

Optional ReadonlyshippingDetailsToRemove

shippingDetailsToRemove?: ItemShippingDetailsDraft

Container for Line Item-specific addresses to remove.

Settings

Member Visibility

On This Page

Properties