Detalhe do pedido

GET

Markdown (LLM)

Retorna o detalhe de um pedido.

Escopo:orders:read

Limite:300 requisições a cada 3 minutos.

Parâmetros de path

orderIdinteger

ID do pedido.

123

Parâmetros da resposta

orderIdnumber

ID do pedido.

58672815

saleNumbernumber

Número da venda no PDV.

939

orderNumbernumber

Número sequencial do pedido.

displayIdnumber

Código amigável exibido ao cliente/restaurante.

invoiceDocumentstring

Documento para nota fiscal, se informado.

"12345678900"

cancellationReasonstring

Motivo do cancelamento

"Cliente desistiu do pedido"

orderObservationsstring

Observações gerais do pedido.

"Disponível por tempo indeterminado."

orderTypestring

Tipo do pedido.

Enum

DELIVERYPedido delivery
PDVPedido lançado no PDV
TABLEMesa / presencial

"TABLE"

salesChannelstring

Canal de origem da venda.

Enum

IFOODiFood
99FOOD99Food
KEETAKeeta
AIQFOMEAiqfome

"MANUAL"

orderStatusstring

Situação atual do pedido.

Enum

OPENAberto
RECEIVEDRecebido
GROUPEDAgrupado a outro pedido
CLOSEDFechado

"RECEIVED"

orderIdGroupednumber

Identificador do pedido principal quando o pedido foi agrupado a outro (orderStatus GROUPED).

Linguagem

Produção

Requisição

GET /v1/orders/{orderId}

12345678import axios from "axios";
const { data } = await axios({
  method: "get",
  url: "https://api.beefood.app/v1/orders/{orderId}",
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
});

Resposta

json

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100{
  "orderId": 58672815,
  "saleNumber": 939,
  "orderType": "TABLE",
  "salesChannel": "MANUAL",
  "orderStatus": "RECEIVED",
  "createdAt": "2026-09-05T21:44:59.000-03:00",
  "merchant": {
    "storeId": 38311,
    "merchantId": 39202,
    "merchantName": "Restaurante Exemplo"
  },
  "items": [
    {
      "itemId": "137397466",
      "productId": "2515303",
      "itemName": "Chicken Deluxe",
      "quantity": 1,
      "unitPrice": 14.5,
      "optionsPrice": 0,
      "finalPrice": 14.5,
      "excluded": false,
      "user": {
        "userId": 125334,
        "userLogin": "ana.operadora",
        "employeeId": 279482,
        "employeeName": "Ana Souza"
      }
    },
    {
      "itemId": "137397467",
      "productId": "2515373",
      "itemName": "Anéis de Cebola Empanada",
      "quantity": 1,
      "unitPrice": 19.2,
      "optionsPrice": 0,
      "finalPrice": 19.2,
      "excluded": false,
      "user": {
        "userId": 125334,
        "userLogin": "ana.operadora",
        "employeeId": 279482,
        "employeeName": "Ana Souza"
      }
    }
  ],
  "discount": {
    "type": "OTHER",
    "value": 0.34
  },
  "payments": {
    "prepaid": 34.81,
    "pending": 0,
    "methods": [
      {
        "paymentId": 66006198,
        "value": 34.81,
        "valueLiquid": 34.81,
        "paid": true,
        "paidOnline": false,
        "dueDate": "2026-09-05T00:00:00.000-03:00",
        "paymentDateTime": "2026-09-05T21:45:05.000-03:00",
        "method": {
          "methodId": 381234,
          "name": "Dinheiro",
          "type": "CASH"
        },
        "user": {
          "userId": 125334,
          "userLogin": "ana.operadora"
        }
      }
    ]
  },
  "total": {
    "itemsPrice": 33.7,
    "deliveryFee": 0,
    "discount": 0.34,
    "additionalFees": 0,
    "waiterServiceFee": 1.45,
    "orderAmount": 34.81
  },
  "indoor": {
    "tableId": "1192721",
    "tableCode": "16",
    "tableDescription": "Mesa 16",
    "waiter": {
      "employeeId": 279482,
      "employeeName": "Ana Souza",
      "waiterServiceFeeType": "PERCENT",
      "waiterServiceFeeValue": 10
    }
  },
  "user": {
    "userId": 125334,
    "userLogin": "ana.operadora",
    "employeeId": 279482,
    "employeeName": "Ana Souza"
  }
}