Docs/Recursos Core/orders
6 min de leituraAtualizado em 2026-09-07

Gestão de Pedidos (Orders API)

A API de pedidos permite que sistemas externos (ERPs, frentes de caixa, sistemas de esteira ou BI) acompanhem todos os pedidos do estabelecimento em tempo real.

Escopo Necessário

`orders:read`

1. Listar Pedidos

Endpoint: `GET /public/v1/orders`

Suporta paginação por cursor e filtros opcionais:

  • `limit` (padrão: 20, máximo: 100)
  • `cursor` (ID do último pedido retornado para busca da próxima página)
  • `status` (PENDING, CONFIRMED, READY, DISPATCHED, DELIVERED, CANCELLED)
  • curl -X GET "https://api.tarevo.com.br/public/v1/orders?limit=10" \
      -H "Authorization: Bearer <SEU_TOKEN>"

    Resposta de sucesso (200 OK):

    {
      "data": [
        {
          "id": "ord_01J7K...",
          "orderNumber": 1050,
          "status": "CONFIRMED",
          "type": "DELIVERY",
          "total": 68.90,
          "customer": {
            "name": "Ana Clara",
            "phone": "+5511999998888"
          },
          "items": [
            {
              "name": "Smash Burger Duplo",
              "quantity": 1,
              "unitPrice": 38.00,
              "total": 38.00
            }
          ],
          "createdAt": "2026-09-07T14:30:00Z"
        }
      ],
      "pagination": {
        "hasMore": true,
        "nextCursor": "ord_01J7K..."
      }
    }

    2. Detalhes de um Pedido

    Endpoint: `GET /public/v1/orders/{id}`

    Retorna todos os detalhes cadastrais, taxas de entrega, endereço e histórico de status.