DeliveryPartnerProviderInfo

What a delivery provider declares about itself: the credentials and settings it needs, and what it supports. The admin page is built from this.

type DeliveryPartnerProviderInfo {
  capabilities: [String!]!
  credentialFields: [DeliveryPartnerCredentialField!]!
  description: String!
  displayName: String!
  key: String!
  kind: String!
  logoUrl: String
  multipleAllowed: Boolean!
  settingsFields: [DeliveryPartnerSettingsField!]!
  supportedCountries: [String!]
  supportedCurrencies: [String!]
  webhookAuth: String!
}

Fields

DeliveryPartnerProviderInfo.capabilities ● [String!]! non-null scalar

What the provider supports, such as RATES, BOOKING or RETURNS.

DeliveryPartnerProviderInfo.credentialFields ● [DeliveryPartnerCredentialField!]! non-null object

The credentials to collect.

DeliveryPartnerProviderInfo.description ● String! non-null scalar

What the provider is.

DeliveryPartnerProviderInfo.displayName ● String! non-null scalar

The provider's name.

DeliveryPartnerProviderInfo.key ● String! non-null scalar

The provider key.

DeliveryPartnerProviderInfo.kind ● String! non-null scalar

API when the system books with the provider, MANUAL for a custom courier whose status staff record by hand.

DeliveryPartnerProviderInfo.logoUrl ● String scalar

The provider's built-in logo, or empty to show a monogram.

DeliveryPartnerProviderInfo.multipleAllowed ● Boolean! non-null scalar

True when the provider can be set up more than once, as custom couriers can.

DeliveryPartnerProviderInfo.settingsFields ● [DeliveryPartnerSettingsField!]! non-null object

The settings to collect.

DeliveryPartnerProviderInfo.supportedCountries ● [String!] list scalar

The countries the provider serves.

DeliveryPartnerProviderInfo.supportedCurrencies ● [String!] list scalar

The currencies the provider quotes in.

DeliveryPartnerProviderInfo.webhookAuth ● String! non-null scalar

How the provider's webhooks are authenticated: HMAC, URL_TOKEN or NONE.

Returned By

deliveryPartnerProviders query