mobileDeliveryOptions

Requires a customer (portal or buyer app) session.

P6: live delivery options for the buyer's cart to one of their addresses. FLAT stores return mode FLAT and no options (the bill carries the fee). LIVE_QUOTE stores return priced options whose id is passed back as deliveryOptionId on mobileCartBill and on placement; code NO_DELIVERY_OPTIONS means delivery is unavailable to this address.

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 MobileDeliveryOptions($addressId: ID!) {
  mobileDeliveryOptions(addressId: $addressId) {
    code
    choiceMode
    mode
    retryable
    options {
      id
      carrierName
      partnerName
      serviceLevelName
      autoSelected
      boxCount
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query MobileDeliveryOptions($addressId: ID!) {\n  mobileDeliveryOptions(addressId: $addressId) {\n    code\n    choiceMode\n    mode\n    retryable\n    options {\n      id\n      carrierName\n      partnerName\n      serviceLevelName\n      autoSelected\n      boxCount\n    }\n  }\n}",
  "variables": {
    "addressId": "id"
  }
}
EOF

Variables:

{
  "addressId": "id"
}

Response:

{
  "data": {
    "mobileDeliveryOptions": {
      "code": "string",
      "choiceMode": "AUTO",
      "mode": "FLAT",
      "retryable": true,
      "options": [
        {
          "id": "id",
          "carrierName": "string",
          "partnerName": "string",
          "serviceLevelName": "string",
          "autoSelected": true,
          "boxCount": 0
        }
      ]
    }
  }
}

mobileDeliveryOptions(
  addressId: ID!
): CheckoutDeliveryOptions!

Arguments

mobileDeliveryOptions.addressId ● ID! non-null scalar

The ID of the address.

Type

CheckoutDeliveryOptions object

Delivery choices for checkout. FLAT: no options, the bill carries the fee. LIVE_QUOTE: the buyer must pick one option; code NO_DELIVERY_OPTIONS means delivery is unavailable to this address; DELIVERY_FREIGHT_QUOTE means the order is too heavy to price live — it may be placed with no delivery option and the store quotes delivery afterwards.