deliveryPackingSettings

Requires permission settings:sales:read.

Returns the organization's box packing settings, or the defaults with no boxes when none were saved. 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 DeliveryPackingSettings {
  deliveryPackingSettings {
    fillPercent
    fragileFillPercent
    freightQuoteAboveKg
    maxBoxes
    maxBoxesPerOrder
    showBoxCountToCustomers
    boxes {
      id
      name
      costPerBox
      defaultWeightKg
      enabled
      heightCm
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DeliveryPackingSettings {\n  deliveryPackingSettings {\n    fillPercent\n    fragileFillPercent\n    freightQuoteAboveKg\n    maxBoxes\n    maxBoxesPerOrder\n    showBoxCountToCustomers\n    boxes {\n      id\n      name\n      costPerBox\n      defaultWeightKg\n      enabled\n      heightCm\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "deliveryPackingSettings": {
      "fillPercent": 0,
      "fragileFillPercent": 0,
      "freightQuoteAboveKg": 0,
      "maxBoxes": 0,
      "maxBoxesPerOrder": 0,
      "showBoxCountToCustomers": true,
      "boxes": [
        {
          "id": "string",
          "name": "string",
          "costPerBox": "string",
          "defaultWeightKg": 0,
          "enabled": true,
          "heightCm": 0
        }
      ]
    }
  }
}

deliveryPackingSettings: DeliveryPackingSettings!

Type

DeliveryPackingSettings object

Settings → Shipment → Boxes. With no enabled box, delivery quotes use the single default parcel exactly as before.