Interface OrderLineItemDiscountSetMessagePayload

Generated after a successful recalculation of a Discount on a Line Item.

interface OrderLineItemDiscountSetMessagePayload {
    discountedPricePerQuantity: DiscountedLineItemPriceForQuantity[];
    lineItemId: string;
    lineItemKey?: string;
    taxedPrice?: TaxedItemPrice;
    taxedPricePortions: MethodTaxedPrice[];
    totalPrice: _Money;
    type: "OrderLineItemDiscountSet";
}

Properties

discountedPricePerQuantity lineItemId lineItemKey? taxedPrice? taxedPricePortions totalPrice type

Properties

Readonly discountedPricePerQuantity

discountedPricePerQuantity: DiscountedLineItemPriceForQuantity[]

Array of DiscountedLineItemPriceForQuantity after the Discount recalculation.

Readonly lineItemId

lineItemId: string

Unique identifier for the Line Item.

Optional Readonly lineItemKey

lineItemKey?: string

User-defined unique identifier of the LineItem.

Optional Readonly taxedPrice

taxedPrice?: TaxedItemPrice

TaxedItemPrice of the Line Item after the Discount recalculation.

Readonly taxedPricePortions

taxedPricePortions: MethodTaxedPrice[]

Total taxed prices based on the quantity of Line Item assigned to each Shipping Method. Only applicable for Carts with Multiple ShippingMode. Automatically set after perMethodTaxRate is set.

Readonly totalPrice

totalPrice: _Money

Total Price of the Line Item after the Discount recalculation.

Readonly type

type: "OrderLineItemDiscountSet"

Settings

Member Visibility

Theme

On This Page

discountedPricePerQuantitylineItemIdlineItemKeytaxedPricetaxedPricePortionstotalPricetype