deliverySettings

Requires permission settings:sales:read.

Returns the delivery settings: how the delivery fee is charged, the flat fee and free-delivery thresholds, the default pickup warehouse and customer delivery emails. 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 DeliverySettings {
  deliverySettings {
    autoDeliverFromCarrier
    configured
    customerEmailOnDelivered
    customerEmailOnShipped
    defaultPickupWarehouseId
    feeMode
    defaultParcel {
      heightCm
      lengthCm
      weightKg
      widthCm
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DeliverySettings {\n  deliverySettings {\n    autoDeliverFromCarrier\n    configured\n    customerEmailOnDelivered\n    customerEmailOnShipped\n    defaultPickupWarehouseId\n    feeMode\n    defaultParcel {\n      heightCm\n      lengthCm\n      weightKg\n      widthCm\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "deliverySettings": {
      "autoDeliverFromCarrier": true,
      "configured": true,
      "customerEmailOnDelivered": true,
      "customerEmailOnShipped": true,
      "defaultPickupWarehouseId": "string",
      "feeMode": "FLAT",
      "defaultParcel": {
        "heightCm": 0,
        "lengthCm": 0,
        "weightKg": 0,
        "widthCm": 0
      }
    }
  }
}

deliverySettings: DeliverySettingsGql!

Type

DeliverySettingsGql object

The organization's delivery settings.