Choose a version:

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.

Anchor to FieldsFields

Anchor to activeactive •Boolean! non-null: Whether this method definition is active.
Anchor to descriptiondescription •String: The description of the method definition. Only available on shipping rates that are custom.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to methodConditionsmethodConditions •[DeliveryCondition!]! non-null: The method conditions that must pass for this method definition to be applied to an order.
Anchor to namename •String! non-null: The name of the method definition.
Anchor to rateProviderrateProvider •DeliveryRateProvider! non-null: The provided rate for this method definition, from a rate definition or participant.

Was this section helpful?

Was this section helpful?