Skip to main content

DeliveryPartnerConfigGql

A delivery partner the organization has set up. Secret credentials are never returned.

type DeliveryPartnerConfigGql {
  available: Boolean!
  configuredSecretKeys: [String!]!
  displayName: String!
  environment: DeliveryEnvironment!
  id: ID!
  isEnabled: Boolean!
  logoUrl: String
  nonSecretValues: [DeliveryPartnerKeyValue!]!
  providerKey: String!
  settingsValues: [DeliveryPartnerKeyValue!]!
  slug: String!
  sortOrder: Int!
  updatedAt: DateTime!
  useForCheckout: Boolean!
  verification: DeliveryPartnerVerification!
  webhookUrl: String
}

Fields

`DeliveryPartnerConfigGql.available` ● `Boolean!` non-null scalar

False when the provider's adapter is no longer installed. The partner is then read-only.

`DeliveryPartnerConfigGql.configuredSecretKeys` ● `[String!]!` non-null scalar

The secret credential fields that have a stored value. The values themselves are never returned.

`DeliveryPartnerConfigGql.displayName` ● `String!` non-null scalar

The name to show for the partner.

`DeliveryPartnerConfigGql.environment` ● `DeliveryEnvironment!` non-null enum

The provider environment the credentials belong to.

`DeliveryPartnerConfigGql.id` ● `ID!` non-null scalar

The unique ID of this record.

`DeliveryPartnerConfigGql.isEnabled` ● `Boolean!` non-null scalar

True when the partner is offered at checkout and to staff.

`DeliveryPartnerConfigGql.logoUrl` ● `String` scalar

The partner's own uploaded logo, else the provider's built-in logo, else empty.

`DeliveryPartnerConfigGql.nonSecretValues` ● `[DeliveryPartnerKeyValue!]!` non-null object

The non-secret credential fields with their values.

`DeliveryPartnerConfigGql.providerKey` ● `String!` non-null scalar

The provider key.

`DeliveryPartnerConfigGql.settingsValues` ● `[DeliveryPartnerKeyValue!]!` non-null object

The partner's settings with their values.

`DeliveryPartnerConfigGql.slug` ● `String!` non-null scalar

The short name of the partner, used in URLs.

`DeliveryPartnerConfigGql.sortOrder` ● `Int!` non-null scalar

The position of the partner in lists, lowest first.

`DeliveryPartnerConfigGql.updatedAt` ● `DateTime!` non-null scalar

When the record was last changed.

`DeliveryPartnerConfigGql.useForCheckout` ● `Boolean!` non-null scalar

Legacy, ignored: every enabled partner is offered at checkout (2026-10-13).

`DeliveryPartnerConfigGql.verification` ● `DeliveryPartnerVerification!` non-null object

The result of the last verification.

`DeliveryPartnerConfigGql.webhookUrl` ● `String` scalar

The webhook URL to paste into the provider's dashboard. Empty when the provider has no webhooks.

Returned By

deliveryPartnerConfigs query ● reorderDeliveryPartners mutation ● setDeliveryPartnerEnabled mutation ● upsertDeliveryPartnerConfig mutation

Fields
Returned By