Interface CartChangeCustomLineItemQuantityAction

When multiple shipping addresses are set for a Custom Line Item, use the Add CustomLineItem update action to change the shipping details. Since it is not possible for the API to infer how the overall change in the Custom Line Item quantity should be distributed over the sub-quantities, the shippingDetails field is kept in its current state to avoid data loss.

To change the Custom Line Item quantity and shipping details together,
use this update action in combination with the [Set CustomLineItem ShippingDetails](ctp:api:type:CartSetCustomLineItemShippingDetailsAction) update action
in a single Cart update command.
interface CartChangeCustomLineItemQuantityAction {
    action: "changeCustomLineItemQuantity";
    customLineItemId?: string;
    customLineItemKey?: string;
    quantity: number;
}

Properties

action customLineItemId? customLineItemKey? quantity

Properties

Readonly action

action: "changeCustomLineItemQuantity"

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.

Readonly quantity

quantity: number

New value to set.

If `0`, the Custom Line Item is removed from the Cart.

Settings

Member Visibility

Theme

On This Page

actioncustomLineItemIdcustomLineItemKeyquantity