Interface CartSetCustomLineItemTaxRateAction

Can be used if the Cart has the External TaxMode.

interface CartSetCustomLineItemTaxRateAction {
    action: "setCustomLineItemTaxRate";
    customLineItemId?: string;
    customLineItemKey?: string;
    externalTaxRate?: ExternalTaxRateDraft;
    shippingKey?: string;
}

Properties

action customLineItemId? customLineItemKey? externalTaxRate? shippingKey?

Properties

Readonly action

action: "setCustomLineItemTaxRate"

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 externalTaxRate

externalTaxRate?: ExternalTaxRateDraft

Value to set. If empty, an 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

actioncustomLineItemIdcustomLineItemKeyexternalTaxRateshippingKey