Listar pedidos

GET

Markdown (LLM)

Retorna o histórico de pedidos do estabelecimento.

Escopo:orders:read

Limite:15 requisições por minuto.

Parâmetros de query

pageinteger

Página atual da lista.

1

limitinteger

Quantidade de itens por página.

20

sortstring

Ordem da lista: mais recentes (desc) ou mais antigos (asc).

Enum

ascCrescente
descDecrescente (padrão)

"desc"

saleDateFromstring (yyyy-mm-dd)

Início do período da data de venda. O intervalo entre saleDateFrom e saleDateTo não pode passar de 6 meses.

"2026-03-01"

saleDateTostring (yyyy-mm-dd)

Fim do período da data de venda. O intervalo entre saleDateFrom e saleDateTo não pode passar de 6 meses.

"2026-03-31"

orderTypestring

Filtra pelo tipo do pedido.

Enum

DELIVERYPedido delivery
PDVPedido lançado no PDV
TABLEMesa / presencial

"DELIVERY"

orderStatusstring

Filtra pelo status do pedido.

Enum

OPENAberto
RECEIVEDRecebido
GROUPEDAgrupado a outro pedido
CLOSEDFechado

"CLOSED"

deliveryTypestring

Filtra pela modalidade da entrega.

Enum

DELIVERYEntrega
TAKEOUTRetirada
DINE_INConsumo no local

"DELIVERY"

deliveryStatusstring

Filtra pelo status da entrega.

Enum

WAITINGAguardando
ACCEPTEDAceito
PREPARINGEm preparo
READYPronto

"DELIVERED"

salesChannelstring

Filtra pelo canal de venda: IFOOD, 99FOOD, KEETA, AIQFOME, RAPPI, DELIVERYMUCH, UAIRANGO, TOTEM, EXTERNAL, WHATSAPP, DIGITAL_MENU ou MANUAL.

Enum

IFOODiFood
99FOOD99Food
KEETAKeeta
AIQFOMEAiqfome

"DIGITAL_MENU"

merchantIdinteger

Filtra os pedidos de um cardápio.

1

customerIdinteger

Filtra pedidos de um cliente.

123456

documentNumberstring

Filtra pelo CPF ou CNPJ do cliente do pedido (somente dígitos).

"12345678900"

emailstring

Filtra pelo e-mail do cliente do pedido.

"cliente@exemplo.com"

phonestring

Filtra pelo telefone do cliente do pedido (somente dígitos).

"11999990000"

couponCodestring

Filtra pelos pedidos que usaram um cupom específico.

"PIX15%"

commandCodeinteger | integer[]

Filtra pelo código da comanda.

12

tableCodeinteger | integer[]

Filtra pelo código da mesa.

5

Parâmetros da resposta

pagenumber

Página atual da lista.

1

limitnumber

Quantidade de itens por página.

3

totalnumber

Total de registros encontrados.

252

pagesnumber

Total de páginas.

84

Linguagem

Produção

Requisição

GET /v1/orders

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/orders?saleDateFrom=2026-03-01&saleDateTo=2026-03-31&page=1&limit=20&sort=desc",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

1234567891011121314151617181920212223242526272829303132333435363738{
  "items": [
    {
      "orderId": 60181897,
      "createdAt": "2026-09-27T10:30:02.000-03:00",
      "orderStatus": "GROUPED",
      "orderIdGrouped": 60181902,
      "deliveryStatus": "PREPARING",
      "orderType": "TABLE",
      "deliveryType": "TAKEOUT",
      "orderAmount": 19.58,
      "paidAmount": 0
    },
    {
      "orderId": 60181831,
      "createdAt": "2026-09-27T10:27:41.000-03:00",
      "orderStatus": "GROUPED",
      "orderIdGrouped": 60181832,
      "deliveryStatus": "PREPARING",
      "orderType": "TABLE",
      "deliveryType": "TAKEOUT",
      "orderAmount": 29.37,
      "paidAmount": 0
    },
    {
      "orderId": 60181902,
      "createdAt": "2026-09-27T10:26:55.717-03:00",
      "orderStatus": "OPEN",
      "orderType": "TABLE",
      "orderAmount": 63.7,
      "paidAmount": 0
    }
  ],
  "page": 1,
  "limit": 3,
  "total": 252,
  "pages": 84
}