API Updates
Back to All
deprecated

New attribute 'deposit' replacing 'bottleDepositPrice'

6 months ago by Ewan Farry

An update for any POS or Channel who reference bottleDepositPrice within their integration.

In regions where it's legally required to charge a bottle deposit, the previous bottleDepositPrice value is now being deprecated, to be replaced with supplementalInfo.deposit

This is to account for varying legal requirements globally to charge a deposit for items others than bottles.

POS Product Changes

It will no longer be possible to set the value bottleDepositPrice as part of a product sync, instead, the below supplementalInfo.deposit should be used (more information in this guide)

"products": [  
    {  
    "name": "Cola",  
    "supplementalInfo": {  
        "deposit": 15  
},
ⓘ POS Order Unchanged We will continue to communicate any "deposit" within the POS order as "bottleDepositPrice"

Channel - Menu Changes

Published menus will no longer display the attribute bottleDepositPrice instead the below supplementalInfo.deposit should be referenced (more information in this guide)

"products": {  
    "66****01b": {  
    "_id": "66*****01b",  
    "name": "Coke",  
     "supplementalInfo": {  
         "deposit": 15  
 }

📘 Note: supplementalInfo.deposit is an integer with 2 decimal digits e.g. €0.25 is stored as 25


📆 Deprecation Date Deliverect will deprecate the attribute bottleDepositPrice with supplementalInfo.deposit replacing this on September 9th 2024