Interface StagedOrderSetLineItemTaxAmountAction

interface StagedOrderSetLineItemTaxAmountAction {
    action: "setLineItemTaxAmount";
    externalTaxAmount?: ExternalTaxAmountDraft;
    lineItemId: string;
    shippingKey?: string;
}

Properties

action externalTaxAmount? lineItemId shippingKey?

Properties

Readonly action

action: "setLineItemTaxAmount"

Optional Readonly externalTaxAmount

externalTaxAmount?: ExternalTaxAmountDraft

Cannot be used in LineItemDraft or CustomLineItemDraft.

Can only be set by these update actions:

- [Set LineItem TaxAmount](ctp:api:type:CartSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:CartSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:CartSetShippingMethodTaxAmountAction) on Carts
- [Set LineItem TaxAmount](ctp:api:type:OrderEditSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:OrderEditSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:OrderEditSetShippingMethodTaxAmountAction) on Order Edits

Readonly lineItemId

lineItemId: string

Optional Readonly shippingKey

shippingKey?: string

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc