Skip to main content

Specifications and Definitions

Voids and Refunds

The Header Section of JSON is_overring captures void/refund information.

Type	is_overring	Description
Normal Sale	1	A typical transaction without a void or refund.
Order Level	2	When a ticket is completely deleted (by recalling the original ticket) after payment.
Menu Item	3	When a cashier manually rings up item(s) from a previous ticket (after that payment has been made for previous ticket). Void/Refund can be on one item, multiple items or all items from a previous ticket.
Menu Item with additional purchases	3	When additional purchases are added during a Menu Item Void. This information is captured within the JSON string for the order. Additional purchases should are inside the JSON string, as a normal positive transaction.

Deletes

The deleted_items flag indicates if the order contains deleted items.

deleted_items	Description
1	Order does not contain deletes.
2	Order contains deletes.

The sale product mode indicates when the delete occured.

mode	Description
1	Normal sale.
2	Deletes before the items are routed to the kitchen screen
3	Deletes after the items are routed to the kitchen screen, but before the order subtotal
4	Deletes after the order subtotal

Required and Optional Attributes

To ensure a better and efficient error handling mechanism, certain error codes require attributes. The list below identifies the required and optional attributes.

Tlog Sale Header
sale_id	Required
date	Required
transaction_start_datetime	Required
transaction_end_datetime	Required
destination	Required
order_sub_total	Required
order_number	Required
cancelled_sale_reference_uid	Optional
is_overring	Required
deleted_items	Required
[tenders]	Optional
[order_discounts]	Optional
*At least 1 of the following must be present:**
[products]	Required*
[valuemeals]	Required*

Tlog Sale Product
product_id	Required
third_party_id	Required
product_reference_uid	Optional
product_name	Required
count	Required
amount	Required
price	Required
a_la_carte_price	Required
mode	Required
order_discount_uuid	Optional
[product_qualifiers]	Optional
[product_discounts]	Optional

Sale Valuemeal
valuemeal_id	Required
third_party_id	Required
valuemeal_reference_uid	Optional
valuemeal_name	Required
count	Required
amount	Required
savings	Required
mode	Required
order_discount_uuid	Optional
[valuemeal_products]	Required
[valuemeal_discounts]	Optional

Sale Qualifier
modifier_id	Required
modifier_third_party_id	Required
modifier_reference_uid	Optional
modifier_name	Required
qualifier_id	Required
qualifier_third_party_id	Required
qualifier_name	Required
count	Required
amount	Required
price	Required
a_la_carte_price	Required
mode	Required
order_discount_uuid	Optional

See also: