Interface CartSetCustomLineItemTaxAmountAction

Can be used if the Cart has the ExternalAmount TaxMode.

interface CartSetCustomLineItemTaxAmountAction {
    action: "setCustomLineItemTaxAmount";
    customLineItemId?: string;
    customLineItemKey?: string;
    externalTaxAmount?: ExternalTaxAmountDraft;
    shippingKey?: string;
}

Properties

action customLineItemId? customLineItemKey? externalTaxAmount? shippingKey?

Properties

Readonly action

action: "setCustomLineItemTaxAmount"

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.

Optional Readonly externalTaxAmount

externalTaxAmount?: ExternalTaxAmountDraft

Value to set. If empty, any existing value is removed.

Optional Readonly shippingKey

shippingKey?: string

key of the ShippingMethod used for this Custom Line Item. This is required for Carts with Multiple ShippingMode.

Settings

Member Visibility

Theme

On This Page

actioncustomLineItemIdcustomLineItemKeyexternalTaxAmountshippingKey