deliveryCustomerDisplay

Requires permission settings:sales:read.

Returns what customers see for delivery: how they choose (all options, speeds or one price), which courier details show, the tracking level and the allowed services. These are the saved settings, or the defaults when none were saved, leaving out partners that have been removed. Requires permission to read sales settings.

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 DeliveryCustomerDisplay {
  deliveryCustomerDisplay {
    autoRule
    choiceMode
    newServicePolicy
    salesApp
    tracking
    allowedServices {
      allowed
      deliveryPartnerConfigId
      serviceKey
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DeliveryCustomerDisplay {\n  deliveryCustomerDisplay {\n    autoRule\n    choiceMode\n    newServicePolicy\n    salesApp\n    tracking\n    allowedServices {\n      allowed\n      deliveryPartnerConfigId\n      serviceKey\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "deliveryCustomerDisplay": {
      "autoRule": "CHEAPEST",
      "choiceMode": "AUTO",
      "newServicePolicy": "HOLD",
      "salesApp": "CUSTOMER",
      "tracking": "FULL",
      "allowedServices": [
        {
          "allowed": true,
          "deliveryPartnerConfigId": "id",
          "serviceKey": "string"
        }
      ]
    }
  }
}

deliveryCustomerDisplay: DeliveryCustomerDisplay!

Type

DeliveryCustomerDisplay object

What customers see for delivery: how they choose, which details show, tracking, and which partner services may be offered. Staff screens always see everything.