DeliveryMethodDefinitionInput

Version 2019-07

Input fields for a method definition.

Show definition
"""
Input fields for a method definition.
"""
input DeliveryMethodDefinitionInput {
  """
  Whether or not to use this method definition during rate calculation.
  """
  active: Boolean
  """
  Conditions on the method definition to update.
  """
  conditionsToUpdate: [DeliveryUpdateConditionInput!]
  """
  The description of the method definition.
  """
  description: String
  """
  Globally unique identifier of the method definition. Use only when updating a method definiton.
  """
  id: ID
  """
  The name of the method definition.
  """
  name: String
  """
  A participant to apply to the method definition.
  """
  participant: DeliveryParticipantInput
  """
  Price conditions on the method definition.
  """
  priceConditionsToCreate: [DeliveryPriceConditionInput!]
  """
  A rate definition to apply to the method definition.
  """
  rateDefinition: DeliveryRateDefinitionInput
  """
  Weight conditions on the method definition.
  """
  weightConditionsToCreate: [DeliveryWeightConditionInput!]
}

Input Fields

active (Boolean)

Whether or not to use this method definition during rate calculation.

conditionsToUpdate ([DeliveryUpdateConditionInput!])

Conditions on the method definition to update.

description (String)

The description of the method definition.

id (ID)

Globally unique identifier of the method definition. Use only when updating a method definiton.

name (String)

The name of the method definition.

participant (DeliveryParticipantInput)

A participant to apply to the method definition.

priceConditionsToCreate ([DeliveryPriceConditionInput!])

Price conditions on the method definition.

rateDefinition (DeliveryRateDefinitionInput)

A rate definition to apply to the method definition.

weightConditionsToCreate ([DeliveryWeightConditionInput!])

Weight conditions on the method definition.

Version 2019-10 (Latest)

Input fields for a method definition.

Show definition
"""
Input fields for a method definition.
"""
input DeliveryMethodDefinitionInput {
  """
  Whether or not to use this method definition during rate calculation.
  """
  active: Boolean
  """
  Conditions on the method definition to update.
  """
  conditionsToUpdate: [DeliveryUpdateConditionInput!]
  """
  The description of the method definition.
  """
  description: String
  """
  Globally unique identifier of the method definition. Use only when updating a method definiton.
  """
  id: ID
  """
  The name of the method definition.
  """
  name: String
  """
  A participant to apply to the method definition.
  """
  participant: DeliveryParticipantInput
  """
  Price conditions on the method definition.
  """
  priceConditionsToCreate: [DeliveryPriceConditionInput!]
  """
  A rate definition to apply to the method definition.
  """
  rateDefinition: DeliveryRateDefinitionInput
  """
  Weight conditions on the method definition.
  """
  weightConditionsToCreate: [DeliveryWeightConditionInput!]
}

Input Fields

active (Boolean)

Whether or not to use this method definition during rate calculation.

conditionsToUpdate ([DeliveryUpdateConditionInput!])

Conditions on the method definition to update.

description (String)

The description of the method definition.

id (ID)

Globally unique identifier of the method definition. Use only when updating a method definiton.

name (String)

The name of the method definition.

participant (DeliveryParticipantInput)

A participant to apply to the method definition.

priceConditionsToCreate ([DeliveryPriceConditionInput!])

Price conditions on the method definition.

rateDefinition (DeliveryRateDefinitionInput)

A rate definition to apply to the method definition.

weightConditionsToCreate ([DeliveryWeightConditionInput!])

Weight conditions on the method definition.

Version 2020-01 (Release candidate)

Input fields for a method definition.

Show definition
"""
Input fields for a method definition.
"""
input DeliveryMethodDefinitionInput {
  """
  Whether or not to use this method definition during rate calculation.
  """
  active: Boolean
  """
  Conditions on the method definition to update.
  """
  conditionsToUpdate: [DeliveryUpdateConditionInput!]
  """
  The description of the method definition.
  """
  description: String
  """
  Globally unique identifier of the method definition. Use only when updating a method definiton.
  """
  id: ID
  """
  The name of the method definition.
  """
  name: String
  """
  A participant to apply to the method definition.
  """
  participant: DeliveryParticipantInput
  """
  Price conditions on the method definition.
  """
  priceConditionsToCreate: [DeliveryPriceConditionInput!]
  """
  A rate definition to apply to the method definition.
  """
  rateDefinition: DeliveryRateDefinitionInput
  """
  Weight conditions on the method definition.
  """
  weightConditionsToCreate: [DeliveryWeightConditionInput!]
}

Input Fields

active (Boolean)

Whether or not to use this method definition during rate calculation.

conditionsToUpdate ([DeliveryUpdateConditionInput!])

Conditions on the method definition to update.

description (String)

The description of the method definition.

id (ID)

Globally unique identifier of the method definition. Use only when updating a method definiton.

name (String)

The name of the method definition.

participant (DeliveryParticipantInput)

A participant to apply to the method definition.

priceConditionsToCreate ([DeliveryPriceConditionInput!])

Price conditions on the method definition.

rateDefinition (DeliveryRateDefinitionInput)

A rate definition to apply to the method definition.

weightConditionsToCreate ([DeliveryWeightConditionInput!])

Weight conditions on the method definition.

Sign up for a Partner account to get started.

Sign up