API reference · Schema
StorefrontOrderView
StorefrontOrderViewcontract storefront.order.view
- kindenum (4)required
dine_intakeawaypickupdelivery - statusenum (7)required
placedacceptedrejectedpreparingreadycompletedcancelled - ticket_nointegerrequired≥ 1≤ 9007199254740991
- 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])))$
- subtotal_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- discount_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- tax_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- total_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- currencystringrequiredpattern ^[A-Z]{3}$
- cancel_window_minintegerrequired≥ 0≤ 9007199254740991
- reschedule_window_minintegerrequired≥ 0≤ 9007199254740991
- pay_at_counterconst truerequired
- prices_include_taxboolean | nullrequired
- linesarray of objectrequired
- line_nointegerrequired≥ 1≤ 9007199254740991
- qty_milliintegerrequired≥ -9007199254740991≤ 9007199254740991
- unit_price_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- line_discount_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- tax_minorintegerrequired≥ -9007199254740991≤ 9007199254740991
- tax_rate_bpinteger | nullrequired≥ 0≤ 10000
- tax_component_ratesarray of objectrequired
- codestringrequired
- rate_bpintegerrequired≥ 0≤ 10000
- eventsarray of objectrequired
- kindenum (2)required
statuspromised_at - from_statusstring | nullrequired
- to_statusstring | nullrequired
- reasonstring | nullrequired