Log in
Model

ShippingTotal

Magento\Sales\Model\Order\ShippingTotal

What it does

This class represents shipping-related totals for a Magento 2 order, providing getters and setters for all shipping amounts including taxes, discounts, refunds, and invoices in both base and display currencies.

Developers use this model to retrieve or set shipping cost information when working with order totals, particularly useful when displaying order summaries, processing refunds, or integrating with custom shipping 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()