Skip to main content

UpsertDeliveryPartnerConfigInput

Saves a delivery partner. Leave out the ID to add a new partner.

input UpsertDeliveryPartnerConfigInput {
  credentials: [DeliveryPartnerKeyValueInput!]
  displayName: String
  environment: DeliveryEnvironment!
  id: ID
  providerKey: String!
  settings: [DeliveryPartnerKeyValueInput!]
  sortOrder: Int
  useForCheckout: Boolean
}

Fields​

UpsertDeliveryPartnerConfigInput.credentials ● [DeliveryPartnerKeyValueInput!] list input​

The credentials to store. For a secret field, leave it out or send an empty value to keep the stored one.

UpsertDeliveryPartnerConfigInput.displayName ● String scalar​

The name to show for the partner.

UpsertDeliveryPartnerConfigInput.environment ● DeliveryEnvironment! non-null enum​

The provider environment the credentials belong to.

UpsertDeliveryPartnerConfigInput.id ● ID scalar​

The ID of the partner to change. Leave out to add a new one.

UpsertDeliveryPartnerConfigInput.providerKey ● String! non-null scalar​

The provider key.

UpsertDeliveryPartnerConfigInput.settings ● [DeliveryPartnerKeyValueInput!] list input​

The settings to store.

UpsertDeliveryPartnerConfigInput.sortOrder ● Int scalar​

The position of the partner in lists, lowest first.

UpsertDeliveryPartnerConfigInput.useForCheckout ● Boolean scalar​

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

Member Of​

upsertDeliveryPartnerConfig mutation