deliveryPartnerProviders

Requires permission settings:integration:read.

Lists the delivery partners (couriers) the workspace can connect, each with what it declares: what it can do, its credential and settings fields, the countries and currencies it serves, and how its webhooks authenticate. Requires permission to read integrations.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query DeliveryPartnerProviders {
  deliveryPartnerProviders {
    displayName
    capabilities
    description
    key
    kind
    logoUrl
    credentialFields {
      helpText
      key
      label
      placeholder
      secret
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DeliveryPartnerProviders {\n  deliveryPartnerProviders {\n    displayName\n    capabilities\n    description\n    key\n    kind\n    logoUrl\n    credentialFields {\n      helpText\n      key\n      label\n      placeholder\n      secret\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "deliveryPartnerProviders": [
      {
        "displayName": "string",
        "capabilities": [
          "string"
        ],
        "description": "string",
        "key": "string",
        "kind": "string",
        "logoUrl": "string",
        "credentialFields": [
          {
            "helpText": "string",
            "key": "string",
            "label": "string",
            "placeholder": "string",
            "secret": true
          }
        ]
      }
    ]
  }
}

deliveryPartnerProviders: [DeliveryPartnerProviderInfo!]!

Type

DeliveryPartnerProviderInfo object

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