HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceChangelogLog In

Data model: wide_combo_order_item

Description

wide_combo_order_item helps Revel Data Connector users to track combo performance. Using this data model in combination with wide_order_item would allow Revel Data Connector users to review how combo performance compares to individual items in the combo.

Revel Data Connector users using this data model can answer questions like:

  • How many combos are sold and what are their values?
  • Do combos sell more than the same individual items together?
  • Have I cannibalised my revenue by introducing combos?
  • Which employee makes the highest number of combo orders?
  • What sales channels are not optimised for combos?
  • Table service: what are the sales or revenue of each table in the restaurant?
  • etc.

Data Objects

ResourceData typeModeDescriptionExample
order_idint4RequiredUnique ID for an Order5
order_created_attimestampRequiredOrder creation date and time in UTC format.2018-11-08 16:37:41
order_updated_attimestampRequiredOrder last update date and time in UTC format2018-11-08 16:45:36
created_by_employee_first_namevarchar'N/A'First name of employee who created an order. If order wasn’t created by employee, then value is N/AJohn
created_by_employee_last_namevarchar'N/A'Last name of employee who created an order. If order wasn’t created by employee, then value is N/ADoe
created_by_employee_is_activeboolNullableIdentification of whether employee is active. If order wasn’t created by employee, then value is NULLTRUE
last_updated_by_employee_first_namevarchar'N/A'First name of last employee who updated an order. If order wasn’t updated by employee, then value is N/AJohn
last_updated_by_employee_last_namevarchar'N/A'Last name of last employee who created an order. If order wasn’t created by employee, then value is N/ADoe
last_updated_by_employee_is_activeboolNullableIdentification of whether employee is active. If order wasn’t updated by employee, then value is NULLTRUE
order_sourcevarcharRequired
‘Unknown’
Source channel of the order or pos mode if applicable:
  • Web Order
  • Smart Order
  • Table service
  • Quick service
  • Retail
  • Kiosk
  • Pizza
  • Grocery
  • Donation
  • Gas station
Quick Service
order_optionvarcharRequired
‘Unknown’
Identification of order option, e.g. To-Go, Eat-In, Delivery, etc.
  • If it is a custom order option, then value reflects the custom created name.
  • If it is not recognised it is Unknown
To Go
order_statusvarcharRequiredStatus of the orderClosed
is_order_paidboolRequiredOrder payment status.TRUE
combo_order_item_idint4RequiredUnique ID of a combo order item3
product_name_overridevarchar‘N/A’Overriden product nameIce Cream Gift
unit_pricenumericRequiredUnit price of the product in the order. It does not include price for modifiers or combos, monetary value.7.000000
unit_costnumericRequiredUnit cost of the product4.000000
unit_of_measurevarchar'N/A'Unit, weighted, etc.Unit
quantityint4RequiredNumber of ordered products(s)1
weightfloatNullableNumber of weight for the product, which is weighted. unit_of_measure contains types of data, e.g. Oz.7.0
total_pricenumericRequiredTotal price for the products(s) in the Order, monetary value. Formula:
unit price + modifiers_amount + combo_savings_amount * quantity
11.600000
total_costnumericRequiredTotal costs for the item(s) in the Order, monetary value. Formula:
unit cost + modifier cost * quantity
3.000000
modifiers_amountnumericRequiredTotal amount of all the modifiers of single product, monetary value.1.600000
modifiers_costnumericRequiredTotal cost of all the modifiers of single product, monetary value.0.170000
combo_savings_amountnumericRequiredAmount, which is saved by the customer using combo, monetary value.14.200000
is_valid_recordboolRequiredIdentifies, if a record is valid and should be trusted or not.TRUE
product_idint4NullableUnique ID of the product.102
product_skuvarchar‘N/A’Unique SKU of the product. At least 4 characters.AB123
product_namevarchar‘N/A’Name of the product
  • Always reflects the newest name
  • If product_id is NULL then manually entered product name will be shown.
Beef Sandwich
is_product_activeboolNullableIdentification if product is active, e.g. TRUE or FALSE.TRUE
category_namevarchar‘N/A’Product categorySalad
is_category_activeboolNullableIdentification if product’s category is active, e.g. TRUE or FALSE.TRUE
sub_category_namevarchar‘N/A’Product sub-category.Hot Salad
is_sub_category_activeboolNullableIdentification if product’s sub-category is active, e.g. TRUE or FALSE.TRUE
product_class_namevarchar‘N/A’Product class nameDrinks
is_product_class_activeboolNullableIdentification if product’s class is active, e.g. TRUE or FALSE.TRUE
combo_shell_product_idvarchar‘N/A’Unique ID of the combo shell product.132
combo_shell_product_skuvarchar‘N/A’Unique SKU of a combo shell product. At least 4 characters.ZC123
combo_shell_product_namevarchar‘N/A’Name of the combo shell product
  • It always reflects the newest name
  • if product_id is NULL then manually entered product name will be shown.
Sandwich + Drink
product_group_name_listvarchar‘N/A’List of product’s group names.|Product Group A|
establishment_idint4RequiredEstablishment unique Key1
establishment_namevarcharRequiredEstablishment NameCompany-1
company_namevarcharRequiredCompany nameCompany
company_urlvarcharRequiredCompany url addresscompany.revelup.com
establishment_countryvarcharRequiredEstablishment CountryUS
establishment_statevarchar'N/A'Establishment State.GA
establishment_cityvarcharRequiredEstablishment City.Atlanta
establishment_latitudefloatNullableEstablishment Latitude34.6843294
establishment_longitudefloatNullableEstablishment Longitude-86.4109566
establishment_post_codevarcharRequiredEstablishment Post Code30314
is_establishment_activeboolRequiredIdentification if establishment is active, e.g. TRUE or FALSE.TRUE
establishment_group_name_listvarcharRequiredList of establishment’s group names|Group1|Group2Group3
timezonevarcharRequiredThe configured timezone of the establishmentUS/Eastern
establishment_divisionvarchar'N/A'Establishment division. If establishment does not belong to a division, then value is N/A.Division - 1
establishment_sub_divisionvarchar'N/A'Establishment sub-division. If establishment does not belong to a sub-division, then value is N/A.Sub-division - 1
pos_station_namevarcharRequiredPOS station name.POS1
revenue_center_namevarchar'N/A'Name of a revenue center a POS station is linked to.Bar Area
table_namevarchar'N/A'Table name.Table 1
section_namevarchar'N/A'Name of the section a table is in.Section 1
capacityvarcharNullableNumber of people a table can accomodate.4