deliveryBoxPresets

Requires permission settings:sales:read.

Lists the standard box sizes offered when adding a box. 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 DeliveryBoxPresets {
  deliveryBoxPresets {
    name
    heightCm
    key
    lengthCm
    maxWeightKg
    tareWeightKg
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DeliveryBoxPresets {\n  deliveryBoxPresets {\n    name\n    heightCm\n    key\n    lengthCm\n    maxWeightKg\n    tareWeightKg\n  }\n}"
}
EOF

Response:

{
  "data": {
    "deliveryBoxPresets": [
      {
        "name": "string",
        "heightCm": 0,
        "key": "string",
        "lengthCm": 0,
        "maxWeightKg": 0,
        "tareWeightKg": 0
      }
    ]
  }
}

deliveryBoxPresets: [DeliveryBoxPreset!]!

Type

DeliveryBoxPreset object

A standard box size for the Boxes dropdown (common general sizes, not any courier's list; cm / kg).