API de pedidos
A API de pedidos cuida da criação de pedidos (pública, para clientes) e do gerenciamento de pedidos (autenticado, para donos de restaurante). O complemento Ordering Suite precisa estar ativo no restaurante.
POST /api/orders
Cria um novo pedido. Este é um endpoint público usado pelos clientes que fazem pedidos pelo cardápio.
Autenticação: pública (nenhum token necessário)
Limite de taxa: 5 requisições por minuto por IP
Corpo da requisição
{
"restaurantId": "uuid",
"tableId": "uuid",
"items": [
{
"menuItemId": "uuid",
"quantity": 2
},
{
"menuItemId": "uuid",
"quantity": 1
}
]
}
Resposta (201 Created)
{
"success": true,
"data": {
"id": "uuid",
"status": "PENDING",
"tableLabel": "Table 5",
"items": [...],
"createdAt": "2026-02-19T14:30:00Z"
}
}
GET /api/orders
Recupera todos os pedidos do seu restaurante. Permite filtrar por status.
Autenticação: obrigatória (Bearer token)
Parâmetros de consulta
status— Filtra pelo status do pedido (por exemplo,?status=PENDING)
Resposta (200 OK)
{
"success": true,
"data": [
{
"id": "uuid",
"status": "PENDING",
"tableLabel": "Table 5",
"items": [...],
"createdAt": "2026-02-19T14:30:00Z"
}
]
}
GET /api/orders/[id]
Recupera um único pedido. Este endpoint oferece acesso em dois modos:
- Autenticado (dono): retorna os dados completos do pedido, incluindo todos os campos.
- Público (cliente): retorna campos limitados (status, itens, rótulo da mesa). Exige o parâmetro de consulta
restaurantId.
PATCH /api/orders/[id]
Atualiza o status de um pedido. Usado pelos donos de restaurante para mover os pedidos ao longo do ciclo de vida.
Autenticação: obrigatória (Bearer token)
Corpo da requisição
{
"status": "CONFIRMED"
}
Transições de status válidas: de PENDING para CONFIRMED, de CONFIRMED para PREPARING, de PREPARING para READY, de READY para SERVED. Os pedidos podem ser definidos como CANCELLED a partir de PENDING ou CONFIRMED.