Configuration

The plugin has no config/container-deposits.php file - everything gets configured through the control panel.

Field layout

The Container Deposit Type field needs a home somewhere on the purchasable's field layout. For most stores that's the Variant field layout:

  1. Commerce → System Settings → Product Types → [Your type]
  2. Open the Variants tab (or Product tab if your products aren't variant-based).
  3. Drag Container Deposit Type into the layout.
  4. Save.

The field stores the selected DepositType ID. The cart listener looks up the field on each line item's purchasable, so the field's handle can be whatever you like.

Containers Per Unit field (optional)

If you sell multipacks (a 6-pack, a tray of 24 cans), add the Containers Per Unit (Deposit) field to the same layout. It tells the plugin how many deposit-bearing containers sit inside one unit, so a 6-pack charges six deposits instead of one. Leave it off and every unit just gets a single deposit. See Product Card & Page Display for the full walkthrough.

Tax category

Container Deposits (No VAT) gets created automatically on install and has no tax rates attached. Delete it and deposits fall back to the store default category - re-running the install migration brings it back.

See VAT Treatment for details.

Currency

Deposit amounts are stored as floats and shown using your active store currency. Set this under Commerce → System Settings → Stores.