Skip to main content

DeliveryPartnerSettingsField

One setting a delivery provider offers.

type DeliveryPartnerSettingsField {
  helpText: String
  key: String!
  label: String!
  options: [DeliveryPartnerFieldOption!]
  placeholder: String
  required: Boolean
  type: String!
  visibleWhen: DeliveryPartnerFieldVisibility
}

Fields​

DeliveryPartnerSettingsField.helpText ● String scalar​

Guidance on what the setting does.

DeliveryPartnerSettingsField.key ● String! non-null scalar​

The name of the setting.

DeliveryPartnerSettingsField.label ● String! non-null scalar​

The label to show for the setting.

DeliveryPartnerSettingsField.options ● [DeliveryPartnerFieldOption!] list object​

The choices of a select setting.

DeliveryPartnerSettingsField.placeholder ● String scalar​

An example value to show in the empty field.

DeliveryPartnerSettingsField.required ● Boolean scalar​

True when the setting must be filled in.

DeliveryPartnerSettingsField.type ● String! non-null scalar​

The kind of input: text, number, boolean, select, url-template, money, image or rate-card.

DeliveryPartnerSettingsField.visibleWhen ● DeliveryPartnerFieldVisibility object​

The condition that shows the setting. Always shown when empty.

Member Of​

DeliveryPartnerProviderInfo object