Deposits

Apply a Deposit Cost

A POS operating in a region where it is legally required to charge a bottle deposit should set "supplementalInfo.deposit" for each applicable product. See the example below.

Once set, it is included in the item price, but clearly marked for ordering platforms to display to customers.

An order made where a deposit applies will be marked in the payload "supplementalInfo.deposit"

📘 Note: this is an integer with 2 decimal digits, e.g., £0.15 is stored as 15.

"products": [
    {
    "name": "Cola",
    "plu": "PR05",
    "productType": 1,
    "price": 300,
    "supplementalInfo": {
        "deposit": 15
     },
    ...
},

Create a Deposit PLU

Additionally, a specific zero-price product can be synced via Insert/update products to represent a deposit.

Once this mapping is in place, whenever a deposit applies, this product will be automatically appended to the order.

For a POS, this allows for the display of a line item for the total deposit amount per order. It can also help in reporting on total deposit charges applied.

"products": [
    {
    "name": "bottle deposit",
    "plu": "BTLDEPO",
    "productType": 1,
    "price": 0,
    ..
},

How this is displayed on Deliverect