DELIVERY_BAGS_CONF

Type: object Default: {} (empty — feature disabled) Validator: DeliveryBagsConfigurationSerializer Description: Configuration for the delivery bags feature in checkout.

  • is_active: Boolean (default false). Master switch. When true, enables the DeliveryBagsPage step in checkout. The page's precondition checks this value; if false the page is never shown.

  • sku: SKU of the bag product (required when is_active is true). Submitted product values are validated against this SKU.

  • per_amount: Integer (min 1, default 1). Basket amount per bag unit used when is_quantity_changeable is false to auto-calculate the number of bags.

  • min_quantity: Integer (min 0, default 0). Minimum number of bags enforced regardless of the auto-calculated value.

  • is_quantity_changeable: Boolean (default false). When true, the user can specify a custom quantity in the POST request. When false, quantity is derived from basket total divided by per_amount (floored up to min_quantity).

  • auto_run: Boolean (default false). Reserved for automatic bag processing.

  • exclude_bag_attribute_name: String. Product attribute name used to exclude specific basket items from the total amount used in bag count calculation.

Example configuration:

{
  "is_active": true,
  "sku": "DELIVERY-BAG-001",
  "per_amount": 100,
  "min_quantity": 1,
  "is_quantity_changeable": false,
  "exclude_bag_attribute_name": "exclude_from_bags"
}

Used in: DeliveryBagsPage precondition check and bag quantity calculation logic.

Last updated

Was this helpful?