bookableDeliveryPartners

Requires permission sales:sales_order:ship.

Lists the enabled delivery partners that staff can book a shipment with, without secrets or settings, for the ship dialog and the return pickup picker. Needs the delivery partners plan feature and permission to ship sales orders.

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 BookableDeliveryPartners {
  bookableDeliveryPartners {
    id
    displayName
    capabilities
    environment
    kind
    logoUrl
    pickupWindowRules {
      maxDaysAhead
      minDurationMinutes
      minLeadMinutes
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query BookableDeliveryPartners {\n  bookableDeliveryPartners {\n    id\n    displayName\n    capabilities\n    environment\n    kind\n    logoUrl\n    pickupWindowRules {\n      maxDaysAhead\n      minDurationMinutes\n      minLeadMinutes\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "bookableDeliveryPartners": [
      {
        "id": "id",
        "displayName": "string",
        "capabilities": [
          "string"
        ],
        "environment": "LIVE",
        "kind": "string",
        "logoUrl": "string",
        "pickupWindowRules": {
          "maxDaysAhead": 0,
          "minDurationMinutes": 0,
          "minLeadMinutes": 0
        }
      }
    ]
  }
}

bookableDeliveryPartners: [BookableDeliveryPartnerGql!]!

Type

BookableDeliveryPartnerGql object

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