Data Records
DATA consists of a parent record for the order itself, known as the Tlog Sale Header, with different types of sub-records nested inside it. For Global restaurants, see Third-Party Alignment and Standardization for more information.
NOTE: values in brackets indicate an array of sub-records
**All strings must be encoded in UTF-8, as referenced above in the Protocol Overview.
Deletes: When deleting a value meal or product, all child items within that value meal or product must also be deleted, as well as children of the children.
Sale Header
Data Point | Type | Size/Format | Description |
|---|---|---|---|
sale_id | int | n<3,000,000,000,000 | unique identifier of each sale |
date | string | YYYY-MM-DD | date of the transaction |
transaction_start_datetime | string | YYYY-MM-DD HH:MM:SS | date and time the transaction began |
transaction_end_datetime | string | YYYY-MM-DD HH:MM:SS | date and time the transaction ended |
destination | string | use provided strings | order destination, such as eat in, take out, drive thru, etc. |
order_sub_total | decimal | -20,000,000 < n < 20,000,000 | the order total before tax |
order_number | decimal | -20,000,000 < n < 20,000,000 | the assigned order number |
cancelled_sale_reference_uid | int | n<3,000,000,000,000 | the sale_reference_uid of a cancelled sale |
is_overring | int | 0 - sale 1 - overrun order 2 - menu item void | flag indicating order status |
deleted_items | int | 0 - no delete 1 - contains delete | indicates if sale contains a delete. |
tenders | array | an array of sale tenders | |
products | array | an array of sale products | |
valuemeals | array | an array of valuemeals | |
order_discounts | array | an array of sale discounts |
Sale Product
Data Point | Type | Size/Format | Description |
|---|---|---|---|
product_id | int | n<3,000,000,000,000 | Unique product identifier. |
third_party_id | Unique third-party identifier. *provided in xlsx format. | ||
product_reference_uid | int | n<3,000,000,000,000 | Unique identifier of each product included in a transaction. |
product_name | string | 64 characters | Assigned name of product. |
count | int | -129 < n < 128 | Quantity of each product in transaction. |
amount | decimal | -20,000,000 < n < 20,000,000 | Cost of products. |
price | decimal | -20,000,000 < n < 20,000,000 | The amount per count for each product in transaction. |
a_la_carte_price | decimal | -20,000,000 < n < 20,000,000 | Price of each item. |
mode | int | 0 - sale 1 - delete before kitchen screen 2 - delete after kitchen screen 3 - delete after subtotal | Identifies if item is sold or deleted. |
order_discount_uuid | int | NULL if a discount is not applied n<3,000,000,000,000 | Populated if a product is contained within a multi-order discount. |
product_qualifiers | array | Array of sale qualifiers. | |
product_discounts | array | Array of sale discounts. |
Sale Qualifier
Data Point | Type | Size/Format | Description |
|---|---|---|---|
modifier_id | int | n<3,000,000,000,000 | the product modifier id |
modifier_third_party_id | third-party product modifier id *provided in xlsx format | ||
modifier_reference_uid | int | n<3,000,000,000,000 | unique modifier id |
modifier_name | string | 64 characters | assigned name of modifier, such as: no, extra, only, etc. |
qualifier_id | int | n<3,000,000,000,000 | the qualifier id |
qualifier_third_party_id | third-party qualifier id *provided in xlsx format | ||
qualifier_name | string | 64 characters | assigned name of qualifier, such as: pickle, onion, cheese, etc. |
count | int | -129 < n < 128 | quantity of instances of a qualifier |
amount | decimal | -20,000,000 < n < 20,000,000 | price associated with qualifier |
price | decimal | -20,000,000 < n < 20,000,000 | the total price associated with the amount per count of a qualifier |
a_la_carte_price | decimal | -20,000,000 < n < 20,000,000 | price of qualifier when purchased outside of a combo meal |
mode | int | 0 - sale 1 - delete before kitchen screen 2 - delete after kitchen screen 3 - delete after subtotal | identifies an item that is sold or deleted |
order_discount_uuid | int | NULL if no discount n<3,000,000,000,000 | populated if the qualifiers are part of multi-order discount |
Sale Value Meal
Data Point | Type | Size/Format | Description |
|---|---|---|---|
valuemeal_id | int | n<3,000,000,000,000 | value meal identifier |
third_party_id | third-party identifier *provided in xlsx format | ||
valuemeal_reference_uid | int | n<3,000,000,000,000 | unique identifier for each value meal contained in a transaction |
valuemeal_name | string | 64 characters | the name assigned to the value meal |
count | int | -129 < n < 128 | quantity of the single value meal ordered in the transaction |
amount | decimal | -20,000,000 < n < 20,000,000 | price assigned to the value meal |
savings | decimal | -20,000,000 < n < 20,000,000 | the cost saved by ordering a value meal instead of items a la carte |
mode | int | 0 - sale 1 - delete before kitchen screen 2 - delete after kitchen screen 3 - delete after subtotal | identifies if an item is sold or deleted |
order_discount_uuid | int | NULL if no discount n<3,000,000,000,000 | populated if the value meal is contained within a multi-order discount |
valuemeal_products | array | array of sale products | |
valuemeal_product_qualifiers | array | array of sale qualifiers | |
valuemeal_discounts | array | array of sale discounts |