deliveryCustomerDisplayPreview

Requires permission settings:sales:read.

Previews, without saving anything, what customers and staff would see for one address under the display settings given: live carrier prices shaped for each app, plus the staff list. No option is redeemed and nothing is recorded. It calls the carriers, so it needs the delivery partners plan feature, and 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 DeliveryCustomerDisplayPreview($input: DeliveryCustomerDisplayPreviewInput!) {
  deliveryCustomerDisplayPreview(input: $input) {
    buyerApp {
      code
      choiceMode
      mode
      retryable
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DeliveryCustomerDisplayPreview($input: DeliveryCustomerDisplayPreviewInput!) {\n  deliveryCustomerDisplayPreview(input: $input) {\n    buyerApp {\n      code\n      choiceMode\n      mode\n      retryable\n    }\n  }\n}",
  "variables": {
    "input": {
      "addressId": "id"
    }
  }
}
EOF

Variables:

{
  "input": {
    "addressId": "id"
  }
}

Response:

{
  "data": {
    "deliveryCustomerDisplayPreview": {
      "buyerApp": {
        "code": "string",
        "choiceMode": "AUTO",
        "mode": "FLAT",
        "retryable": true
      }
    }
  }
}

deliveryCustomerDisplayPreview(
  input: DeliveryCustomerDisplayPreviewInput!
): DeliveryCustomerDisplayPreview!

Arguments

deliveryCustomerDisplayPreview.input ● DeliveryCustomerDisplayPreviewInput! non-null input

The address, an optional customer, and the unsaved display settings to preview.

Type

DeliveryCustomerDisplayPreview object

Live prices for one address, shaped exactly as each surface would get them under the given settings. Read-only: no option id redeems, nothing is recorded.