DeliveryMethodDefinition

Version 2019-07

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

Required access

read_shipping access scope

Show definition
"""
A method definition describes the delivery rate and the conditions that must be met for the method to be applied.
"""
type DeliveryMethodDefinition implements Node {
  """
  Whether this method definition is active.
  """
  active: Boolean!
  """
  The description of the method definition.
  """
  description: String
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The method conditions that must pass for this method definition to be applied to an order.
  """
  methodConditions: [DeliveryCondition!]!
  """
  The name of the method definition.
  """
  name: String!
  """
  Provided rate for this method definition, from a rate definition or participant.
  """
  rateProvider: DeliveryRateProvider!
}

Implements

Fields

active (Boolean!)

Whether this method definition is active.

description (String)

The description of the method definition.

id (ID!)

Globally unique identifier.

methodConditions ([DeliveryCondition!]!)

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

name (String!)

The name of the method definition.

rateProvider (DeliveryRateProvider!)

Provided rate for this method definition, from a rate definition or participant.

Version 2019-10 (Latest)

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

Required access

read_shipping access scope

Show definition
"""
A method definition describes the delivery rate and the conditions that must be met for the method to be applied.
"""
type DeliveryMethodDefinition implements Node {
  """
  Whether this method definition is active.
  """
  active: Boolean!
  """
  The description of the method definition.
  """
  description: String
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The method conditions that must pass for this method definition to be applied to an order.
  """
  methodConditions: [DeliveryCondition!]!
  """
  The name of the method definition.
  """
  name: String!
  """
  Provided rate for this method definition, from a rate definition or participant.
  """
  rateProvider: DeliveryRateProvider!
}

Implements

Fields

active (Boolean!)

Whether this method definition is active.

description (String)

The description of the method definition.

id (ID!)

Globally unique identifier.

methodConditions ([DeliveryCondition!]!)

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

name (String!)

The name of the method definition.

rateProvider (DeliveryRateProvider!)

Provided rate for this method definition, from a rate definition or participant.

Version 2020-01 (Release candidate)

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

Required access

read_shipping access scope

Show definition
"""
A method definition describes the delivery rate and the conditions that must be met for the method to be applied.
"""
type DeliveryMethodDefinition implements Node {
  """
  Whether this method definition is active.
  """
  active: Boolean!
  """
  The description of the method definition.
  """
  description: String
  """
  Globally unique identifier.
  """
  id: ID!
  """
  The method conditions that must pass for this method definition to be applied to an order.
  """
  methodConditions: [DeliveryCondition!]!
  """
  The name of the method definition.
  """
  name: String!
  """
  Provided rate for this method definition, from a rate definition or participant.
  """
  rateProvider: DeliveryRateProvider!
}

Implements

Fields

active (Boolean!)

Whether this method definition is active.

description (String)

The description of the method definition.

id (ID!)

Globally unique identifier.

methodConditions ([DeliveryCondition!]!)

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

name (String!)

The name of the method definition.

rateProvider (DeliveryRateProvider!)

Provided rate for this method definition, from a rate definition or participant.

Sign up for a Partner account to get started.

Sign up