craft\commerce
craft\commerce\adjusters
craft\commerce\base
craft\commerce\behaviors
craft\commerce\console
craft\commerce\console\controllers
craft\commerce\controllers
craft\commerce\db
craft\commerce\debug
craft\commerce\elements
craft\commerce\elements\actions
craft\commerce\elements\conditions\addresses
craft\commerce\elements\conditions\customers
craft\commerce\elements\conditions\orders
craft\commerce\elements\conditions\products
craft\commerce\elements\conditions\users
craft\commerce\elements\conditions\variants
craft\commerce\elements\db
craft\commerce\elements\traits
craft\commerce\engines
craft\commerce\errors
craft\commerce\events
craft\commerce\exports
craft\commerce\fieldlayoutelements
craft\commerce\fields
craft\commerce\gateways
craft\commerce\gql\arguments\elements
craft\commerce\gql\interfaces\elements
craft\commerce\gql\queries
craft\commerce\gql\resolvers\elements
craft\commerce\gql\types
craft\commerce\gql\types\elements
craft\commerce\gql\types\generators
craft\commerce\gql\types\input
craft\commerce\helpers
craft\commerce\migrations
craft\commerce\models
craft\commerce\models\payments
craft\commerce\models\responses
craft\commerce\models\subscriptions
craft\commerce\plugin
craft\commerce\queue\jobs
craft\commerce\records
craft\commerce\services
craft\commerce\stats
craft\commerce\test\fixtures\elements
craft\commerce\test\mockclasses
craft\commerce\validators
craft\commerce\web\assets\chartjs
craft\commerce\web\assets\commercecp
craft\commerce\web\assets\commerceui
craft\commerce\web\assets\coupons
craft\commerce\web\assets\deepmerge
craft\commerce\web\assets\editproduct
craft\commerce\web\assets\orderswidget
craft\commerce\web\assets\productindex
craft\commerce\web\assets\statwidgets
craft\commerce\web\assets\variantmatrix
craft\commerce\web\twig
craft\commerce\widgets

ShippingMethodInterface

Type: Interface
Namespace: craft\commerce\base
Implemented by: craft\commerce\base\ShippingMethod, craft\commerce\models\ShippingMethod, craft\commerce\models\ShippingMethodOption
Since: 2.0

Interface ShippingMethod

View source (opens new window)

# Public Methods

Method	Description
getCpEditUrl()	Returns the control panel URL to manage this method and its rules.
getHandle()	Returns the unique handle of this Shipping Method.
getId()	Returns the ID of this Shipping Method, if it is managed by Craft Commerce.
getIsEnabled()	Returns whether this shipping method is enabled for listing and selection by customers.
getMatchingShippingRule()	The first matching shipping rule for this shipping method
getName()	Returns the name of this Shipping Method as displayed to the customer and in the control panel.
getPriceForOrder()
getShippingRules()	Returns an array of rules that meet the `ShippingRules` interface.
getType()	Returns the type of Shipping Method. This might be the name of the plugin or provider.
matchOrder()	Is this shipping method available to the order?

# `getCpEditUrl()`

Returns the control panel URL to manage this method and its rules.

An empty string will result in no link.

View source (opens new window)

# `getHandle()`

Returns the unique handle of this Shipping Method.

View source (opens new window)

# `getId()`

Returns the ID of this Shipping Method, if it is managed by Craft Commerce.

View source (opens new window)

Returns

integer (opens new window), null (opens new window) – The shipping method ID, or null if it is not managed by Craft Commerce

# `getIsEnabled()`

Returns whether this shipping method is enabled for listing and selection by customers.

View source (opens new window)

# `getMatchingShippingRule()`

The first matching shipping rule for this shipping method

View source (opens new window)

Arguments

$order

# `getName()`

Returns the name of this Shipping Method as displayed to the customer and in the control panel.

View source (opens new window)

# `getPriceForOrder()`

View source (opens new window)

Arguments

$order

# `getShippingRules()`

Returns an array of rules that meet the ShippingRules interface.

View source (opens new window)

Returns

craft\commerce\base\ShippingRuleInterface[] – The array of ShippingRules

# `getType()`

Returns the type of Shipping Method. This might be the name of the plugin or provider.

The core shipping methods have type: Custom. This is shown in the control panel only.

View source (opens new window)

# `matchOrder()`

Is this shipping method available to the order?

View source (opens new window)

Arguments

$order

← ShippingMethod ShippingRuleInterface →