updateDeliveryPackingSettings

Requires permission settings:sales:update.

Saves the box packing settings, in centimetres and kilograms. They take effect at the next delivery quote. Needs the delivery partners plan feature and permission to update 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

mutation UpdateDeliveryPackingSettings($input: UpdateDeliveryPackingSettingsInput!) {
  updateDeliveryPackingSettings(input: $input) {
    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": "mutation UpdateDeliveryPackingSettings($input: UpdateDeliveryPackingSettingsInput!) {\n  updateDeliveryPackingSettings(input: $input) {\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}",
  "variables": {
    "input": {}
  }
}
EOF

Variables:

{
  "input": {}
}

Response:

{
  "data": {
    "updateDeliveryPackingSettings": {
      "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
        }
      ]
    }
  }
}

updateDeliveryPackingSettings(
  input: UpdateDeliveryPackingSettingsInput!
): DeliveryPackingSettings!

Arguments

updateDeliveryPackingSettings.input ● UpdateDeliveryPackingSettingsInput! non-null input

The units, boxes, fill percentages, volumetric divisor, default item and limits.

Type

DeliveryPackingSettings object

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