Configuration

Container deposits are configured in the tenant settings under Configuration → Settings → Products → Container deposit (pant). The settings hold the master switch, the policy for orders from external channels and the deposit types. Amounts and VAT are not configured here; they live on the deposit articles the deposit types point to.

Enable container deposits

"DepositSettings": {
  "IsEnabled": true,
  "InboundOrderHandling": "TagOnly",
  "DepositTypes": [
    {
      "Code": "PANT2",
      "Name": "Pant 2 kr",
      "DepositSkuId": "PANT-NO-2",
      "MarketOverrides": [
        { "MarketId": "se", "DepositSkuId": "PANT-SE-2" }
      ],
      "IsActive": true
    },
    {
      "Code": "PANT3",
      "Name": "Pant 3 kr",
      "DepositSkuId": "PANT-NO-3",
      "MarketOverrides": [],
      "IsActive": true
    }
  ]
}

Deposit types

Each deposit type is one deposit class, such as the Norwegian 2 kr and 3 kr classes or the Danish pant A, B and C. Products reference a deposit type by its code.

How the deposit article is chosen

For an order in a given market, the deposit type's article is the market override for that market when one is set, otherwise depositSkuId. A type with neither for that market gives no deposit line on that order, and a warning is written to the log. The Validation tab reports the type, see Validation.

Presets

While the list is empty, the editor offers Insert Norwegian preset, Insert Swedish preset and Insert Danish preset. A preset only seeds the deposit type rows. You still create the deposit articles it names, with their prices and tax group, or point the rows at articles you already have.

Article check in the editor

As you type an article SKU, the editor looks it up in the catalogue and shows a warning on the row when the deposit type has no article, when the article does not exist, or when it has no price. The same problems are reported on the Validation tab when the settings are saved.

Deposit articles

A deposit article is an ordinary product. Create one per deposit class, and one per market when the same class uses different articles per country.

• It must exist as a product or a variant with the SKU the deposit type names. The SKU is also matched against the product's ID and product ID.
• It needs a price in every market the deposit is charged in, or a price that applies to every market. The deposit line's amount is the article's price for the order's market. An article without a price gives a deposit of zero. Tenants on external prices are not checked for prices.
• Its tax group or tax rate decides the VAT on the deposit. See Tax on deposits.
• It needs no stock. Deposit lines never update inventory and never create purchase orders.
• Its own product type is not used. A deposit line's product type is always ContainerDeposit.

A government rate change is a price change on the deposit article: add the new price with its valid-from date. Deposit lines already on orders are price locked and keep what the customer paid.

Tax on deposits

The deposit line takes the tax of the price it is priced from. With tax groups enabled, the article's tax group gives the line its tax group code, external VAT code and rate; without tax groups, the article's tax rate is used, otherwise the market's default rate. In a market where tax is excluded from the cart total, the deposit line is priced excluding tax at rate 0; with tax groups enabled, the article's tax group still gives the line its code, external VAT code and rate.

• Norway. Pant is kept outside the VAT base as long as it is its own line on the receipt and kept apart in the accounts. Give the article a 0 % tax group marked outside VAT scope, such as PANT from the Norwegian preset in Tax Groups, or a tax rate of 0. When a deposit article prices deposits in a market with country code NO at a VAT rate above zero, saving the settings reports a warning naming the article, the deposit type, the market and the rate.
• Other countries normally charge VAT on deposits. Give the article the tax group your accountant specifies.

See Prices and Tax for how prices carry tax.

Orders from external channels

An order received from outside Omnium, for example through the Order API or a connector, is normally paid already. The Orders from external channels setting decides what Omnium does with its deposits.

Every policy tags deposit lines. When the order is received, each line whose SKU is one of the active deposit types' articles, base or market override, is marked as a deposit line: its productType becomes ContainerDeposit, it is excluded from promotions and member prices, the property ContainerDepositType records the deposit type, and when tax groups are enabled and the line has no tax group code, the article's tax group is applied. Prices are left as the channel sent them.

Warnings are listed on the order. See Order errors.

Deposit fields on products

When container deposits are enabled, the product's Settings tab shows a Deposit section:

A variant can have its own deposit type and deposit units. When set, they replace the parent product's values for that variant. The same fields are available on the Product API.

Changing a product's deposit type or deposit units affects carts on their next update. Orders keep their deposits as charged.

Validation

The Validation tab of the tenant settings lists container deposit problems as warnings of the type Container deposits, each linking to the deposit settings. They never block saving, so a half-configured deposit setup does not stop you from saving other settings.

Related pages

• Container Deposits — how deposit lines behave in carts, orders, returns and reports.
• API Reference — the product fields and the deposit line JSON.
• Tax Groups — the PANT tax group and how a line gets its tax group.