跳到主要内容

API 参考

订单 API

订单 API

订单 API 负责订单创建(公开,供顾客使用)和订单管理(需身份验证,供餐厅老板使用)。餐厅必须已激活 Ordering Suite 附加组件。

POST /api/orders

创建新订单。这是一个公开端点,供顾客在菜单上下单时使用。

身份验证:公开(无需令牌)

速率限制:每个 IP 每分钟 5 次请求

请求体

{
  "restaurantId": "uuid",
  "tableId": "uuid",
  "items": [
    {
      "menuItemId": "uuid",
      "quantity": 2
    },
    {
      "menuItemId": "uuid",
      "quantity": 1
    }
  ]
}

响应(201 Created)

{
  "success": true,
  "data": {
    "id": "uuid",
    "status": "PENDING",
    "tableLabel": "Table 5",
    "items": [...],
    "createdAt": "2026-02-19T14:30:00Z"
  }
}

GET /api/orders

获取您餐厅的所有订单。支持按状态筛选。

身份验证:必需(Bearer 令牌)

查询参数

  • status — 按订单状态筛选(例如 ?status=PENDING)

响应(200 OK)

{
  "success": true,
  "data": [
    {
      "id": "uuid",
      "status": "PENDING",
      "tableLabel": "Table 5",
      "items": [...],
      "createdAt": "2026-02-19T14:30:00Z"
    }
  ]
}

GET /api/orders/[id]

获取单个订单。此端点支持双模式访问:

  • 已验证(老板):返回包含所有字段的完整订单数据。
  • 公开(顾客):返回有限的字段(状态、菜品、餐桌标签)。需要 restaurantId 查询参数。

PATCH /api/orders/[id]

更新订单状态。餐厅老板用它来推进订单的生命周期。

身份验证:必需(Bearer 令牌)

请求体

{
  "status": "CONFIRMED"
}

有效的状态转换:PENDING 到 CONFIRMED、CONFIRMED 到 PREPARING、PREPARING 到 READY、READY 到 SERVED。处于 PENDING 或 CONFIRMED 状态的订单可以设置为 CANCELLED。