Managing Deposit Types

Deposit types are the admin-managed list of deposits available for assignment to products.

Create a deposit type

  1. Go to Container Deposits → Deposit Types.
  2. Click New Deposit Type.
  3. Fill in:
    1. Name - shown on the line item in the cart (e.g. Can Deposit, Container Deposits).
    2. Handle - internal identifier, used for the deposit purchasable's SKU. Must start with a letter; camelCase recommended. Handles must be unique - reusing one shows a validation error instead of saving.
    3. Amount - the deposit value in the store currency (e.g. 0.15 for €0.15). 0.00 is allowed, useful for a promotional or "free return" tier that still needs its own line item.
  4. Click Save.

When you save, the plugin also creates (or updates) a hidden DepositPurchasable element that stands in for the deposit in the cart.

Edit a deposit type

Click any row on the index page. Changing the Amount updates the price on every future cart calculation. Existing carts pick up the new price the next time they recalculate.

Warning

Changing a deposit's handle updates the SKU used on future line items. Existing line items keep their original SKU in the order snapshot.

Delete a deposit type

Click the X icon on the index page. The matching DepositPurchasable element gets deleted alongside the type.

Line items previously created from a deleted deposit stay on completed orders for reporting purposes, but the purchasableId foreign key is set to null.

Suggested setup for Re-turn (Ireland)

NameHandleAmount
15c smallContainer 0.15
25c largeContainer 0.25

These match the official tiers published by Re-turn for the period beginning February 2024 (150 ml – 500 ml = €0.15; over 500 ml – 3 L = €0.25).