Menu

API reference · Schema

V1OrdersList

V1OrdersListcontract v1.orders.list
  • itemsarray of objectrequired
    • order_idUuid7required
    • outlet_idUuid7required
    • channel_idUuid7required
    • device_idUuid7 | nullrequired
    • kindenum (4)required
      dine_intakeawaypickupdelivery
    • table_refstring | nullrequired
    • statusenum (7)required
      placedacceptedrejectedpreparingreadycompletedcancelled
    • business_datestring (date)required
      pattern ^(?:(?:[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
    • currencystringrequired
      pattern ^[A-Z]{3}$
    • promised_atIsoDatetime | nullrequired
    • created_atIsoDatetimerequired
  • next_cursorUuid7 | nullrequired

Used by