Interface OrderLineItemRemovedMessagePayload

Generated after a successful Remove Line Item update action.

interface OrderLineItemRemovedMessagePayload {
    lineItemId: string;
    newPrice?: Price;
    newQuantity: number;
    newShippingDetail?: ItemShippingDetails;
    newState: ItemState[];
    newTaxedPrice?: TaxedItemPrice;
    newTotalPrice: CentPrecisionMoney;
    removedQuantity: number;
    type: "OrderLineItemRemoved";
}

Index

Properties

lineItemId newPrice? newQuantity newShippingDetail? newState newTaxedPrice? newTotalPrice removedQuantity type

Properties

`Readonly` lineItemId

lineItemId: string

Unique identifier of the Line Item.

`Optional` `Readonly` newPrice

newPrice?: Price

Price of the Order after the Remove Line Item update action.

`Readonly` newQuantity

newQuantity: number

Line Item quantity after the Remove Line Item update action.

`Optional` `Readonly` newShippingDetail

newShippingDetail?: ItemShippingDetails

Shipping Details of the Order after the Remove Line Item update action.

`Readonly` newState

newState: ItemState[]

ItemStates after the Remove Line Item update action.

`Optional` `Readonly` newTaxedPrice

newTaxedPrice?: TaxedItemPrice

TaxedItemPrice of the Order after the Remove Line Item update action.

`Readonly` newTotalPrice

newTotalPrice: CentPrecisionMoney

totalPrice of the Order after the Remove Line Item update action.

`Readonly` removedQuantity

removedQuantity: number

Quantity of Line Items that were removed during the Remove Line Item update action.

`Readonly` type

type: "OrderLineItemRemoved"

Generated using TypeDoc