Data Pipeline - Data Catalog – PAR Ordering Knowledge Base

The data catalog is here to enrich our brands knowledge and understanding of the data provided by the data pipelines.

The data catalog provides an overview of all the accessible schemas , tables, columns whilst supporting users with a user friendly description of each data point provided.

The data catalog can support our brands data engineers and analyst to create joins and understand the relationship to maximise their insights.

The PRIMARY KEY constraint uniquely identifies each record in a table. Primary keys must contain UNIQUE values, and cannot contain NULL values. A table can have only ONE primary key; and in the table, this primary key can consist of single or multiple columns (fields).

A FOREIGN KEY is a field (or collection of fields) in one table, that refers to the PRIMARY KEY in another table.

BRANDS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
brand_id	INTERGER NOT NULL	Identifier of the brand	Numerical	1
brand_uuid	VARCHAR NOT NULL	Universally unique identifier	Alphabetical	99dd3155-4b13-499d-89b3-cacb89918c36
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_name	VARCHAR NOT NULL	The name of the brand	Alphanumeric	PARTECH
loyalty_id	INTERGER NOT NULL	Identifier of the loyalty program	Numerical	1
timezone	VARCHAR NOT NULL	The geographic source_region which the standard time is used	Alphabetical	Europe/Zurich
max_prep_time	INTERGER NOT NULL	The maximum preperation time for orders set in the Management Center	Numerical	10
min_prep_time	INTERGER NOT NULL	The minimum preperation time for orders set in the Management Center	Numerical	5
created_ts_at	TIMESTAMP NOT NULL	Date and time of brand creation	Date and time	4/24/1983 16:40
updated_ts_at	TIMESTAMP NOT NULL	Date and time of the last brand update	Date and time	4/24/1983 16:40

STORES

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
store_id	INTEGER NOT NULL	Identifier of the store	Numerical	2
store_uuid	CHAR NOT NULL	Universally unique identifier of the venue	Alphanumeric	ecd5a97e-9308-4e2d-9f1d-a5828fcf2556
store_name	VARCHAR NOT NULL	The name assigned to a specific location	Alphanumeric	PAR Technologies
chain_id	INTEGER NOT NULL	Identifier of the chain in which the store belongs to	Numerical	2
chain_name	VARCHAR NOT NULL	The name of chain	Alphanumeric	PAR Tech
country	VARCHAR NOT NULL	Unique identifier for a specific country	Numerical	1
country_name	VARCHAR NOT NULL	The name of the country the store is located	Alphabetical	United States
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
language	VARCHAR NOT NULL	Unique identifier for a specific language	Alphabetical	English
timezone	VARCHAR NOT NULL	The geographic source_region which the standard time is used	Alphabetical	America/Chicago
store_code	VARCHAR NOT NULL	Unique order identifier for in store displays	Alphanumeric	BVV69
address	VARCHAR NOT NULL	The address of the venue location	Alphabetical	East 6th Street
status	VARCHAR NOT NULL	Identifier of active state of the venue	Active =1, Inactive =2	Active
city	VARCHAR NOT NULL	The city the venue is located	Alphabetical	Austin
zip	VARCHAR NOT NULL	A code of letters and digits used as part of a postal address	Alphanumeric	78702
latitude	DECIMAL NOT NULL	Latitude measurement of the location North or South	Alphanumeric	30.263759
longitude	DECIMAL NOT NULL	Longitude is a measurement of the location East or West	Alphanumeric	-97.729114
tax_number	VARCHAR NOT NULL	The unique store tax registered number	Alphanumeric	xxx-xxx-xx
phone	VARCHAR NOT NULL	The contact number of the venue location	Numerical	+00 000000
is_shown_in_directory	VARCHAR NOT NULL	Identifier to show venue details in the mobile app venue directory	TRUE =1, FALSE =0	TRUE
allow_item_comments	VARCHAR NOT NULL	Identifier if item comments are enabled across your channels	TRUE =1, FALSE =0	TRUE
cuisine	VARCHAR NOT NULL	Name field for the food type	Alphabetical	Healthy Food
store_url	VARCHAR NOT NULL	The URL link to your store webpage	Alphabetical	https://feeditback.com/leave-feedback/
calculation_method	CHAR NOT NULL	Identifier if taxes are included within your pricing	Alphabetical	Inclusive
tip_default	INTEGER NOT NULL	Total price of tips added to each order	Numerical	0
tip_max	INTEGER NOT NULL	Maximum total price of tip allowed to be added to each order	Numerical	10
service_charge	DOUBLE NOT NULL	The value to be added on top of the order value.	Numerical	50
pickup_time	INTEGER NOT NULL	The total amount of time required before an order is available for collection	Numerical	5
is_pickup_on_open_allowed	VARCHAR NOT NULL	Identifier is pick up of orders is available at the same time as store opening hours.	TRUE =1, FALSE =0	TRUE
has_discounts	VARCHAR NOT NULL	Identifier if the venue has discounts enabled	TRUE =1, FALSE =0	TRUE
has_loyalty	VARCHAR NOT NULL	Identifier if the venue has a loyalty program enabled	TRUE =1, FALSE =0	TRUE
has_promotions	VARCHAR NOT NULL	Identifier if the venue has promotions enabled	TRUE =1, FALSE =0	TRUE
pickup_code_counter	INTEGER NOT NULL	Identifier for order pick up	Numerical	56
delivery_travel_type	CHAR NOT NULL	Identifier of their delivery method	driving	driving
default_delivery_buffer	VARCHAR NOT NULL	Total average time required to deliver an order	Numerical	20
is_calculated_delivery_buffer_used	VARCHAR NOT NULL	Identifier if a time buffer is added to delivery orders	TRUE =1, FALSE =0	TRUE
is_ready_for_use	VARCHAR NOT NULL	Identifier if the store is ready	TRUE =1, FALSE =0	TRUE
is_monitoring_enabled	VARCHAR NOT NULL	Identifier if the venue has a monitoring service enabled	TRUE =1, FALSE =0	TRUE
is_threeds_enabled	VARCHAR NOT NULL		TRUE =1, FALSE =0	TRUE
is_fraud_detection_enabled	VARCHAR NOT NULL	Identifier if the venue has a fraud provider enabled	TRUE =1, FALSE =0	TRUE
is_smart_orders_enabled	VARCHAR NOT NULL	Identifier is smart ordering feature is enabled for order types	TRUE =1, FALSE =0	TRUE
is_order_regret_enabled	VARCHAR NOT NULL	Identifier if the venue allows cancellation of orders enabled	TRUE =1, FALSE =0	TRUE
has_delivery_integration	VARCHAR NOT NULL	Identifier if the venue has delivery service integrated	TRUE =1, FALSE =0	TRUE
use_pos_order_number	VARCHAR NOT NULL	Identifier if POS order number is used on tickets	TRUE =1, FALSE =0	TRUE
created_ts_at	TIMESTAMP NOT NULL	Date and time of venue creation	Date and time	9/24/2021 10:15
updated_ts_at	TIMESTAMP NOT NULL	Date and time of the last venue update	Numerical	9/24/2021 10:15
deleted_at	TIMESTAMP NOT NULL	Date and time of the venue was deleted	Date and time	9/24/2021 10:15

STORE STORE GROUP

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
store_store_group_id	INTEGER NOT NULL	The identifier of the store	Numerical	21
store_id	INTEGER NOT NULL	Identifier of the store	Numerical	2
store_group_id	INTEGER NOT NULL	Unique identifier of the store group	Numerical	1
store_group_name	VARCHAR	The name of the store group	Alphanumeric	PAR Ordring SG
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR	The source_region code of the brand	us	us
created_ts_at	TIMESTAMP	Date and time of the venues added to the store group	Date and time	08/09/2019 09:15
updated_ts_at	TIMESTAMP	Date and time of the last update to venue on store group	Date and time	08/09/2019 09:15

STORE GROUP PURPOSE

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
store_group_id	INTEGER NOT NULL	Identifier of the store group	Numerical	1
store_group_purpose_id	INTEGER NOT NULL	Description of the store group purpose	User Management =1, Integration =2, Delivery =3, Reporting =4, Billing =5, Offer Management =6, Payment =7, Fiscal Integration =8	Integration
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
group_purpose	VARCHAR	The purpose of the store group	Menu Management, Integration, Reporting, Billing, Fiscal Integration	Integration
created_ts_at	TIMESTAMP	Date and time of the store group purpose creation	Date and time	08/09/2019 09:15
updated_ts_at	TIMESTAMP	Date and time of the last store group purpose update	Date and time	08/09/2019 09:15

CUSTOMER ACCOUNTS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
customer_account_id	INTERGER NOT NULL	Identifier of the customer account	Numerical	23
customer_account_uuid	CHAR NOT NULL	Universally unique identifier	Alphabetical	ecd5a97e-9308-4e2d-9f1d-a5828fcf2556
first_name	VARCHAR	The first name of the account holder	Alphabetical	PAR
last_name	VARCHAR	The surname name of the account holder	Alphabetical	Technologies
confirmed	VARCHAR	States if the e-mail of the customer has been confirmed	TRUE =1, FALSE =0	TRUE
phone_number	VARCHAR	The contact number of the account holder	Numerical	+00 00000000
locale	VARCHAR	The country code and language code of the account holder	All country codes available	en
account_status	VARCHAR	Identifier of active state of the account holder	Active =1, Inactive =2	Active
account_type	VARCHAR	Identifier of the type of account	CustomerAccount =1, GuestAccount =2	CustomerAccount
brand_id	INTERGER NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
optin_status_email	VARCHAR	Identifier of permission state of the account holder for marketing mails	Confirmed =1, Disabled =2, Pending =3	Confirmed
optin_status_pn	VARCHAR	Identifier of permission state for marketing push notifications	Confirmed =1, Disabled =2, Pending =3	Disabled
optin_status_sms	VARCHAR	Identifier of permission state of the account holder for SMS marketing	Confirmed =1, Disabled =2, Pending =3	Pending
created_by_application_id	INTEGER	Identifier of which application the user used to create their account	SpecificMobileApplication, SpecificKioskApplication, SpecificWebApplication, SpecificMarketingWebApplication	SpecificMobileApplication
created_ts_at	TIMESTAMP	Date and time of account creation	Date and time	4/24/1983 16:40
updated_ts_at	TIMESTAMP	Date and time of the last account update	Date and time	2/16/2018 21:20
email	VARCHAR	Account holders email address	Alphanumeric	Hello@menu.app
loyalty_code	VARCHAR	Account holders unique loyalty identifier	Numerical	90876
point_balance	INTERGER	The total number of points the account holder current has available	Numerical	10
total_points_accrued	INTERGER	The total number of points the account holder had accrued	Numerical	30
Birthdate	VARCHAR	This is the type of demographic data collected by the brand	Date	10/11/1999
CompanyName	VARCHAR	This is the type of demographic data collected by the brand	Alphanumeric	PARTECH
ID_Number	VARCHAR	This is the type of demographic data collected by the brand	Alphanumeric	35834015

FEEDBACK

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
feedback_id	INTERGER NOT NULL	Identifier of the feedback	Numerical	6
feedback_type	VARCHAR NOT NULL	Identifier of the type of feedback gathered	GeneralFeedback, OrderFeedback	OrderFeedback
brand_id	BIGINT NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
customer_account_id	VARCHAR	Identifier of the customer account	Numerical	23
application_id	VARCHAR	The application the feedback has been submitted through	Numerical	PAR Production WebApp
feedback_rate	INTERGER	The score of of 5 the user has provided	Numerical	4
feedback_body	LONGVARCHAR	The is the feedback test provided	Alphanumeric	Excellent Service
is_app_rated	VARCHAR	Identifier if the app has been rated	TRUE =1, FALSE =0	TRUE
created_ts_at	TIMESTAMP	Date and time of the feedback creation	Date and time	08/09/2019 09:15
updated_ts_at	TIMESTAMP	Date and time of the last feedback update	Date and time	08/09/2019 09:15

ORDERS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
order_id	INTEGER NOT NULL	Identifier of the order	Numerical	10297
order_uuid	CHAR NOT NULL	Universally unique identifier	Alphanumeric	239fac12-3f23-11ed-936c-1a67b454859d
order_code	VARCHAR NOT NULL	A unique code that is assigned to each order for the customers reference	Alphanumeric	7IHA1
store_id	INTEGER NOT NULL	Identifier of the store	Numerical	2
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR	The source_region code of the brand	us	US
external_reference	VARCHAR	Unique identifier provided for each external order	Alphanumeric or NULL	0E484BAA-4DFA-4DFC-A753-80319ED96E2C
external_code	VARCHAR	Unique identifier provided for each external order	Alphanumeric or NULL	8VK30
external_channel	VARCHAR	Identifier which external channel provider is used	UberEats =2,	UberEats
ticket_id	INTEGER NOT NULL	A unique number of the of the order	Numeric	1
foodspot_id	INTEGER	A unique number of the foodspot location	Numeric or NULL	2
customer_account_id	INTEGER NOT NULL	A unique number of the customer account	Numeric or NULL	4018
pos_ticket_id	VARCHAR	A unique number of the of the order	Numeric or NULL	11297
order_type_id	VARCHAR	Identifier of the type of order	Dine in (FS) =1, Dine in (QS) =4, Takeaway =6, Delivery =7, Curbside =8, Foodspot =9	Takeaway
order_type	VARCHAR	Identifier of the type of order	Dine in (FS) =1, Dine in (QS) =4, Takeaway =6, Delivery =7, Curbside =8, Foodspot =9	Takeaway
Order_Schedule	VARCHAR	Identifer of the order urgency type	Scheduled, ASAP	ASAP
is_reorder	VARCHAR	Identifier user to identify reorders	TRUE =1, FALSE =0	TRUE
trigger_type	VARCHAR	Identifier when the order is sent to the store	Timed Fire =1 , Trigger Fire =2	Timed Fire
send_attempts	TINYINT	The number of attempts the order has been sent to the POS	Numeric or NULL	0
current_order_status	VARCHAR	The status of the order	Init, SendDelayed, SendTried, Sent, Ready, Final, Canceled, Faile	Final
payment_status	VARCHAR	The payment status of the order	Paid, unpaid, RefundedFully, Voided, Failed	Paid
fraud_detection_status	VARCHAR	The fraud detection status for the payment	Declined, Approved or Not Reviewed	Declined
fiscal_status	VARCHAR	The overall status of the payment	Success, Failed, Cancelled	Failed
Error_Type	VARCHAR	The error type why the order failed	Payment Processor Exception, POS Exception, Order Exception, Query Exception, Config Validation Exception	Order Exception
application_type	VARCHAR	Identifier as to which channel the order was place via	SpecificMobileApplication, SpecificKioskApplication, SpecificWebApplication, SpecificMarketingWebApplication	SpecificMobileApplication
fiscalization_number	VARCHAR	Unique identifier provided for each order for tax purposes	Numeric or NULL	NULL
calculation_method	CHAR	Identifier if tax is included in the price	inclusive, excluded	inclusive
subtotal	INTEGER	The cost of the goods before tax or delivery costs are added	Numeric or NULL	12
total	INTEGER	The total order amount chargeable for the costs of goods and services inclusive of taxes	Numeric or NULL	12
discount	INTEGER	The total amount subtracted from the total amount	Numeric or NULL	5
discount_redemption_id	INTEGER	Identifier which discount redemption offer was used for the order	Numeric or NULL	8
subsidy	INTEGER	An indirect payment amount due as part of a government or brand program	Numeric or NULL	1
delivery_fee_tax_rate	DECIMAL	The percentage of the delivery amount taxable	Numeric or NULL	0
tip	INTEGER	A total amount given as a gratuity for goods or services	Numeric or NULL	0
tip_rate	DECIMAL	The percentage of the tax amount taxable	Numeric or NULL	0
delivery_fee	INTEGER	The charge for the cost of delivering goods	Numeric or NULL	0
delivery_fee_tax	INTEGER	The tax charged for the delivery charge sold	Numeric or NULL	0
minimum_surcharge	INTEGER	Minimum charge is the higher of the rate minimum and the rate applied	Numeric or NULL	0
minimum_surcharge_tax	INTEGER	Tax applied to that is added to the cost of a good or service	Numeric or NULL	0
minimal_order_amount	INTEGER	The smallest value of products the order must meet to qualify for delivery	Numeric or NULL	0
tax	INTEGER	Consumption tax amount on goods and service	Numeric or NULL	77
tax_rates	INTEGER	The percentage of the total amount taxable for goods for order types, in venue and takeout	Numeric or NULL	{"10":3}
send_at	TIMESTAMP	The time that the order was sent to the POS system	Date and time or NULL	8/22/2019 8:15
preparation_time	INTEGER	The preparation type of the order type	Numeric or NULL	5
ready_at	TIMESTAMP	The time the order was ready	Date and time or NULL	11/22/2019 15:19
pickup_at	TIMESTAMP	The time that the order is to be collect from the store	Date and time or NULL	8/22/2019 8:15
pickup_code	INTEGER	A unique code that is assigned to each order for the customers reference	Numeric or NULL	463
delivery_delay_time	INTEGER	The new delivery time when a venue has opted to delay the delivery	Date and time or NULL	8/22/2019 8:15
delivery_status	VARCHAR	The delivery status of the order	Scheduled, Readyfordelivery, Pickup, Delivered, Rejected, Failed	Delivered
delivery_at	TIMESTAMP	The final delivery date and time	Date and time or NULL	11/22/2019 15:22
ready_at	TIMESTAMP	The time the order was ready	Date and time or NULL	11/22/2019 15:19
is_customer_arrived	VARCHAR	TRUE =1, FALSE =0	TRUE =1, FALSE =0	FALSE
arriving_at	TIMESTAMP	The time the customer arrived at the venue	Numeric or NULL	NULL
regret_cancel_until	TIMESTAMP	The the time window in which a customer can cancel their order	Numeric or NULL	NULL
cancellation_reason	VARCHAR	The reason for why an order was cancelled	item unavailable =1, store closed =2, customer requested =3, no picker =4, late delivery=5, too busy =6, no response =7, technical problem=8, cannot fulfil order =9, other =10 or NULL	NULL
order_status_created_at_ts_utc	TIMESTAMP	Date and time of the order status	Date and time or NULL	9/23/2019 9:56
order_created_at_ts_utc	TIMESTAMP	Date and time of order creation	Date and time or NULL	9/23/2019 9:56
order_updated_at_ts_utc	TIMESTAMP	Date and time of the last order update	Date and time or NULL	9/25/2019 12:20

ORDER ITEMS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
order_item_id	INTEGER NOT NULL	Identifier of the order item	Numerical or NULL	76565
reference_type	VARCHAR	identifier of the type of order item classification	1= MenuOrderItem, 3= ComboOrderItem, 4= DiscountOrderItem	ComboOrderItem
order_item_name	VARCHAR	The name of the order item	Alphabetical	Ceasar Salad
translated_name	VARCHAR	The name of item in selected language	Alphabetical	Ceasar Salad
order_id	INTEGER NOT NULL	identifier of the type of order item classification	1= MenuOrderItem, 3= ComboOrderItem, 4= DiscountOrderItem	ComboOrderItem
brand_id	LONGVARCHAR NOT NULL	Identifier of the brand	Numerical	1
store_id	LONGVARCHAR NOT NULL	Identifier of the store	Numerical	2
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
order_item_group_id	INTEGER	Identifier of the order item group	Numerical or NULL	1
group_type	VARCHAR	identifier of which group the item group is from	1= MainCoreComboGroup, 2= SideCoreComboGroup	MainCoreComboGroup
menu_item_id	INTEGER	The id of the menu which the item belongs too	Numeric or NULL	2
pos_id	VARCHAR	The POS identification number of the order item	Numerical or NULL	11122
item_type	VARCHAR	The food type description	Food, Drinks,	food
combo_group_id	INTEGER	Identifier of the item combo group	Numerical or NULL	1
combo_group_type	VARCHAR	identifier of which group the item group is from	1= MainCoreComboGroup, 2= SideCoreComboGroup	MainCoreComboGroup
combo_group_name	VARCHAR	Name of the combo group	Alphanumerical	Crispy Chicken
quantity	INTEGER	The total number of each item ordered	Numerical or NULL	1
total	INTEGER	Total value of each the order items	Numerical or NULL	12
subtotal	INTEGER	The subtotal of the order amount before taxes	Numerical or NULL	12
discount	INTEGER	The total amount of discount applied to the order	Numerical or NULL	0
tax	INTEGER	The total amount of tax charged for the order	Numerical or NULL	1
tax_rate	DECIMAL	The tax rate calculate used for the order	Numerical or NULL	10
comment	LONGVARCHAR	The comments left by the venue operator	Alphanumerical	Well done
created_at	TIMESTAMP	Date and time of order item creation	Date and time or NULL	11/12/2019 16:49
updated_at	TIMESTAMP	Date and time of the last order item update	Date and time or NULL	11/12/2019 16:49

ORDER ITEM MODIFIERS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
order_item_modifier_id	INTEGER NOT NULL	Identifier of the order item modifier which has been refunded	Numerical or NULL	263116
modifier_name	VARCHAR	The name of the modifier item	Alphabetical	Sauce
order_item_id	INTEGER NOT NULL	Identifier of the order item	Numerical or NULL	76565
order_item_name	VARCHAR	The name of the menu item	Alphabetical	PAR burger
order_id	INTEGER NOT NULL	Identifier of the order	Numerical	10297
brand_id	LONGVARCHAR NOT NULL	Identifier of the brand	Numerical	1
store_id	LONGVARCHAR NOT NULL	Identifier of the store	Numerical	2
source_source_region	INTEGER	The source_region code of the brand	us	us
order_item_group_id	INTEGER	Identifier of the order item group	Numerical or NULL	1
modifier_id	INTEGER	The core modifier identifier	Numerical or NULL	33
order_item_modifier_pos_id	VARCHAR	The identifier of the modifier item on the POS	Numerical or NULL	1374
price_of_item_modifier	INTEGER	The price of the item modifier	Numerical	100
refund_order_item_id	INTEGER	The identifier of the refunded order item	Numerical or NULL	NULL
refund_created_at	timestamp	The date and time which the refund was created	Date and time or NULL	8/29/2019 8:52
refund_updated_at	timestamp	The date and time which the refund was last updated	Date and time or NULL	8/29/2019 8:52
created_at	timestamp	Date and time of order item modifier creation	Date and time or NULL	8/29/2019 8:52
updated_at	timestamp	Date and time of the last order item modifier update	Date and time or NULL	8/29/2019 8:52

MANUAL ORDERS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
manual_order_id	INTEGER NOT NULL	Identifier of the manual order	Numerical	34
order_uuid	CHAR NOT NULL	Universally unique identifier	Alphanumeric	00266003-a596-49ea-bf9b-7f82caa95f01
store_id	INTEGER NOT NULL	Identifier of the store	Numerical	2
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
email	VARCHAR	The email address of the customer	Alphanumeric	Hello@menu.app
external_channel	VARCHAR	Identifier which external channel provider is used	UberEats =2,	UberEats
order_status	VARCHAR	The status of the order	Init, SendDelayed, SendTried, Sent, Ready, Final, Canceled, Failed	Ready
order_type	VARCHAR	The type of order	Dine in (FS) =1, Dine in (QS) =4, Takeaway =6, Delivery =7, Curbside =8, Foodspot =9	Delivery
external_reference	VARCHAR	Unique identifier provided for each external order	Alphanumeric	00003fb6-deb6-4306-bac4-a7a0e7307c8b
external_code	VARCHAR	Unique identifier provided for each external order	Alphanumeric	5FD2YL
order_schedule	VARCHAR	Identifer of the order urgency type	Scheduled, ASAP	Scheduled
error_code	INTEGER	The code related to the error reason for the manual order	302 - item is not available, 303 - An item is no longer available, 304 - An item is not enabled for delivery, 305 - An item is not available for takeout, 306 - An item is unavailable, 400 - POS timeout, 501 - Calculation price failed, 600 - Prices do not match, 900 - Unknown error or NULL	303
error_message	LONGVARCHAR	The reason for the manual order	Item is not available, An item is no longer available, An item is not enabled for delivery, An item is not available for takeout, An item is unavailable, POS timeout, Calculation price failed, Prices do not match, Unknow error or NULL	An item is no longer available
pickup_at	TIMESTAMP	The time that the order was collected	Date and time	9/24/2021 10:15
discount	INTEGER	Total amount of discount to be applied to the order	Numerical	0
error_type	VARCHAR	The error type description	Alphanumeric	Other
total	INTEGER	The total order amount chargeable for the costs of goods and services inclusive of taxes	Numerical	4540
is_paid	TIMESTAMP	Identifier if the order has been paid	TRUE =1, FALSE =0	TRUE
cancellation_reason_id	INTEGER	The reason for why an order was cancelled	item unavailable =1, store closed =2, customer requested =3, no picker =4, late delivery =5, too busy =6, no response =7, technical problem =8, cannot fulfil order =9, other =10	1
cancellation_reason	VARCHAR	The reason for why an order was cancelled	item unavailable =1, store closed =2, customer requested =3, no picker =4, late delivery =5, too busy =6, no response =7, technical problem =8, cannot fulfil order =9, other =10	Item Unavailable
created_ts_at	TIMESTAMP	Date and time of manual order creation	Date and time	4/15/2022 16:09
updated_ts_at	TIMESTAMP	Date and time of the last manual order update	Date and time	4/15/2022 16:28

ORDER STATUSES

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
order_id	INTERGER NOT NULL	Identifier of the order	Numerical	4484
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
store_id	INTEGER NOT NULL	Identifier of the store	Numerical	2
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
last_changed_by	VARCHAR	Identifier of who made the change to the order status	Username, System	System
last_updated_ts_utc	TIMESTAMP	Date and time of the last order type update	Date and time OR NULL	08/09/2019 09:15
Init_ts_utc	TIMESTAMP	Date and time of the order was created	Date and time OR NULL	08/09/2019 09:15
Sent_ts_utc	TIMESTAMP	Date and time of the order was passed to the pos	Date and time OR NULL	08/09/2019 09:15
SendDelayed_ts_utc	TIMESTAMP	Date and time of the of the last time the order was sent to the POS	Date and time OR NULL	08/09/2019 09:15
SendTried_ts_utc	TIMESTAMP	Date and time of the last time the order was sent to the POS	Date and time OR NULL	08/09/2019 09:15
Ready_ts_utc	TIMESTAMP	Date and time when the order is ready	Date and time OR NULL	08/09/2019 09:15
Canceled_ts_utc	TIMESTAMP	Date and time of the canceled order status	Date and time OR NULL	08/09/2019 09:15
Failed_ts_utc	TIMESTAMP	Date and time of the failed order status	Date and time OR NULL	NULL
Final_ts_utc	TIMESTAMP	Date and time of the order was completed and fulfilled.	Date and time OR NULL	08/09/2019 09:30

ORDER TYPES

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
order_type_id	INTERGER NOT NULL	Identifier of the order type	Numerical	1
order_type	VARCHAR	The decription of the order type	OrderTypeDineIn, OrderTypeDelivery, OrderTypeQuickService, OrderTypeTakeOut, OrderTypeCurbside, OrderTypeFoodspot, OrderTypeCateringDelivery	OrderTypeDineIn
store_id	INTEGER NOT NULL	Identifier of the store	Numerical	2
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
state	VARCHAR	Identifier if the order type is in use	Active =1, Inactive =2	Active
external_channel_only	VARCHAR	Identifier if order type is only available for external channels	TRUE =1, FALSE =0	TRUE
created_ts_at	TIMESTAMP	Date and time of the order type creation	Date and time	08/09/2019 09:15
updated_ts_at	TIMESTAMP	Date and time of the last order type update	Date and time	08/09/2019 09:15

PAYMENTS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
payment_id	INTEGER NOT NULL	Identifier of the payment	Numerical	4567
payment_uuid	INTEGER NOT NULL	Universally unique identifier	Alphanumeric	239fac12-3f23-11ed-936c-1a67b454859d
ticket_id	INTEGER	A unique number of the of the order	Numerical	Numerical
order_id	INTEGER	Identifier of the brand	Numerical	11124
store_id	INTEGER	Identifier of the store	Numerical	2
brand_id	INTEGER	Identifier of the order	Numerical	1
reference_type	VARCHAR	A reference to the type of payment taken	OrderItemPayment	OrderItemPayment
payment_method	VARCHAR	Identifier of the payment method for the order	Visa =1, Mastercard =2, American Express =3, Maestro =7	Visa
payment_process	VARCHAR	Identifier which payment processes implement credit card payment	Aurus Payment Processor = 32	AurusPaymentProcessor
total	INTEGER	The total value of the order processed	Numerical	2395
pos_receipt_id	VARCHAR	Identifier of the POS transaction	Numerical	824876
created_ts_utc	TIMESTAMP	Date and time of order creation	Date and time	8/29/2019 8:52
updated_ts_at	TIMESTAMP	Date and time of the last order update	Date and time	8/29/2019 8:52

REFUNDS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
refund_id	INTEGER NOT NULL	Identifier of the refund	Numeric	34344
payment_id	INTEGER NOT NULL	Identifier of the payment of the order	Numeric	42749
ticket_id	INTEGER NOT NULL	A unique number of the of the order	Numeric	343
order_id	INTEGER NOT NULL	Identifier of the brand	Numeric	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
store_id	INTEGER NOT NULL	Identifier of the store	Numerical	2
total	INTEGER NOT NULL	The total order amount chargeable for the costs of goods and services inclusive of taxes	Numerical	12
tax	INTEGER	Consumption tax amount on goods and service	Numerical	1
delivery_fee	INTEGER	The charge for the cost of delivering goods	Numerical	NULL
delivery_fee_tax	INTEGER	The tax charged for the delivery charge sold	Numerical	NULL
minimum_surcharge	INTEGER	Minimum charge is the higher of the rate minimum and the rate applied	Numerical	NULL
minimum_surcharge_tax	INTEGER	Tax applied to that is added to the cost of a good or service	Numerical	NULL
tip	INTEGER	A total amount given as a gratuity for goods or services	Numerical	0
with_full_tip	VARCHAR	Identifier if the tip has been refunded	TRUE =1, FALSE =0	FALSE
created_ts_at	TIMESTAMP	The date and time which the refund was created	Date and time	8/29/2019 8:52
updated_ts_at	TIMESTAMP	The date and time which the refund was last updated	Date and time	8/29/2019 8:52

DELIVERY ADDRESSES

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
delivery_address_id	INTERGER NOT NULL	Identifier of the delivery address	Numerical	123
customer_account_id	INTERGER NOT NULL	Identifier of the customer account	Numerical	23
street_name	VARCHAR	Street name is the common name given to a piece of roadway	Alphabetical	East 6th Street
street_number	VARCHAR	The unique number given to each building on a street	Numerical	5
apartment_number	VARCHAR	This could also be referred to as unit, suite, or building unit number	Alphanumeric	1B
notes	VARCHAR	Something written down to assist the delivery	Alphabetical	Please ring the bell
latitude	DECIMAL	Latitude measurement of the location North or South	Numerical	54.3219237
longitude	DECIMAL	Longitude measurement of the location East or West	Numerical	11.730039
postcode	VARCHAR	A code of letters and digits used as part of a postal address	Alphanumeric	6300
locality	VARCHAR	An area or neighbourhood	Alphabetical	New York
place	VARCHAR	A specific location	Alphabetical	New Hartford
district	VARCHAR	An area of a state, county, or city	Alphabetical	New York
region	VARCHAR	An area classification such as a borough or source_regions of a country	Alphabetical	New York
country	VARCHAR	Geographical territory of the address	Alphabetical	United States
is_number_first	VARCHAR	Formats the address with the number leading the street name	TRUE =1, FALSE =0	TRUE

DELIVERY AREAS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
delivery_area_id	INTERGER NOT NULL	Identifier of the delivery area	Numerical	7856
delivery_area_name	VARCHAR	The name of the delivery zone	Alphanumeric	City Center
store_id	INTEGER NOT NULL	Identifier of the store	Numerical	2
brand_id	INTEGER NOT NULL	Identifier of the store	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
delivery_fee_id	INTEGER NOT NULL	Identifier of the delivery fee	Numerical	34
delivery_fee_type	VARCHAR	The identifier of how the delivery fee is to be applied to the order	DeliveryFeeFixed, DeliveryFeeDistance	DeliveryFeeFixed
minimal_order_amount	INTEGER	The minimum order value of the order to qualify for the delivery service	Numerical	3500
unit	CHAR	The unit of measurement for distance	kilometers, miles	kilometers
price_per_unit	INTEGER	The total price per item for the use of the delivery service	Numerical	0
price_per_unit	INTEGER	The total price of the delivery service for the order	Numerical	890
status	VARCHAR	The distance from the venue location of the delivery area	Numerical	5000
radius	INTEGER	Identifier if the delivery area is in use	Active =1, Inactive =2	Active
created_ts_at	TIMESTAMP	Date and time of the delivery area creation	Date and time	08/09/2019 09:15
updated_ts_at	TIMESTAMP	Date and time of the last delivery area update	Date and time	08/09/2019 09:15

ORDER ROUTE DELIVERY

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
order_delivery_id	DECIMAL NOT NULL	The delivery order id	Numerical	234
order_delivery_uuid	VARCHAR NOT NULL	The Universal Unique Identifier of the order	Alphanumeric	239fac12-3f23-11ed-936c-1a67b454859d
order_code	VARCHAR	Idetifier used for delivery pick up	Alphanumeric	radaaa388373
pickup_code	BIGINT	The order pickup code	Numerical	334
store_id	DECIMAL NOT NULL	Identifier of the store	Numerical	765
source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
order_status	VARCHAR	Status of the order	INIT = 1; SEND_DELAYED = 3; SEND_TRIED = 5; SENT = 7; READY = 11; FINAL = 13; CANCELED = 15; FAILED = 17;	FINAL
delivery_status	VARCHAR	Status of the delivery	UNASSIGNED = 1; ASSIGNED_TO_DRIVER = 5; ASSIGNED_TO_DRIVER = 5; ASSIGNED_TO_DSP = 7; DRIVER_IN_STORE = 9; DELIVERY_IN_PROGRESS = 11; DELIVERED = 13; REJECTED_BY_DRIVER = 15; REJECTED_BY_DSP = 17; CANCELED = 19	ASSIGNED TO DSP
deliver_asap	VARCHAR	Identifier if order is scheduled or asap	TRUE =1, FALSE =0	TRUE
dispatch_identifier	VARCHAR	Identifier of the dispatch order	Numerical	2344
expected_order_pickup_time_ts_utc	TIMESTAMP	The date and time the order is expected to be picked up	Date and time	6/20/2023 13:40
expected_order_delivery_time_ts_utc	TIMESTAMP	The date and time the order is expected to be delivered	Date and time	6/20/2023 13:40
restimated_order_delivery_time_ts_utc	TIMESTAMP	The re estimated date and time the order is expected to be picked up	Date and time	6/20/2023 13:40
core_foodspot_id	BIGINT	Identifier of the foodspot location	Numerical	23
order_promise_id	BIGINT	Identifier of the delivery promise	Numerical	224649
promise_status	VARCHAR	Identifier of the status of the delivery promise	FAILED = 3; DISPATCHED = 4; ORDERED = 5; RESOLVED = 6; REFUSED = 7; CANCELED = 8;	ORDERED
expected_delivery_time_ts_utc	TIMESTAMP	Date and time of the expected delivery	Date and time	6/20/2023 13:40
promise_latitude	DECIMAL	Latitude measurement of the location North or South	Numerical	12.146586
promise_longitude	DECIMAL	Longitude measurement of the location East or West	Numerical	8.56352455
route_id	DECIMAL	The identifier of the route	Numerical	166
route_hub_id	DECIMAL	Identifier of the delivery hub	Numerical	345
is_manual	VARCHAR	Identifier if the route has been created manually	True =1, False =2	FALSE
route_distance	BIGINT	Total distance of the delivery route	Numerical	100
route_duration	BIGINT	Total time of the delivery route	Numerical	8076
driver_distance_remaining	BIGINT	Total distance remaining of the delivery	Numerical	1023
driver_duration_remaining	BIGINT	Date and time the delivery is estimated to start at	Date and time	6/20/2023 13:40
route_scheduled_start_at	TIMESTAMP	Date and time the delivery is scheduled to start at	Date and time	6/20/2023 13:40
route_scheduled_finish_at	TIMESTAMP	Date and time the delivery is scheduled to finish at	Numerical	6/20/2023 13:40
driver_type	VARCHAR	Status of the route	Active =1, Inactive =2	Active
route_latitude	DECIMAL	Latitude measurement of the location North or South	Numerical	12.146586
route_longitude	DECIMAL	Longitude measurement of the location East or West	Numerical	8.56352455
pickup_at	TIMESTAMP	Date and time the order was picked up for delivery	Date and time	6/20/2023 13:40
deliver_at	TIMESTAMP	Date and time the order was delivered	Date and time	6/20/2023 13:40
route_order_sequence	INTEGER	The number within the delivery sequence	Numerical	2
route_part_id	DECIMAL	The identifier of the route part	Numerical	223
route_parts_uuid	VARCHAR	Universal Unique Identifier of the route part	Alphanumeric	239fac12-3f23-11ed-936c-1a67b454859d
route_parts_sequence	INTEGER	The sequence number the delivery is to take place in	Numerical	2
source	VARCHAR	The starting position of the delivery route part	Order, Store, Driver	Order
destination	VARCHAR	The final destination of the delivery route part	Order, Store	Store
route_part_distance	BIGINT	The distance of the delivery route part	Numerical	100
route_part_duration	BIGINT	The time of the delivery route part	Numerical	8076
rp_driver_distance_remaining	BIGINT	Total distance remaining of the delivery	Numerical	1023
rp_estimated_start_at_ts_utc	TIMESTAMP	Date and time the delivery is estimated to start at	Date and time	6/20/2023 13:40
rp_estimated_finish_at_ts_utc	TIMESTAMP	Date and time the delivery is finish to start at	Date and time	6/20/2023 13:40
rp_reestimated_start_at_ts_utc	TIMESTAMP	Date and time the delivery is reestimated start at	Date and time	6/20/2023 13:50
rp_reestimated_finish_at_ts_utc	TIMESTAMP	Date and time the delivery is reestimate finish at	Date and time	6/20/2023 14:00
rp_started_at_ts_utc	TIMESTAMP	Date and time the delivery started at	Date and time	6/20/2023 13:40
rp_finished_at_ts_utc	TIMESTAMP	Date and time the delivery finished at	Date and time	6/20/2023 13:40
created_ts_at	TIMESTAMP	Date and time of the ordered created	Date and time	6/20/2023 13:50
order_updated_at	TIMESTAMP	Dare and time the order was last updated	Date and time	6/20/2023 13:50

ORDER DELIVERY PROVIDER DETAILS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
order_delivery_id	DECIMAL NOT NULL	The delivery order id	Numerical	234
order_delivery_uuid	VARCHAR NOT NULL	The Universal Unique Identifier of the order	Alphanumeric	239fac12-3f23-11ed-936c-1a67b454859d
order_promise_id	DECIMAL	Identifier of the delivery promise	Numerical	224649
delivery_provider_id	DECIMAL	Identifier of the delivery provider	Numerical	1
delivery_provider_name	VARCHAR	The name of the delivery provider	1= uber_direct, 2= doordash,	Uber Direct
store_id	DECIMAL NOT NULL	Identifier of the store	Numerical	2
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
order_status	VARCHAR	Status of the order	INIT = 1; SEND_DELAYED = 3; SEND_TRIED = 5; SENT = 7; READY = 11; FINAL = 13; CANCELED = 15; FAILED = 17;	FINAL
delivery_status	VARCHAR	Status of the delivery	UNASSIGNED = 1; ASSIGNED_TO_DRIVER = 5; ASSIGNED_TO_DRIVER = 5; ASSIGNED_TO_DSP = 7; DRIVER_IN_STORE = 9; DELIVERY_IN_PROGRESS = 11; DELIVERED = 13; REJECTED_BY_DRIVER = 15; REJECTED_BY_DSP = 17; CANCELED = 19	ASSIGNED TO DSP
deliver_asap	VARCHAR	Identifier if order is scheduled or asap	TRUE =1, FALSE =0	TRUE
hub_id	DECIMAL	Identifier of the delivery hub	Numerical	345
hub_name	VARCHAR	Name given to the hub	Alphanumeric	Central hub
core_store_group_id	DECIMAL	Identifier of the store group	Numerical	12
hub_status	VARCHAR	Status of the delivery hub	Active =1, Inactive =2	Active
delivery_mode	VARCHAR	Identifier of the delivery mode type	OWN_DELIVERY = 1; MIXED_DELIVERY = 2; const DSP_DELIVERY = 3;	DSP_DELIVER
enable_auto_assigment	VARCHAR	State if the delivery hub uses auto assignment	Active =1, Inactive =2	Active
enable_delivery_tracking	VARCHAR	State if the delivery hub uses delivery tracking	Active =1, Inactive =2	Active
enable_own_delivery_tracking	VARCHAR	State of the delivery hub uses own delivery tracking	Active =1, Inactive =2	Active
hub_deleted_at	TIMESTAMP	Date and time of the ordered created	Numerical	6/20/2023 13:50
hub_delivery_provider_state	VARCHAR	State of the delivery hub for the provider	Active =1, Inactive =2	Active
hub_delivery_provider_deleted_at	TIMESTAMP	Date and time of the delivery provider being deleted from the delivery hub	Datetime	6/30/2023 18:00
store_configuration_id	DECIMAL	Identifier of the store configuration	Numerical	80
store_configation_state	VARCHAR	State of the store configuration	Active =1, Inactive =2	Active
store_delivery_provider_id	DECIMAL	Identifier of the delivery provider for the store	Numerical	6
store_deliver_provider_status	VARCHAR	State of the delivery provide for the store	Active =1, Inactive =2	Active
external_order_id	VARCHAR	The id from the delivery provider	Numerical	37252212191044300000000
delivery_status	VARCHAR	The delivery status of the order	Scheduled, Readyfordelivery, Pickup, Delivered, Rejected, Failed	Delivered
delivery_promise_state	VARCHAR	State of the delivery promise	FAILED = 3; DISPATCHED = 4; ORDERED = 5; RESOLVED = 6; REFUSED = 7; CANCELED = 8;	ORDERED
state_reason	VARCHAR	The reason for the delivery state	FAILED = 3; DISPATCHED = 4; ORDERED = 5; RESOLVED = 6; REFUSED = 7; CANCELED = 8;	ORDERED
estimated_pickup_time	TIMESTAMP	Date and time estimate of the delivery pick up	Datetime	12/21/2022 13:55
estimated_delivery_time	TIMESTAMP	Date and time estimate of the delivery	Datetime	6/30/2023 18:00
estimated_delivery_fee	INTEGER	The cost of the delivery	Numerical	600
delivery_provider_status	VARCHAR	State of the delivery provider	Active =1, Inactive =2	Active
enable_delivery_tracking	VARCHAR	State if the delivery provider uses delivery tracking	Active =1, Inactive =2	Active
enable_cash_on_delivery	VARCHAR	State if cash is accepted on delivery	Active =1, Inactive =2	Active
enable_order_cancellation	VARCHAR	State if order cancellations is accepted	Active =1, Inactive =2	Active
supports_scheduling	VARCHAR	State if scheduling support is enabled	Active =1, Inactive =2	Active
schedule_minutes_before	VARCHAR	State if scheduling support is enabled	Active =1, Inactive =2	Active
brand_provider_status	VARCHAR	State of the delivery provider	Active =1, Inactive =2	Active
order_created_at	TIMESTAMP	Date and time of the ordered created	Numerical	6/20/2023 13:50
order_updated_at	TIMESTAMP	Dare and time the order was last updated	Numerical	6/20/2023 13:50

ORDER ERROR LOGS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_id	INTEGER NOT NULL	Identifier of the brand	Numerical	2
order_error_log_id	INTEGER NOT NULL	the order error log identifier	Numerical	43
order_id	INTEGER	The order identifier	Numerical	39184
order_flow_trigger_type	VARCHAR	order flow status is not Pending then this value determines how the order processing was triggered	Pending = 0, API = 1, Webhook = 2 , CLI = 3	API
api_version	VARCHAR	The version of the API in which the error occurred	Numerical	4.43.0
device_uuid	VARCHAR	The Universal Unique Identifier of the device used	Alphanumeric	f4d4fcf8-90fb-499b-804e-3adfexxxxxxx
user_agent	VARCHAR	The software the user used to order	Alphanumeric	Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.6 Safari/605.1.15
application_name	VARCHAR	The application the order was placed on	Numerical	PAR TECH
store_id	INTEGER	Identifier of the store	Numerical	New Hamton
customer_account_id	INTEGER	The identifier of the customer	Numerical	458
payment_init_hash	VARCHAR	unique identifier of the transaction	Alphanumeric	cb79938d62f18e319f919858eaxxxx
payment_procesor_type	VARCHAR	The payment processor	Visa=1	Visa
integration_type	VARCHAR	The POS integration provider	Toast = 4, Brink = 29	Brink
POS_ticket_id	VARCHAR	The identifier of the order on the POS	Numerical	234443
external_channel	VARCHAR	The external channel partner	UberEats =2,	UberEats
external_channel_order_reference	VARCHAR	The external channel partner order code	Numerical	315
system_error_code	VARCHAR	The system error code	Numerical	NULL
error_type	VARCHAR	The error type classification	Invalid pickup time, Payment Processor Exception, Bad Request, Invalid discount redemption code, MenuItem ID=XXX, XXX is no longer served Payment amount mismatch.	Payment Processor Exception
error_code	VARCHAR	The error code	Numerical	1001
error_message	VARCHAR	The error message of the order	Alphanumeric	Payment Processor Exception. SAFERPAY: message=`Transaction declined by acquirer`;
third_party_error_code	VARCHAR	The error code from the integrator	Numerical	NULL
third_party_error_message	VARCHAR	The error message from the integrator	Numerical	NULL
stacktrace	LONGVARCHAR	PAR's internal tracking log
senrty_id	VARCHAR	The identifier of the error on sentry	Alphanumeric	bfdaf74c84e64d77b6d87eac89xxxxx
created_ts_utc	TIMESTAMP	Date and time the record was created	Numerical	26/01/2024 16:08
updated_ts_utc	TIMESTAMP	Date and time of the last update to the record	Numerical	29/01/2024 04:20

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
menu_id	BIGINT NOT NULL	Identifier of the menu	Numerical	1
store_id	BIGINT NOT NULL	Identifier of the store	Numerical	2
venue_name	VARCHAR	Name of the store	Alphabetical	PAR Store 1
brand_id	BIGINT NOT NULL	Identifier of the brand	Numerical	1
brand_name	VARCHAR	Name of the brand	Alphabetical	PAR Technologies
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us

MENU ITEMS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
menu_item_id	BIGINT NOT NULL	identifier of the menu item	Numeric	1
menu_item_uuid	VARCHAR NOT NULL	Universally unique identifier	CHAR(36)	08afe3f4-3f23-11ed-936c-1a67b454859d
subcategory_id	BIGINT	identifier of the subcategory of the menu item	Numeric	34
brand_item_id	BIGINT	identifier of the brand menu item	Numeric	3
brand_item_uuid	VARCHAR	Universally unique identifier	Numeric	1
brand_item_name	VARCHAR	The name of the brand menu item	Alphabetical	PAR Burger
brand_item_internal_name	VARCHAR	The name that the brand know the item by	Alphabetical	NULL
description	VARCHAR	The description of the menu item	Alphabetical	Stake burger
food_type	VARCHAR	The food type description	Food, Drinks,	food
is_brand_item_in_combo	VARCHAR	Identifier that menu it is in a combo meal	1=TRUE, 0=FALSE	TRUE
store_id	BIGINT NOT NULL	Identifier of the store	Numerical	2
brand_id	BIGINT NOT NULL	Identifier of the brand	Numerical	1
source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
menu_id	BIGINT NOT NULL	identifier of the menu	Numeric	3
brand_menu_id	BIGINT NOT NULL	identifier of the brand menu	Numeric	3
menu_tax_id	BIGINT	The tax id of the brand menu item	Numeric	4
brand_menu_tax_id	BIGINT	The tax id of the menu item	Numeric	4
printer_id	BIGINT	The id of menu item on the printer	Numeric	1
is_visible	VARCHAR	Status of the menu visibility on the apps	1=TRUE, 0=FALSE	TRUE
old_position	VARCHAR	For sort purposes on the menu	1=TRUE, 0=FALSE	TRUE
menu_item_state	VARCHAR	Status of the brand menu item	Active =1, Inactive =2	Active
channel_visibility	VARCHAR	Identifier where the menu item is visible	menu,ec4,ec3,ec5...	menu
created_ts_at	TIMESTAMP	Date and time of menu item creation	Date and time	9/25/2019 12:20
updated_ts_at	TIMESTAMP	Date and time of the last menu item update	Date and time	9/25/2019 12:20

MENU COMBO MEALS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
menu_combo_meal_id	BIGINT NOT NULL	Identifier of the brand combo meal	Numerical	2
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_id	BIGINT NOT NULL	Identifier of the brand	Numerical	1
store_id	BIGINT NOT NULL	Identifier of the store	Numerical	2
brand_menu_combo_meal_id	BIGINT NOT NULL	Identfier of the brand combo meal	Numerical	3
brand_menu_combo_meal_name	VARCHAR	Name of the brand combo meal	Alphabetical	PAR COMBO
description	VARCHAR	The description of the menu item	Alphabetical	Stake burger
position	INTEGER	Position of the combo in the menu	Numeric or NULL	1
subcategory_id	BIGINT	The subcategory identifier	Numerical	5
brand_subcategory_id	BIGINT	The brand subcategory identifier	Numerical	1
created_ts_at	TIMESTAMP	Date and time of core menu combo meal creation	Date and time	9/25/2019 12:20
updated_ts_at	TIMESTAMP	Date and time of the last core menu combo update	Date and time	9/25/2019 12:20

MENU MEAL DETAILS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
combo_meal_id	BIGINT NOT NULL	Identifier of the combo menu	Numerical	1
combo_meal_uuid	VARCHAR NOT NULL	Identifier of the combo meal	Numerical	2
menu_id	BIGINT	Identifier of the menu	Numerical	1
store_id	BIGINT NOT NULL	Identifier of the store	Numerical	2
brand_id	BIGINT NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_combo_meal_id	BIGINT	The brand combo meal identifier	Numeric or NULL	21898
brand_combo_meal_uuid	VARCHAR	The brand combo meal unique identifier	Numerical	23
brand_menu_combo_meal_id	VARCHAR	The brand combo menu meal identifier	Numerical	1
brand_menu_combo_meal_name	VARCHAR	The brand combo menu meal name	Alphanumeric	MENU MEAL
brand_combo_meal_name	VARCHAR	The brand combo meal name	Alphabetical	Combos
is_visible	VARCHAR	The identifier is the item visible on the menu	1=TRUE, 0=FALSE	TRUE
state	VARCHAR	Status of the menu meal item	Active =1, Inactive =2	Active
pos_id	VARCHAR	The identifier of the meal on the POS	Numeric or NULL	98655
brand_pos_id	VARCHAR	The identifier of the item on the POS	Numeric or NULL	1374
brand_position	INTEGER	Position of the item in the menu	Numeric or NULL	1
brand_combo_is_shown_in_upsell	VARCHAR	Identifier to see if an item in the upsell caracal	Numeric or NULL	1
delivery_base_price	BIGINT	The delivery price of the meal	Numeric or NULL	0
base_price	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	100
base_price_configuration_2	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
base_price_configuration_3	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
base_price_configuration_4	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
base_price_configuration_5	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
base_price_configuration_6	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
base_price_configuration_7	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
channel_visibility	VARCHAR	The identifier which channel the core modifier item is shown on	menu,ec4,ec3,ec5...	menu,ec4,ec3,ec5
created_ts_at	TIMESTAMP	Date and time of core modifier creation	Date and time or NULL	9/25/2019 12:20
updated_ts_at	TIMESTAMP	Date and time of the last core modifier update	Date and time or NULL	9/25/2019 12:20

COMBO ITEMS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_id	BIGINT NOT NULL	Identifier of the brand	Numerical	1
core_combo_item	BIGINT NOT NULL	The combo meal identifier	Numeric or NULL	244
core_combo_item_uuid	VARCHAR NOT NULL	Universally unique identifier	Alphanumeric	08afe3f4-3f23-11ed-936c-1a67b454859d
store_id	BIGINT	Identifier of the store	Numerical	2
menu_item_id	BIGINT	The menu item identifier	Numeric or NULL	234
combo_group_id	BIGINT	The combo group identifier	Numeric or NULL	234
brand_combo_group_id	BIGINT	The brand combo group identifier	Numeric or NULL	1
menu_item_price_level_id	BIGINT	The price of the menu item price level	Numeric or NULL	220
brand_menu_item_price_level_id	VARCHAR	The brand price of the menu item price level	Numeric or NULL	220
brand_combo_id	VARCHAR	The brand combo identifier	Numeric or NULL	1
brand_combo_item_id	VARCHAR	The brand combo item identifier	Numeric or NULL	1
brand_combo_item_uuid	VARCHAR	Universally unique identifier	Alphanumeric	08afe3f4-3f23-11ed-936c-1a67b454859d
brand_combo_item_name	VARCHAR	The brand combo item name	Alphanumeric	PAR MEAL
description	VARCHAR	The description of the menu combo items	Alphabetical	Coca Cola + Fries
is_preselected	BIT	Identifier if the combo item is preselect as part of the combo meal	1=TRUE, 0=FALSE	TRUE
position	INTEGER	Position of the combo in the menu	Numeric or NULL	1
price	BIGINT	The price of the combo item	Numerical or NULL	100
brand_price	BIGINT	The price of the brand combo item	Numerical or NULL	100
price_configuration_2	BIGINT	The price grouping used for menu order type or external channels	Numerical or NULL	120
price_configuration_3	BIGINT	The price grouping used for menu order type or external channels	Numerical or NULL	150
price_configuration_4	BIGINT	The price grouping used for menu order type or external channels	Numerical or NULL	200
price_configuration_5	BIGINT	The price grouping used for menu order type or external channels	Numerical or NULL	250
price_configuration_6	BIGINT	The price grouping used for menu order type or external channels	Numerical or NULL	300
price_configuration_7	BIGINT	The price grouping used for menu order type or external channels	Numerical or NULL	350
brand_price_configuration_2	BIGINT	The brand price grouping used for menu order type or external channels	Numerical or NULL	120
brand_price_configuration_3	BIGINT	The brand price grouping used for menu order type or external channels	Numerical or NULL	150
brand_price_configuration_4	BIGINT	The brand price grouping used for menu order type or external channels	Numerical or NULL	200
brand_price_configuration_5	BIGINT	The brand price grouping used for menu order type or external channels	Numerical or NULL	250
brand_price_configuration_6	BIGINT	The brand price grouping used for menu order type or external channels	Numerical or NULL	300
brand_price_configuration_7	BIGINT	The brand price grouping used for menu order type or external channels	Numerical or NULL	350
is_visible_in_clients	VARCHAR	Used to calculated visibility for internal & external channels	1=TRUE, 0=FALSE	TRUE
combo_item_created_at	TIMESTAMP	Date and time of menu combo meal creation	Date and time or NULL	9/25/2019 12:20
combo_item_updated_at	TIMESTAMP	Date and time of the last menu combo meal update	Date and time or NULL	9/25/2019 12:20

COMBO GROUPS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
combo_group_id	BIGINT NOT NULL	The core combo group identifier	Numeric or NULL	34
combo_group_uuid	VARCHAR NOT NULL	Universally unique identifier of the combo group	Alphanumeric	08afe3f4-3f23-11ed-936c-1a67b454859d
store_id	BIGINT	Identifier of the store	Numerical	2
brand_id	BIGINT	Identifier of the brand	Numerical	1
source_region	VARCHAR	The source_region code of the brand	us	us
brand_group_reference_type	VARCHAR	Identifier of which group the item group is from	1= MainCoreComboGroup, 2= SideCoreComboGroup	MainCoreComboGroup
brand_combo_group_name	VARCHAR	The name of the item combo group	abetical	BURGER COMBOS
pos_id	VARCHAR	The identifier of the core modifier item on the POS	Numeric or NULL	1374
brand_group_pos_id	VARCHAR	The identifier of the combo group on the POS	Numeric or NULL	45678
brand_group_created_at	TIMESTAMP	Date and time of combo group creation	Date and time or NULL	9/25/2024 12:20
brand_group_updated_at	TIMESTAMP	Date and time of the last combo group update	Date and time or NULL	9/25/2024 12:20
created_at	TIMESTAMP	Date and time of combo group creation	Date and time or NULL	9/25/2024 12:20
updated_at	TIMESTAMP	Date and time of the last combo group update	Date and time or NULL	9/25/2024 12:20

MODIFIER GROUPS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
modifier_group_id	BIGINT NOT NULL	The modifier group identifier	Numeric or NULL	1
modifier_group_uuid	VARCHAR NOT NULL	Universally unique identifier	CHAR(36)	08afe3f4-3f23-11ed-936c-1a67b454859d
store_id	BIGINT NOT NULL	Identifier of the store	Numerical	2
brand_id	BIGINT NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_modifier_group_id	BIGINT	The modifier group identifier	Numeric or NULL	1
reference_type	VARCHAR	POS reference	CoreSimpleModifier, CoreCommentModifier	CoreSimpleModifier
group_name	VARCHAR	The name of the modifier group	Alphabetical	Sauce
internal_name	VARCHAR	The name that the brand know the item by	Alphabetical	NULL
min_selected	INTEGER	The minimum number of modifier items which need to be added to the order	Numeric or NULL	0
max_selected	INTEGER	The maximum number of modifier items which can to be added to the order	Numeric or NULL	0
pos_min_selected	INTEGER	The minimum number of modifiers which are required to be selected for the POS	Numeric or NULL	0
pos_max_selected	INTEGER	The Maximum number of modifiers which are required to be selected for the POS	Numeric or NULL	5
pos_id	VARCHAR	The identifier of the modifier group on the POS	Numeric or NULL	12345
pos_name	VARCHAR	The name of the modifier group on the POS	Alphabetical	NULL
state	VARCHAR	Status of the modifier group	Active =1, Inactive =2	Active
is_visible	VARCHAR	The identifier is the modifier group is visible on the menu	1=TRUE, 0=FALSE	TRUE
channel_visibility	VARCHAR	The identifier which channel the modifier item is shown on	menu,ec4,ec3,ec5...	menu,ec4,ec3,ec5
brand_pos_id	VARCHAR	The identifier of the modifier group on the POS	Numeric or NULL	12345
brand_min_selected	INTEGER	The minimum number of modifier items which need to be added to the order	Numeric or NULL	0
brand_max_selected	INTEGER	The maximum number of modifier items which can to be added to the order	Numeric or NULL	0
brand_pos_min_selected	INTEGER	The minimum number of modifiers which are required to be selected for the POS	Numeric or NULL	0
brand_pos_max_seleced	INTEGER	The Maximum number of modifiers which are required to be selected for the POS	Numeric or NULL	5
brand_visibility	VARCHAR	The identifier which channel the modifier item is shown on	menu,ec4,ec3,ec5...	menu,ec4,ec3,ec5
created_ts_at	TIMESTAMP	Date and time of modifier group creation	Date and time or NULL	9/25/2019 12:20
updated_ts_at	TIMESTAMP	Date and time of the last modifier group update	Date and time or NULL	9/25/2019 12:20

MODIFIERS

COLUMN_NAME	DATA_TYPE	DESCRIPTION	DEFINITION	VALUE EXAMPLE
modifier_id	BIGINT NOT NULL	Identifier of the modifier	Numerical	222
modifier_uuid	VARCHAR NOT NULL	Universally unique identifier	CHAR(36)	08afe3f4-3f23-11ed-936c-1a67b454859d
store_id	BIGINT NOT NULL	Identifier of the store	Numerical	2
brand_id	BIGINT NOT NULL	Identifier of the brand	Numerical	1
source_source_region	VARCHAR NOT NULL	The source_region code of the brand	us	us
brand_modifier_id	BIGINT	Identifier of the brand modifier	Numerical	23
brand_modifier_uuid	VARCHAR	Universally unique identifier	CHAR(36)	08afe3f4-3f23-11ed-936c-1a67b454859d
reference_type	VARCHAR	POS reference check with @Mensur Muretcehajic	CoreSimpleModifier, CoreCommentModifier	CoreSimpleModifier
brand_modifier_name	VARCHAR	The name of the brand modifier item	Alphabetical	Olives
internal_name	VARCHAR	The name that the brand know the item by	Alphabetical	NULL
brand_pos_id	VARCHAR	The identifier of the brand modifier item on the POS	Numeric or NULL	1374
brand_price	BIGINT	The price of the brand modifier item	Numeric or NULL	1900
brand_price_configuration_2	BIGINT	The Brand price grouping used for menu order type or external channels	Numeric or NULL	NULL
brand_price_configuration_3	BIGINT	The Brand price grouping used for menu order type or external channels	Numeric or NULL	NULL
brand_price_configuration_4	BIGINT	The Brand price grouping used for menu order type or external channels	Numeric or NULL	NULL
brand_price_configuration_5	BIGINT	The Brand price grouping used for menu order type or external channels	Numeric or NULL	NULL
brand_price_configuration_6	BIGINT	The Brand price grouping used for menu order type or external channels	Numeric or NULL	NULL
brand_price_configuration_7	BIGINT	The Brand price grouping used for menu order type or external channels	Numeric or NULL	NULL
calories	INTEGER	The Brand price grouping used for menu order type or external channels	Numeric or NULL	NULL
brand_modifier_channel_visibility	VARCHAR	The identifier which channel the brand modifier item is shown on	menu,ec4,ec3,ec5...	menu,ec4,ec3,ec5
price	BIGINT	The price of the modifier item	Numeric or NULL	200
price_configuration_2	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
price_configuration_3	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
price_configuration_4	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
price_configuration_5	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
price_configuration_6	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
price_configuration_7	BIGINT	The price grouping used for menu order type or external channels	Numeric or NULL	NULL
pos_id	VARCHAR	The identifier of the brand modifier item on the POS	Numeric or NULL	1374
pos_name	VARCHAR	The name of the modifier of the item on the POS	Numeric or NULL	NULL
state	VARCHAR	Status of the modifier item	Active =1, Inactive =2	Active
is_visible	VARCHAR	The identifier is the modifier item is visible on the menu	1=TRUE, 0=FALSE	TRUE
channel_visibility	VARCHAR	The identifier of the brand modifier item on the POS	Numeric or NULL	1374
created_ts_at	TIMESTAMP	Date and time of core modifier creation	Date and time or NULL	9/25/2019 12:20
updated_ts_at	TIMESTAMP	Date and time of the last core modifier update	Date and time or NULL	9/25/2019 12:20

Related articles