メインコンテンツへスキップ

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 に設定できます。