Dev Docs

Item API

Before we talk about the the API for items, we would like to give you global information and their dependencies about items in retail7.

We differentiate between different item types, which gives the possibilities to create different use cases on the POS.

Default Items

The default items are the simplest items, which we have in the system, which allows you to sell an item on POS. The default items needs as mandatory information an internal item ID, the name, the selling price, the assigned tax group. All other information or functions are optional, but of course influence the selling process.

Variant Items

Variant Items differentiate between the master and the sub variant item. If the master item is selected on POS and exist sub variants, a selection is displayed about the assigned sub variant items.

Always a good example for that is fashion - there you need different sizes, color etc..

Set Items

Items can be also purchased as a set. A set can be understand as a collection / kit / combination of items sold for a fixed price.  The set can be firmly defined with no choice what is in it OR it can be build-able on multiple levels (e.g. fixed set with options, build-to-order, etc.).

Set is defined as:

  • price for a whole set

  • list of mandatory components (mandatory to register - individual item price will not be reflected)

  • list of options (optional to register - individual item price will be reflected, if <> 0.00) see Item Options for more details on options and their definition

Set component (member) can be defined as

  • regular item

  • variant item, when variant item is selected, the Item Variants behaviour follows

  • set item, when set item is selected, the same process as for the first set follows

Any of the items defined as component can have options defined as well, see Item Options for more details on options and their definition.

Each component can be define by one item r list of items. In case of a list, one choice needs to be always selected.

The customer can decide, if the stock should be counted on the set item or on the physical item. If a set item get selected on the POS, automatically the assigned items (which can be different other types of items and even additional set items) get selected or the cashier get asked about options and selection.

A good example for that are menus in quick service restaurant or gift sets.

Option Items

Item options are optional additional items (one or multiple), which can be purchased with it. Usually it means some kind of extra ingredient or it can be also used as recommended product to buy, for example:

  • flavoured syrup can be offered to coffee (e.g. latte)

  • extra cheese (and/or ham, pepperoni, onions, etc.) can be added on a pizza

  • AA batteries can be offered when a battery powered product is purchased

  • phone cover / protection glass can be offered when a phone is purchased

Each option will be set up as individual item with its own master data. There will be a link between item and option item(s). 

Deposit Items

Deposit items can be registered as standalone item or assigned to other items and with that, they are added automatically with their price additional to the main item. If the return mode is used and the main item gets registered, just the deposit item is added to the basket.