OrderItemInterface

What it does

This interface defines the data contract for individual items within a Magento 2 order.

Developers use it when working with order items through APIs or services to access and modify product information, quantities, pricing, taxes, discounts, and shipping details.

It provides a standardized way to interact with order item data across different modules and customizations.

Public Methods

• getAdditionalData()
• getAmountRefunded()
• getAppliedRuleIds()
• getBaseAmountRefunded()
• getBaseCost()
• getBaseDiscountAmount()
• getBaseDiscountInvoiced()
• getBaseDiscountRefunded()
• getBaseDiscountTaxCompensationAmount()
• getBaseDiscountTaxCompensationInvoiced()
• getBaseDiscountTaxCompensationRefunded()
• getBaseOriginalPrice()
• getBasePrice()
• getBasePriceInclTax()
• getBaseRowInvoiced()
• getBaseRowTotal()
• getBaseRowTotalInclTax()
• getBaseTaxAmount()
• getBaseTaxBeforeDiscount()
• getBaseTaxInvoiced()
• getBaseTaxRefunded()
• getBaseWeeeTaxAppliedAmount()
• getBaseWeeeTaxAppliedRowAmnt()
• getBaseWeeeTaxDisposition()
• getBaseWeeeTaxRowDisposition()
• getCreatedAt()
• setCreatedAt()
• getDescription()
• getDiscountAmount()
• getDiscountInvoiced()
• getDiscountPercent()
• getDiscountRefunded()
• getEventId()
• getExtOrderItemId()
• getFreeShipping()
• getGwBasePrice()
• getGwBasePriceInvoiced()
• getGwBasePriceRefunded()
• getGwBaseTaxAmount()
• getGwBaseTaxAmountInvoiced()
• getGwBaseTaxAmountRefunded()
• getGwId()
• getGwPrice()
• getGwPriceInvoiced()
• getGwPriceRefunded()
• getGwTaxAmount()
• getGwTaxAmountInvoiced()
• getGwTaxAmountRefunded()
• getDiscountTaxCompensationAmount()
• getDiscountTaxCompensationCanceled()
• getDiscountTaxCompensationInvoiced()
• getDiscountTaxCompensationRefunded()
• getIsQtyDecimal()
• getIsVirtual()
• getItemId()
• getLockedDoInvoice()
• getLockedDoShip()
• getName()
• getNoDiscount()
• getOrderId()
• getOriginalPrice()
• getParentItemId()
• getPrice()
• getPriceInclTax()
• getProductId()
• getProductType()
• getQtyBackordered()
• getQtyCanceled()
• getQtyInvoiced()
• getQtyOrdered()
• getQtyRefunded()
• getQtyReturned()
• getQtyShipped()
• getQuoteItemId()
• getRowInvoiced()
• getRowTotal()
• getRowTotalInclTax()
• getRowWeight()
• getSku()
• getStoreId()
• getTaxAmount()
• getTaxBeforeDiscount()
• getTaxCanceled()
• getTaxInvoiced()
• getTaxPercent()
• getTaxRefunded()
• getUpdatedAt()
• getWeeeTaxApplied()
• getWeeeTaxAppliedAmount()
• getWeeeTaxAppliedRowAmount()
• getWeeeTaxDisposition()
• getWeeeTaxRowDisposition()
• getWeight()
• getParentItem()
• setParentItem()
• setUpdatedAt()
• setItemId()
• setOrderId()
• setParentItemId()
• setQuoteItemId()
• setStoreId()
• setProductId()
• setProductType()
• setWeight()
• setIsVirtual()
• setSku()
• setName()
• setDescription()
• setAppliedRuleIds()
• setAdditionalData()
• setIsQtyDecimal()
• setNoDiscount()
• setQtyBackordered()
• setQtyCanceled()
• setQtyInvoiced()
• setQtyOrdered()
• setQtyRefunded()
• setQtyShipped()
• setBaseCost()
• setPrice()
• setBasePrice()
• setOriginalPrice()
• setBaseOriginalPrice()
• setTaxPercent()
• setTaxAmount()
• setBaseTaxAmount()
• setTaxInvoiced()
• setBaseTaxInvoiced()
• setDiscountPercent()
• setDiscountAmount()
• setBaseDiscountAmount()
• setDiscountInvoiced()
• setBaseDiscountInvoiced()
• setAmountRefunded()
• setBaseAmountRefunded()
• setRowTotal()
• setBaseRowTotal()
• setRowInvoiced()
• setBaseRowInvoiced()
• setRowWeight()
• setBaseTaxBeforeDiscount()
• setTaxBeforeDiscount()
• setExtOrderItemId()
• setLockedDoInvoice()
• setLockedDoShip()
• setPriceInclTax()
• setBasePriceInclTax()
• setRowTotalInclTax()
• setBaseRowTotalInclTax()
• setDiscountTaxCompensationAmount()
• setBaseDiscountTaxCompensationAmount()
• setDiscountTaxCompensationInvoiced()
• setBaseDiscountTaxCompensationInvoiced()
• setDiscountTaxCompensationRefunded()
• setBaseDiscountTaxCompensationRefunded()
• setTaxCanceled()
• setDiscountTaxCompensationCanceled()
• setTaxRefunded()
• setBaseTaxRefunded()
• setDiscountRefunded()
• setBaseDiscountRefunded()
• setGwId()
• setGwBasePrice()
• setGwPrice()
• setGwBaseTaxAmount()
• setGwTaxAmount()
• setGwBasePriceInvoiced()
• setGwPriceInvoiced()
• setGwBaseTaxAmountInvoiced()
• setGwTaxAmountInvoiced()
• setGwBasePriceRefunded()
• setGwPriceRefunded()
• setGwBaseTaxAmountRefunded()
• setGwTaxAmountRefunded()
• setFreeShipping()
• setQtyReturned()
• setEventId()
• setBaseWeeeTaxAppliedAmount()
• setBaseWeeeTaxAppliedRowAmnt()
• setWeeeTaxAppliedAmount()
• setWeeeTaxAppliedRowAmount()
• setWeeeTaxApplied()
• setWeeeTaxDisposition()
• setWeeeTaxRowDisposition()
• setBaseWeeeTaxDisposition()
• setBaseWeeeTaxRowDisposition()
• getProductOption()
• setProductOption()
• getExtensionAttributes()
• setExtensionAttributes()