Menu

API reference · Schema

V1KdsBoard

V1KdsBoardcontract v1.kds.board
  • outlet_idUuid7required
  • as_ofIsoDatetimerequired
  • stationsarray of stringrequired
  • ticketsarray of objectrequired
    • ticket_idUuid7required
    • order_idUuid7required
    • ticket_nointegerrequired
      ≥ 1≤ 9007199254740991
    • 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])))$
    • stationstringrequired
      max length 40pattern ^[a-z][a-z0-9_]*$
    • statusenum (4)required
      queuedpreparingreadydone
    • kindenum (4)required
      dine_intakeawaypickupdelivery
    • table_refstring | nullrequired
    • channel_kindstringrequired
    • started_atIsoDatetimerequired
    • accepted_atIsoDatetime | nullrequired
    • ready_atIsoDatetime | nullrequired
    • due_atIsoDatetime | nullrequired
    • promised_atIsoDatetime | nullrequired
    • laneenum (2)required
      nowlater
    • surface_atIsoDatetime | nullrequired
    • colourenum (3)required
      normalamberred
    • linesarray of objectrequired
      • line_nointegerrequired
        ≥ 1≤ 9007199254740991
      • item_idUuid7required
      • name_keystringrequired
        min length 1max length 200
      • qty_milliintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • optionsarray of objectrequired
        Show fields of options
        • option_idUuid7required
        • name_keystringrequired
          min length 1max length 200
      • notestring | nullrequired

Used by