Menu

API reference · Schema

OrdersPreviewRequest

OrdersPreviewRequestcontract orders.preview.request
  • outlet_idUuid7required
  • channel_idUuid7required
  • brand_idUuid7 | nullrequired
  • kindenum (4)required
    dine_intakeawaypickupdelivery
  • pickup_window_idUuid7 | nullrequired
  • promised_atIsoDatetime | nullrequired
  • coupon_codesarray of stringrequired
    max items 5
  • loyalty_redeem_pointsintegerrequired
    ≥ 0≤ 9007199254740991
  • linesarray of objectrequired
    min items 1
    • item_idUuid7required
    • variant_idUuid7 | nullrequired
    • option_idsarray of Uuid7required
    • qty_milliintegerrequired
      > 0≤ 9007199254740991
    • barcodestring | nullrequired
      pattern ^[0-9A-Za-z-]{4,32}$

Used by