Skip to main content
Anchor to DeliveryMethodDefinition

DeliveryMethodDefinition

object

Requires Any of assigned_shipping or shipping access scopes or manage_delivery_settings user permission.

A method definition contains the delivery rate and the conditions that must be met for the method to be applied.

•Boolean!
non-null

Whether this method definition is active.

•CurrencyCode

The currency used in this method definition.

•String

The description of the method definition. Only available on shipping rates that are custom.

•[DeliveryRateRangeCondition!]!
non-null

The conditions that must pass for free delivery to be applied to an order.

•ID!
non-null

A globally-unique ID.

•[DeliveryCondition!]!
non-null

The method conditions that must pass for this method definition to be applied to an order.

•String!
non-null

The name of the method definition.

•DeliveryRateGroupConnection

The rate groups that make up this method definition.

Arguments

•Int

The first n elements from the paginated list.

•String

The elements that come after the specified cursor.

•Int

The last n elements from the paginated list.

•String

The elements that come before the specified cursor.

•Boolean
Default:false

Reverse the order of the underlying list.


•DeliveryRateProvider!
non-null

The provided rate for this method definition, from a rate definition or participant.


Was this section helpful?

•interface

Was this section helpful?