Skip to main content

BookableDeliveryPartnerGql

An enabled delivery partner staff may book with. It carries no credentials, settings or webhook detail.

type BookableDeliveryPartnerGql {
  capabilities: [String!]!
  displayName: String!
  environment: DeliveryEnvironment!
  id: ID!
  kind: String!
  logoUrl: String
  pickupWindowRules: PickupWindowRules
  providerKey: String!
}

Fields​

BookableDeliveryPartnerGql.capabilities ● [String!]! non-null scalar​

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

BookableDeliveryPartnerGql.displayName ● String! non-null scalar​

The name of the partner.

BookableDeliveryPartnerGql.environment ● DeliveryEnvironment! non-null enum​

The provider environment.

BookableDeliveryPartnerGql.id ● ID! non-null scalar​

The unique ID of this record.

BookableDeliveryPartnerGql.kind ● String! non-null scalar​

API when the system books with the provider, MANUAL for a custom courier.

BookableDeliveryPartnerGql.logoUrl ● String scalar​

The partner's logo, or empty to show a monogram.

BookableDeliveryPartnerGql.pickupWindowRules ● PickupWindowRules object​

The limits on a pickup window. Empty when the partner takes no pickup time.

BookableDeliveryPartnerGql.providerKey ● String! non-null scalar​

The provider key.

Returned By​

bookableDeliveryPartners query