updateDeliveryCustomerDisplay

Requires permission settings:sales:update.

Saves how delivery options are shown to customers. Omitted fields keep their saved value, and choosing full tracking also shows the courier name. It takes effect at the next options request. Needs the delivery partners plan feature and permission to update 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

mutation UpdateDeliveryCustomerDisplay($input: UpdateDeliveryCustomerDisplayInput!) {
  updateDeliveryCustomerDisplay(input: $input) {
    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": "mutation UpdateDeliveryCustomerDisplay($input: UpdateDeliveryCustomerDisplayInput!) {\n  updateDeliveryCustomerDisplay(input: $input) {\n    autoRule\n    choiceMode\n    newServicePolicy\n    salesApp\n    tracking\n    allowedServices {\n      allowed\n      deliveryPartnerConfigId\n      serviceKey\n    }\n  }\n}",
  "variables": {
    "input": {}
  }
}
EOF

Variables:

{
  "input": {}
}

Response:

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

updateDeliveryCustomerDisplay(
  input: UpdateDeliveryCustomerDisplayInput!
): DeliveryCustomerDisplay!

Arguments

updateDeliveryCustomerDisplay.input ● UpdateDeliveryCustomerDisplayInput! non-null input

The display settings to change.

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.