API reference · Schema
V1AccountOrder
V1AccountOrdercontract v1.account.order
- orderobjectrequired
- order_idstringrequiredpattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- outlet_idstringrequiredpattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- channel_idstringrequiredpattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- kindenum (4)required
dine_intakeawaypickupdelivery - 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≥ -9007199254740991≤ 9007199254740991
- subtotal_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- discount_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- tax_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- total_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- currencystringrequiredpattern ^[A-Z]{3}$
- linesarray of objectrequired
- line_idstringrequiredpattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- line_nointegerrequired≥ -9007199254740991≤ 9007199254740991
- item_idstringrequiredpattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- item_name_keystringrequired
- variant_idstring | nullrequiredpattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
- qty_milliintegerrequired≥ -9007199254740991≤ 9007199254740991
- unit_price_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- line_discount_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- tax_minorintegerrequired≥ -9007199254740991≤ 9007199254740991