API reference · Schema
V1Order
V1Ordercontract v1.order
- kindenum (4)required
dine_intakeawaypickupdelivery - table_refstring | nullrequired
- statusenum (7)required
placedacceptedrejectedpreparingreadycompletedcancelled - business_datestring (date)requiredpattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
- ticket_nointegerrequired≥ 1≤ 9007199254740991
- invoice_fyinteger | nullrequired≥ -9007199254740991≤ 9007199254740991
- invoice_nointeger | nullrequired≥ -9007199254740991≤ 9007199254740991
- subtotal_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- discount_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- tax_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- total_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- loyalty_minorintegerrequired≥ 0≤ 9007199254740991
- paid_minorintegerrequired≥ 0≤ 9007199254740991
- remaining_minorintegerrequired≥ 0≤ 9007199254740991
- currencystringrequiredpattern ^[A-Z]{3}$
- linesarray of objectrequired
- line_nointegerrequired≥ 1≤ 9007199254740991
- qty_milliintegerrequired> 0≤ 9007199254740991
- unit_price_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- line_discount_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- tax_minorintegerrequired≥ -9007199254740991≤ 9007199254740991