Entity: PRICE

Top

This entity records information about the prices of menu Items and menu Item Options.

Attributes
ID PRIMARY KEY
Item_ID The price record can be created for a menu Item or for a menu Item_Option. When the price record is created for a menu Item, the Item_ID is the lookup for that Item. In this case the Item_Option_ID is NULL.
Item_Option_ID The price record can be created for a menu Item or for a menu Item_Option. When the price record is created for a menu Item_Option, the Item_Option_ID is the lookup for that Item Option. In this case the Item_ID is NULL.
Price Price value. NOT NULL
Tax Rate Tax percentage 0% - 100%. NOT NULL
Created_Time Timestamp when the price record was created. NOT NULL
Start_Time The start timestamp from which the price is applicable. NOT NULL
End_Time The end timestamp after which the price is not applicable. When End_Time is NULL the price is still applicable. NULL
Description Price description. NULL
Comments Internal notes used for clarifications on record content. Can be seen and edited only by Store Employees. NULL

Note

A good practice is that only a Store Employee with the 'Administrator' or 'Manager' Role assigned can create or update the price record for an Item or Item Option.
See Subject Area: EMPLOYEE AND ROLE for more information.

Entity: DISCOUNT_TYPE

Top

List of discount types.

Attributes
ID PRIMARY KEY
Name Discount Type name.
Example: 'All items at 25%', '50% discount for minimum 3 items bought' etc. NOT NULL UNIQUE
Description Discount Type description
Is_Percentage Flag to indicate if the discount value is a percentage or a flat amount.
Example:
⦁ If Is_Percentage is TRUE and Value is '40' then it means a 40% discount
⦁ If Is_Percentage is FALSE and Value is '40' then it means 40 money amount discount expressed in Store default currency.
See Subject Area: STORE, Entity: SETTING, Attribute: Currency_ID for more information. NOT NULL
Value Value of discount.
Example:
⦁ If Is_Percentage is TRUE then the Value is the discount percentage. For example a value of '14.50' means 14.50% discount of the price.
⦁ If Is_Percentage is FALSE then the Value is the money amount discounted. For example a discount Value of '14.50' means a discount of 14.50 expressed in Store default currency. See Subject Area: STORE, Entity: SETTING, Attribute: Currency_ID for more information. NOT NULL
Created_Time Timestamp when the discount type record was created. NOT NULL
Start_Time The start timestamp from which the discount type is applicable. NOT NULL
End_Time The end timestamp after which the discount type is not applicable. When the End_Time is NULL the price is still applicable. NULL
Coupon_Code The Coupon code with which the discount type is applicable.
When the Coupon_Code is NULL, it means the discount is applicable without a Coupon_Code. NULL
Min_Order_Value The Minimum Order Value from which the discount type is applicable.
Example:
A Minimum Order Value of '140' means that the discount type is applicable only for Orders with a total value greater than 140 (expressed in store currency). See Subject Area: STORE, Entity: SETTING, Attribute: Currency_ID for more information. NOT NULL
Min_Item_Quantity The Minimum Item Quantity from which the discount type is applicable.
Example:
A Minimum Item Quantity of '3' means that the discount type is applicable only for Orders that contains the Item added three times at least. NOT NULL
Max_Discount_Value The Maximum Discount Value applicable for an Order.
Example:
A Maximum Discount Value for an Order is '30' (expressed in store currency). In this case, for an Order that contains an Item with price of '80' and with "All items 50% off" discount type, the discount is 30 instead of 40. NOT NULL
Comments Internal notes used for clarifications on record content. Can be seen and edited only by Store Employees. NULL

Entity: DISCOUNT

Top

This entity records information about the discounts applied to menu Items, menu Item Options or menu Categories.

Attributes
ID PRIMARY KEY
Discount_Type_ID Lookup for the Discount Type to be applied to a menu Item, a menu Item Option or to a full menu Category. NOT NULL.
Category_ID The discount record can be created for a menu Item, a menu Item_Option or for a full menu Category. When the discount record is created for a full menu Category, the Category_ID is the lookup for that menu Category. In this case the Item_ID and the Item_Option_ID are NULL. NULL
Item_ID The discount record can be created for a menu Item, a menu Item Option or for a full menu Category. When the discount record is created for a menu Item, the Item_ID is the lookup for that menu Item. In this case the Category_ID and the Item_Option_ID are NULL. NULL
Item_Option_ID The discount record can be created for a menu Item, a menu Item Option or for a full menu Category. When the discount record is created for a menu Item Option, the Item_Option_ID is the lookup for that menu Item Option. In this case the Item_ID and the Category_ID are NULL. NULL
Comments Internal notes used for clarifications on record content. Can be seen and edited only by Store Employees. NULL
Top