Saltar al contenido principal

Referencia de la API

API de pedidos

API de pedidos

La API de pedidos gestiona la creación de pedidos (pública, para los clientes) y la gestión de pedidos (autenticada, para los dueños de restaurantes). El complemento Ordering Suite debe estar activo en el restaurante.

POST /api/orders

Crea un pedido nuevo. Este es un endpoint público que usan los clientes al hacer pedidos desde el menú.

Autenticación: Pública (no se requiere token)

Límite de solicitudes: 5 solicitudes por minuto por IP

Cuerpo de la solicitud

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

Respuesta (201 Created)

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

GET /api/orders

Obtiene todos los pedidos de su restaurante. Admite filtrar por estado.

Autenticación: Obligatoria (token Bearer)

Parámetros de consulta

  • status — Filtra por estado del pedido (p. ej., ?status=PENDING)

Respuesta (200 OK)

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

GET /api/orders/[id]

Obtiene un solo pedido. Este endpoint admite acceso en dos modos:

  • Autenticado (dueño): Devuelve todos los datos del pedido, incluidos todos los campos.
  • Público (cliente): Devuelve campos limitados (estado, artículos, etiqueta de la mesa). Requiere el parámetro de consulta restaurantId.

PATCH /api/orders/[id]

Actualiza el estado de un pedido. Lo usan los dueños de restaurantes para mover los pedidos a lo largo del ciclo de vida.

Autenticación: Obligatoria (token Bearer)

Cuerpo de la solicitud

{
  "status": "CONFIRMED"
}

Transiciones de estado válidas: de PENDING a CONFIRMED, de CONFIRMED a PREPARING, de PREPARING a READY y de READY a SERVED. Los pedidos pueden pasar a CANCELLED desde PENDING o CONFIRMED.