Log in
Interface

OrderInterface

Magento\Sales\Api\Data\OrderInterface

What it does

OrderInterface defines the data contract for sales orders in Magento 2.

It provides getter and setter methods for all order properties including totals, customer information, addresses, payment details, and line items.

Developers use this interface when working with orders through the API, ensuring consistent data structure across the application.

Public Methods

  • getAdjustmentNegative()
  • getAdjustmentPositive()
  • getAppliedRuleIds()
  • getBaseAdjustmentNegative()
  • getBaseAdjustmentPositive()
  • getBaseCurrencyCode()
  • getBaseDiscountAmount()
  • getBaseDiscountCanceled()
  • getBaseDiscountInvoiced()
  • getBaseDiscountRefunded()
  • getBaseGrandTotal()
  • getBaseDiscountTaxCompensationAmount()
  • getBaseDiscountTaxCompensationInvoiced()
  • getBaseDiscountTaxCompensationRefunded()
  • getBaseShippingAmount()
  • getBaseShippingCanceled()
  • getBaseShippingDiscountAmount()
  • getBaseShippingDiscountTaxCompensationAmnt()
  • getBaseShippingInclTax()
  • getBaseShippingInvoiced()
  • getBaseShippingRefunded()
  • getBaseShippingTaxAmount()
  • getBaseShippingTaxRefunded()
  • getBaseSubtotal()
  • getBaseSubtotalCanceled()
  • getBaseSubtotalInclTax()
  • getBaseSubtotalInvoiced()
  • getBaseSubtotalRefunded()
  • getBaseTaxAmount()
  • getBaseTaxCanceled()
  • getBaseTaxInvoiced()
  • getBaseTaxRefunded()
  • getBaseTotalCanceled()
  • getBaseTotalDue()
  • getBaseTotalInvoiced()
  • getBaseTotalInvoicedCost()
  • getBaseTotalOfflineRefunded()
  • getBaseTotalOnlineRefunded()
  • getBaseTotalPaid()
  • getBaseTotalQtyOrdered()
  • getBaseTotalRefunded()
  • getBaseToGlobalRate()
  • getBaseToOrderRate()
  • getBillingAddressId()
  • getCanShipPartially()
  • getCanShipPartiallyItem()
  • getCouponCode()
  • getCreatedAt()
  • setCreatedAt()
  • getCustomerDob()
  • getCustomerEmail()
  • getCustomerFirstname()
  • getCustomerGender()
  • getCustomerGroupId()
  • getCustomerId()
  • getCustomerIsGuest()
  • getCustomerLastname()
  • getCustomerMiddlename()
  • getCustomerNote()
  • getCustomerNoteNotify()
  • getCustomerPrefix()
  • getCustomerSuffix()
  • getCustomerTaxvat()
  • getDiscountAmount()
  • getDiscountCanceled()
  • getDiscountDescription()
  • getDiscountInvoiced()
  • getDiscountRefunded()
  • getEditIncrement()
  • getEmailSent()
  • getEntityId()
  • setEntityId()
  • getExtCustomerId()
  • getExtOrderId()
  • getForcedShipmentWithInvoice()
  • getGlobalCurrencyCode()
  • getGrandTotal()
  • getDiscountTaxCompensationAmount()
  • getDiscountTaxCompensationInvoiced()
  • getDiscountTaxCompensationRefunded()
  • getHoldBeforeState()
  • getHoldBeforeStatus()
  • getIncrementId()
  • getIsVirtual()
  • getOrderCurrencyCode()
  • getOriginalIncrementId()
  • getPaymentAuthorizationAmount()
  • getPaymentAuthExpiration()
  • getProtectCode()
  • getQuoteAddressId()
  • getQuoteId()
  • getRelationChildId()
  • getRelationChildRealId()
  • getRelationParentId()
  • getRelationParentRealId()
  • getRemoteIp()
  • getShippingAmount()
  • getShippingCanceled()
  • getShippingDescription()
  • getShippingDiscountAmount()
  • getShippingDiscountTaxCompensationAmount()
  • getShippingInclTax()
  • getShippingInvoiced()
  • getShippingRefunded()
  • getShippingTaxAmount()
  • getShippingTaxRefunded()
  • getState()
  • getStatus()
  • getStoreCurrencyCode()
  • getStoreId()
  • getStoreName()
  • getStoreToBaseRate()
  • getStoreToOrderRate()
  • getSubtotal()
  • getSubtotalCanceled()
  • getSubtotalInclTax()
  • getSubtotalInvoiced()
  • getSubtotalRefunded()
  • getTaxAmount()
  • getTaxCanceled()
  • getTaxInvoiced()
  • getTaxRefunded()
  • getTotalCanceled()
  • getTotalDue()
  • getTotalInvoiced()
  • getTotalItemCount()
  • getTotalOfflineRefunded()
  • getTotalOnlineRefunded()
  • getTotalPaid()
  • getTotalQtyOrdered()
  • getTotalRefunded()
  • getUpdatedAt()
  • getWeight()
  • getXForwardedFor()
  • getItems()
  • setItems()
  • getBillingAddress()
  • setBillingAddress()
  • getPayment()
  • setPayment()
  • getStatusHistories()
  • setStatusHistories()
  • setState()
  • setStatus()
  • setCouponCode()
  • setProtectCode()
  • setShippingDescription()
  • setIsVirtual()
  • setStoreId()
  • setCustomerId()
  • setBaseDiscountAmount()
  • setBaseDiscountCanceled()
  • setBaseDiscountInvoiced()
  • setBaseDiscountRefunded()
  • setBaseGrandTotal()
  • setBaseShippingAmount()
  • setBaseShippingCanceled()
  • setBaseShippingInvoiced()
  • setBaseShippingRefunded()
  • setBaseShippingTaxAmount()
  • setBaseShippingTaxRefunded()
  • setBaseSubtotal()
  • setBaseSubtotalCanceled()
  • setBaseSubtotalInvoiced()
  • setBaseSubtotalRefunded()
  • setBaseTaxAmount()
  • setBaseTaxCanceled()
  • setBaseTaxInvoiced()
  • setBaseTaxRefunded()
  • setBaseToGlobalRate()
  • setBaseToOrderRate()
  • setBaseTotalCanceled()
  • setBaseTotalInvoiced()
  • setBaseTotalInvoicedCost()
  • setBaseTotalOfflineRefunded()
  • setBaseTotalOnlineRefunded()
  • setBaseTotalPaid()
  • setBaseTotalQtyOrdered()
  • setBaseTotalRefunded()
  • setDiscountAmount()
  • setDiscountCanceled()
  • setDiscountInvoiced()
  • setDiscountRefunded()
  • setGrandTotal()
  • setShippingAmount()
  • setShippingCanceled()
  • setShippingInvoiced()
  • setShippingRefunded()
  • setShippingTaxAmount()
  • setShippingTaxRefunded()
  • setStoreToBaseRate()
  • setStoreToOrderRate()
  • setSubtotal()
  • setSubtotalCanceled()
  • setSubtotalInvoiced()
  • setSubtotalRefunded()
  • setTaxAmount()
  • setTaxCanceled()
  • setTaxInvoiced()
  • setTaxRefunded()
  • setTotalCanceled()
  • setTotalInvoiced()
  • setTotalOfflineRefunded()
  • setTotalOnlineRefunded()
  • setTotalPaid()
  • setTotalQtyOrdered()
  • setTotalRefunded()
  • setCanShipPartially()
  • setCanShipPartiallyItem()
  • setCustomerIsGuest()
  • setCustomerNoteNotify()
  • setBillingAddressId()
  • setCustomerGroupId()
  • setEditIncrement()
  • setEmailSent()
  • setForcedShipmentWithInvoice()
  • setPaymentAuthExpiration()
  • setQuoteAddressId()
  • setQuoteId()
  • setAdjustmentNegative()
  • setAdjustmentPositive()
  • setBaseAdjustmentNegative()
  • setBaseAdjustmentPositive()
  • setBaseShippingDiscountAmount()
  • setBaseSubtotalInclTax()
  • setBaseTotalDue()
  • setPaymentAuthorizationAmount()
  • setShippingDiscountAmount()
  • setSubtotalInclTax()
  • setTotalDue()
  • setWeight()
  • setCustomerDob()
  • setIncrementId()
  • setAppliedRuleIds()
  • setBaseCurrencyCode()
  • setCustomerEmail()
  • setCustomerFirstname()
  • setCustomerLastname()
  • setCustomerMiddlename()
  • setCustomerPrefix()
  • setCustomerSuffix()
  • setCustomerTaxvat()
  • setDiscountDescription()
  • setExtCustomerId()
  • setExtOrderId()
  • setGlobalCurrencyCode()
  • setHoldBeforeState()
  • setHoldBeforeStatus()
  • setOrderCurrencyCode()
  • setOriginalIncrementId()
  • setRelationChildId()
  • setRelationChildRealId()
  • setRelationParentId()
  • setRelationParentRealId()
  • setRemoteIp()
  • setStoreCurrencyCode()
  • setStoreName()
  • setXForwardedFor()
  • setCustomerNote()
  • setUpdatedAt()
  • setTotalItemCount()
  • setCustomerGender()
  • setDiscountTaxCompensationAmount()
  • setBaseDiscountTaxCompensationAmount()
  • setShippingDiscountTaxCompensationAmount()
  • setBaseShippingDiscountTaxCompensationAmnt()
  • setDiscountTaxCompensationInvoiced()
  • setBaseDiscountTaxCompensationInvoiced()
  • setDiscountTaxCompensationRefunded()
  • setBaseDiscountTaxCompensationRefunded()
  • setShippingInclTax()
  • setBaseShippingInclTax()
  • getExtensionAttributes()
  • setExtensionAttributes()