Skip to main content

CheckoutDeliveryUnavailable

A delivery partner that could not price this delivery, and why.

type CheckoutDeliveryUnavailable {
  carrierName: String
  code: String
  partnerName: String
  reason: String!
  retryable: Boolean!
}

Fields​

CheckoutDeliveryUnavailable.carrierName ● String scalar​

The courier inside an aggregator that refused (staff screens only); null for the whole partner.

CheckoutDeliveryUnavailable.code ● String scalar​

Machine-readable reason: QUOTES_NOT_SUPPORTED, COUNTRY_NOT_SERVED, CURRENCY_NOT_SUPPORTED, ADDRESS_INCOMPLETE, NO_PRICE, TIMEOUT, PROVIDER_ERROR, CREDENTIALS_UNREADABLE, CARRIER_REFUSED, NO_PICKUP_ADDRESS, DESTINATION_INCOMPLETE, PARCEL_LIMIT_EXCEEDED.

CheckoutDeliveryUnavailable.partnerName ● String scalar​

The partner's name; null when the reason applies to every partner (e.g. an incomplete address).

CheckoutDeliveryUnavailable.reason ● String! non-null scalar​

English fallback text. Clients should translate by code when they know it.

CheckoutDeliveryUnavailable.retryable ● Boolean! non-null scalar​

Asking again may succeed (a timeout or the provider's own outage).

Member Of​

CheckoutDeliveryOptions object ● StaffDeliveryOptions object