Examples
Examples are provided for the following scenarios:
Example: Sale on Product
JSON:
{
"sale_id":"123456",
"date":"20YY-06-25",
"transaction_start_datetime":"20YY-06-25 20:39:06",
"transaction_end_datetime":"20YY-06-25 20:41:15",
"destination":"take out",
"order_number":"123",
"order_sub_total":"3.59",
"is_overring":"0",
"deleted_items":"0",
"products":[
{
"product_id":"1000",
"third_party_id":"10",
"product_name":"BURGER",
"count":"1",
"amount":"3.59",
"price":"3.59",
"a_la_carte_price":"3.59",
"mode":"0"
}
],
"tenders":[
{
"tender_id":"66522",
"third_party_id":"7751",
"tender_name":"TAX",
"count":"1",
"amount":"0.28",
"is_change":"false",
"mode":"0"
},
{
"tender_id":"66521",
"third_party_id":"7766",
"tender_name":"VISA",
"count":"1",
"amount":"3.77",
"is_change":"false",
"mode":"0"
}
]
}
Example: Product with Modifier
JSON
"products":[
{
"product_id":"1000",
"third_party_id":"10",
"product_name":"BURGER",
"count":"1",
"amount":"3.59",
"price":"3.59",
"a_la_carte_price":"3.59",
"mode":"0",
"product_qualifiers":[
{
"modifier_id":"45613",
"modifier_third_party_id":"7715",
"modifier_name":"No",
"qualifier_id":"65712",
"qualifier_third_party_id":"7917",
"qualifier_name":"pickle",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"0.00",
"mode":"0"
}
]
}
],
Example: Value Meal with Modifier
JSON
"valuemeals":[
{
"valuemeal_id":"495068",
"third_party_id":"7592",
"valuemeal_name":"VM MD DBL WHP CHS",
"count":"1",
"amount":"7.99",
"savings":"-1.47",
"mode":"0",
"valuemeal_products":[
{
"product_id":"15053",
"third_party_id":"1553",
"product_name":"MED FRY",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"1.99",
"mode":"0"
},
{
"product_id":"7800",
"third_party_id":"780",
"product_name":"MD DRINK",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"1.99",
"mode":"0"
},
{
"product_id":"20202",
"third_party_id":"17",
"product_name":"DBL BURGER CHS",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"5.48",
"mode":"0",
"valuemeal_product_qualifiers":[
{
"modifier_id":"77015",
"modifier_third_party_id":"7714",
"modifier_name":"Add",
"qualifier_id":"90004100",
"qualifier_third_party_id":"505",
"qualifier_name":"Bacon",
"count":"1",
"amount":"0.60",
"price":"0.60",
"a_la_carte_price":"0.00",
"mode":"0"
}
]
}
]
}
],
Example: Order Discount
JSON
"order_discounts":[
{
"discount_id":"77010",
"third_party_id":"7710",
"discount_name":"2.00 OFF MANAGER MEAL",
"count":"1",
"amount":"-2.00",
"mode":"0"
}
Example: Overring and Transaction Cancel
JSON
{
"sale_id":"4014737",
"date":"20YY-06-30",
"transaction_start_datetime":"20YY-06-30 08:47:04",
"transaction_end_datetime":"20YY-06-30 08:47:04",
"destination":"drive through",
"order_number":"373",
"cancelled_sale_reference_uid":"4014735",
"order_sub_total":"-6.89",
"is_overring":"1",
"deleted_items":"0",
"products":[
{
"product_id":"4705",
"third_party_id":"475",
"product_name":"Biscuit Sge",
"count":"-4",
"amount":"-4.00",
"price":"1.00",
"a_la_carte_price":"1.00",
"mode":"0"
},
{
"product_id":"17047",
"third_party_id":"1747",
"product_name":"English Muffin Egg C",
"count":"-1",
"amount":"-1.00",
"price":"1.00",
"a_la_carte_price":"1.00",
"mode":"0"
},
{
"product_id":"60040",
"third_party_id":"6040",
"product_name":"Hash Browns 36pc",
"count":"-1",
"amount":"-1.89",
"price":"1.89",
"a_la_carte_price":"1.89",
"mode":"0"
}
],
"tenders":[
{
"tender_id":"77065",
"third_party_id":"7765",
"tender_name":"CASH",
"count":"-1",
"amount":"-7.30",
"is_change":"false",
"mode":"0"
},
{
"tender_id":"77051",
"third_party_id":"7751",
"tender_name":"TAX",
"count":"-1",
"amount":"-0.41",
"is_change":"false",
"mode":"0"
}
]
}
Example: Cash Tender
JSON
"tenders":[
{
"tender_id":"77065",
"third_party_id":"7765",
"tender_name":"CASH",
"count":"1",
"amount":"3.00",
"is_change":"false",
"mode":"0"
},
{
"tender_id":"77051",
"third_party_id":"7751",
"tender_name":"TAX",
"count":"1",
"amount":"0.13",
"is_change":"false",
"mode":"0"
}
]
Example: Delete
An example of an item with a negative count and a negative amount.
The example depicts the following keystrokes:
Ring up burger
drink
value meal burger
value meal burger*
delete value meal burger*
large drink
large drink*
delete large drink*
*indicates deleted items.
JSON
{
"sale_id":"3094982",
"date":"20YY-06-27",
"transaction_start_datetime":"20YY-06-27 11:13:48",
"transaction_end_datetime":"20YY-06-27 11:15:55",
"destination":"drive through",
"order_number":"273",
"order_sub_total":"12.35",
"is_overring":"0",
"deleted_items":"1",
"valuemeals":[
{
"valuemeal_id":"75092",
"third_party_id":"7592",
"valuemeal_name":"VM Burger",
"count":"1",
"amount":"5.88",
"savings":"-0.70",
"mode":"0",
"valuemeal_products":[
{
"product_id":"1000",
"third_party_id":"10",
"product_name":"Burger",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"3.59",
"mode":"0"
},
{
"product_id":"15053",
"third_party_id":"1553",
"product_name":"French Fry - Medium",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"1.99",
"mode":"0"
},
{
"product_id":"7709",
"third_party_id":"779",
"product_name":"Md Drink",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"1.00",
"mode":"0"
}
]
},
{
"valuemeal_id":"75092",
"third_party_id":"7592",
"valuemeal_name":"VM Burger",
"count":"-1",
"amount":"-5.88",
"savings":"0.70",
"mode":"1",
"valuemeal_products":[
{
"product_id":"100",
"third_party_id":"10",
"product_name":"Burger",
"count":"-1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"3.59",
"mode":"1"
},
{
"product_id":"15053",
"third_party_id":"1553",
"product_name":"French Fry - Medium",
"count":"-1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"1.99",
"mode":"1"
},
{
"product_id":"7709",
"third_party_id":"779",
"product_name":"Md Drink",
"count":"-1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"1.00",
"mode":"1"
}
]
}
],
"products":[
{
"product_id":"1000",
"third_party_id":"10",
"product_name":"Burger",
"count":"1",
"amount":"3.09",
"price":"3.09",
"a_la_carte_price":"3.09",
"mode":"0"
},
{
"product_id":"15061",
"third_party_id":"1561",
"product_name":"Lg Drink",
"count":"1",
"amount":"1.89",
"price":"1.89",
"a_la_carte_price":"1.89",
"mode":"0"
},
{
"product_id":"15061",
"third_party_id":"1561",
"product_name":"Lg Drink",
"count":"-1",
"amount":"-1.89",
"price":"1.89",
"a_la_carte_price":"1.89",
"mode":"1"
},
{
"product_id":"23006",
"third_party_id":"2306",
"product_name":"Drink Large 20oz",
"count":"1",
"amount":"1.49",
"price":"1.49",
"a_la_carte_price":"1.49",
"mode":"0"
}
],
"tenders":[
{
"tender_id":"77065",
"third_party_id":"7766",
"tender_name":"Visa",
"count":"1",
"amount":"12.35",
"is_change":"false",
"mode":"0"
},
{
"tender_id":"77051",
"third_party_id":"7751",
"tender_name":"TAX",
"count":"1",
"amount":"0.27",
"is_change":"false",
"mode":"0"
}
]
}
Example: Value Meal Discount
JSON
"valuemeal_discounts":[ { "discount_id":"77012", "third_party_id":"7712", "discount_name":"1.00 Off", "count":"1", "amount":"-1.00", "mode":"0" } ]
Example: Regular Value Meal
JSON
"valuemeals":[
{
"valuemeal_id":"3020200",
"third_party_id":"7592",
"valuemeal_name":"CM SM BURG CHS",
"count":"1",
"amount":"6.39",
"savings":"-1.38",
"mode":"0",
"valuemeal_products":[
{
"product_id":"20200",
"third_party_id":"12",
"product_name":"BURGER CHS",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"4.29",
"mode":"0"
},
{
"product_id":"50402",
"third_party_id":"302",
"product_name":"SM FRY",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"1.79",
"mode":"0"
},
{
"product_id":"80102",
"third_party_id":"779",
"product_name":"SM DRINK",
"count":"1",
"amount":"0.00",
"price":"0.00",
"a_la_carte_price":"1.69",
"mode":"0"
}
]
}