Skip to main content

Deposit rule

Deposit Rule

A deposit rule defines the rules by which a deposit can be connected to the purchase of specific items. The deposit rule describes the amount of deposit that shall be added to the receipt when a specific item is sold during checkout.

E.g. a bottle of water has a deposit for the plastic bottle and an amount (price + VAT) that is added to the transaction, when the empty bottle is returned to the same or any other store the deposit amount is returned to the customer.

Extenda Retail has chosen to not follow the exact standard for deposits according to GS1, where the specification expects a price entity. We find it more precise to be specific and use a Deposit Rule entity instead. This entity contains the needed information to make the deposit, and to apply the correct deposit amount during a sales transaction.

Also see GS1 Returnable Package Deposit Details

Deposit Rules are considered as global and must not be defined per Business Unit.

A Deposit Rule is related to the Item and must be referenced in the depositRuleId property on the Item entity.

Example: A Deposit Rule of $0.10 is created for the US market and has an id of us-010; this id must then be referenced on all Items sold in the US which should provide a deposit amount of $0.10.

Equally a Deposit Rule for €0.50 might be created for the EU region. This Deposit Rule should then be referenced for all Items with this deposit amount in the EU.

Statuses

The Status is used to manage the lifespan of a Deposit Rule. If a Deposit Rule is to be active and part of the retail business, it has a status for it called ACTIVE.

Deleted Deposit Rules are typically kept for historical reasons. An Item Category that has status DELETED is considered no longer in service, and should be ignored by most systems - except for reporting perhaps.

StatusDescription
ACTIVEActive means the entity is active and available for normal operation. It can be used, processed and displayed as expected.
DELETEDDeleted indicates that the entity is deleted and should not be used. It may be displayed but it should never be part of active results or part of business logic unless it actually is to return it to an active state.