Log in
Interface

TotalInterface

Magento\Sales\Api\Data\TotalInterface

What it does

This interface defines the contract for managing shipping-related totals in Magento 2 sales orders, including amounts, taxes, discounts, invoices, refunds, and cancellations.

Developers use this when working with order totals to access or modify shipping cost data in both base and display currencies.

It's commonly used in checkout, order management, and financial reporting customizations.

Public Methods

  • getBaseShippingAmount()
  • getBaseShippingCanceled()
  • getBaseShippingDiscountAmount()
  • getBaseShippingDiscountTaxCompensationAmnt()
  • getBaseShippingInclTax()
  • getBaseShippingInvoiced()
  • getBaseShippingRefunded()
  • getBaseShippingTaxAmount()
  • getBaseShippingTaxRefunded()
  • getShippingAmount()
  • getShippingCanceled()
  • getShippingDiscountAmount()
  • getShippingDiscountTaxCompensationAmount()
  • getShippingInclTax()
  • getShippingInvoiced()
  • getShippingRefunded()
  • getShippingTaxAmount()
  • getShippingTaxRefunded()
  • setBaseShippingAmount()
  • setBaseShippingCanceled()
  • setBaseShippingDiscountAmount()
  • setBaseShippingDiscountTaxCompensationAmnt()
  • setBaseShippingInclTax()
  • setBaseShippingInvoiced()
  • setBaseShippingRefunded()
  • setBaseShippingTaxAmount()
  • setBaseShippingTaxRefunded()
  • setShippingAmount()
  • setShippingCanceled()
  • setShippingDiscountAmount()
  • setShippingDiscountTaxCompensationAmount()
  • setShippingInclTax()
  • setShippingInvoiced()
  • setShippingRefunded()
  • setShippingTaxAmount()
  • setShippingTaxRefunded()
  • getExtensionAttributes()
  • setExtensionAttributes()