Menu

API reference · Schema

OrdersPlaceV1

OrdersPlaceV1contract orders.place.v1
  • order_idUuid7required
  • outlet_idUuid7required
  • channel_idUuid7required
  • brand_idUuid7 | nullrequired
  • device_idUuid7 | nullrequired
  • kindenum (4)required
    dine_intakeawaypickupdelivery
  • table_refstring | nullrequired
    min length 1max length 20
  • pickup_window_idUuid7 | nullrequired
  • promised_atIsoDatetime | nullrequired
  • external_refstring | nullrequired
    min length 1max length 100
  • linesarray of objectrequired
    min items 1
    • line_idUuid7required
    • item_idUuid7required
    • variant_idUuid7 | nullrequired
    • option_idsarray of Uuid7required
    • qty_milliintegerrequired
      > 0≤ 9007199254740991
    • barcodestring | nullrequired
      pattern ^[0-9A-Za-z-]{4,32}$
    • notestring | nullrequired
      max length 200
  • coupon_codesarray of stringrequired
    max items 5
  • loyalty_redeem_pointsintegerrequired
    ≥ 0≤ 9007199254740991
  • preview_total_minorinteger | nullrequired
    ≥ -9007199254740991≤ 9007199254740991
  • client_totalsobject | nullrequired