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, refunds, and invoices.

Developers use this to retrieve or set shipping totals data when working with orders, invoices, credit memos, or when calculating order totals.

It supports both base currency and store currency values, along with tax compensation calculations.

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()