Log in
Interface

ShippingMethodInterface

Magento\Quote\Api\Data\ShippingMethodInterface

What it does

This interface defines the contract for shipping method data objects in Magento 2's quote system.

Developers use this when working with checkout shipping options to access and manipulate shipping method information like carrier codes, titles, prices (including tax variations), and availability status.

It's commonly used in checkout customizations, shipping carrier integrations, and when displaying or processing shipping options during the order placement process.

Public Methods

  • getCarrierCode()
  • setCarrierCode()
  • getMethodCode()
  • setMethodCode()
  • getCarrierTitle()
  • setCarrierTitle()
  • getMethodTitle()
  • setMethodTitle()
  • getAmount()
  • setAmount()
  • getBaseAmount()
  • setBaseAmount()
  • getAvailable()
  • setAvailable()
  • getExtensionAttributes()
  • setExtensionAttributes()
  • getErrorMessage()
  • setErrorMessage()
  • getPriceExclTax()
  • setPriceExclTax()
  • getPriceInclTax()
  • setPriceInclTax()