Log in
Interface

ShippingMethodInterface

Magento\Quote\Api\Data\ShippingMethodInterface

What it does

This interface defines the data structure for shipping methods available in a Magento 2 quote.

Developers use it to retrieve and manipulate shipping method information like carrier code, method code, titles, pricing (with and without tax), and availability status.

It's commonly used when displaying shipping options during checkout or when processing shipping calculations through the API.

Public Methods

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