تخطي إلى المحتوى الرئيسي

مرجع API

واجهة API للطلبات

واجهة API للطلبات

تتولى واجهة API للطلبات إنشاء الطلبات (عامة، للعملاء) وإدارة الطلبات (تتطلب المصادقة، لأصحاب المطاعم). ويجب أن تكون إضافة Ordering Suite نشطة في المطعم.

POST /api/orders

إنشاء طلب جديد. هذه نقطة نهاية عامة يستخدمها العملاء الذين يقدمون الطلبات من القائمة.

المصادقة: عامة (لا يلزم رمز)

حد المعدل: 5 طلبات في الدقيقة لكل عنوان IP

جسم الطلب

{
  "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. ويمكن ضبط الطلبات على CANCELLED من PENDING أو CONFIRMED.