--- title: "Detalhe do pedido" description: "GET /v1/orders/{orderId} — detalhe completo do pedido na API BeeFood." method: "GET" path: "/v1/orders/{orderId}" url: "https://developer.beefood.com.br/docs/pedidos/detalhe" group: "Pedidos" scope: "orders:read" lang: "pt" --- # Detalhe do pedido `GET /v1/orders/{orderId}` - Produção: `https://api.beefood.app/v1/orders/{orderId}` - Sandbox: `https://api-sandbox.beefood.app/v1/orders/{orderId}` Retorna o detalhe de um pedido. ## Autenticação Envie o access token no header `Authorization: Bearer `. Escopo necessário: `orders:read`. Limite: 300 requisições a cada 3 minutos. ## Parâmetros de path - `orderId` *integer* **obrigatório** — ID do pedido. Exemplo: `123`. ## Exemplos de requisição ### cURL ```bash curl -X GET "https://api.beefood.app/v1/orders/{orderId}" \ -H "Authorization: Bearer $ACCESS_TOKEN" ``` ## Exemplos de resposta ### Tipo Mesa ```json { "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" } } ``` ### Pedido Mesa Agrupado ```json { "orderId": 58702878, "saleNumber": 941, "orderType": "TABLE", "salesChannel": "MANUAL", "orderStatus": "GROUPED", "orderIdGrouped": 60181832, "createdAt": "2026-09-06T14:00:38.000-03:00", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "items": [ { "itemId": "137460772", "productId": "2515373", "itemName": "Anéis de Cebola Empanada", "quantity": 1, "unitPrice": 19.2, "optionsPrice": 0, "finalPrice": 19.2, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com", "employeeId": 194115, "employeeName": "Restaurante Exemplo" } } ], "total": { "itemsPrice": 19.2, "deliveryFee": 0, "discount": 0, "additionalFees": 0, "waiterServiceFee": 0, "orderAmount": 19.2 }, "indoor": { "tableId": "1192721", "tableCode": "16", "tableDescription": "Mesa 16", "waiter": { "employeeId": 194115, "employeeName": "Restaurante Exemplo", "waiterServiceFeeType": "PERCENT", "waiterServiceFeeValue": 10 } }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com", "employeeId": 194115, "employeeName": "Restaurante Exemplo" } } ``` ### Tipo PDV ```json { "orderId": 59204137, "saleNumber": 968, "orderNumber": 32, "orderType": "PDV", "salesChannel": "MANUAL", "orderStatus": "RECEIVED", "createdAt": "2026-09-13T12:44:50.000-03:00", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "items": [ { "itemId": "138434648", "productId": "2515341", "itemName": "Combo One Burger", "quantity": 1, "unitPrice": 39, "optionsPrice": 11, "finalPrice": 50, "excluded": false, "options": [ { "optionId": "100055486", "productId": "2515296", "optionName": "One Burger", "productGroupId": "257194", "quantity": 1, "unitPrice": 0 }, { "optionId": "100055487", "productId": "2515323", "optionName": "Batata frita", "productGroupId": "257187", "quantity": 1, "unitPrice": 3 }, { "optionId": "100055488", "productId": "2515308", "optionName": "Coca Cola 350ml", "productGroupId": "257188", "quantity": 1, "unitPrice": 8 }, { "optionId": "100055489", "productId": "2515343", "optionName": "Sem Maionese Verde", "productGroupId": "257196", "quantity": 1, "unitPrice": 0 } ], "user": { "userId": 88711, "userLogin": "operador@exemplo.com", "employeeId": 194115, "employeeName": "Restaurante Exemplo" } }, { "itemId": "138434650", "productId": "2515377", "itemName": "Mozza Sticks + Molho", "quantity": 1, "unitPrice": 35.9, "optionsPrice": 0, "finalPrice": 35.9, "excluded": false, "options": [ { "optionId": "100055490", "productId": "2515378", "optionName": "Molho verde", "productGroupId": "257216", "quantity": 1, "unitPrice": 0 } ], "user": { "userId": 88711, "userLogin": "operador@exemplo.com", "employeeId": 194115, "employeeName": "Restaurante Exemplo" } } ], "discount": { "type": "OTHER", "value": 0.75 }, "payments": { "prepaid": 74.15, "pending": 0, "methods": [ { "paymentId": 66691961, "value": 74.15, "valueLiquid": 74.15, "paid": true, "paidOnline": false, "dueDate": "2026-09-13T00:00:00.000-03:00", "paymentDateTime": "2026-09-13T12:45:00.000-03:00", "method": { "methodId": 381234, "name": "Dinheiro", "type": "CASH" }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ] }, "total": { "itemsPrice": 74.9, "deliveryFee": 0, "discount": 0.75, "additionalFees": 0, "waiterServiceFee": 0, "orderAmount": 74.15 }, "delivery": { "deliveryType": "TAKEOUT", "deliveryStatus": "PREPARING", "timeline": { "acceptedDateTime": "2026-09-13T12:44:50.000-03:00" } }, "indoor": { "waiter": { "employeeId": 194115, "employeeName": "Restaurante Exemplo" } }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com", "employeeId": 194115, "employeeName": "Restaurante Exemplo" } } ``` ### Marketplaces · Aiqfome ```json { "orderId": 57938276, "saleNumber": 865, "orderNumber": 12, "orderType": "DELIVERY", "salesChannel": "AIQFOME", "orderStatus": "CLOSED", "createdAt": "2026-08-27T12:09:32.000-03:00", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "external": { "externalOrderId": "140079601" }, "customer": { "customerId": "123456", "customerName": "Mariana Souza", "documentNumber": "12345678900", "email": "contato@exemplo.com", "phone": { "number": "11999990000", "extension": "+55" } }, "schedule": { "scheduledDateTimeStart": "2026-08-27T00:00:00.000-03:00" }, "items": [ { "itemId": "135946483", "productId": "", "itemName": "sorvete 1 medio", "quantity": 3, "unitPrice": 10, "optionsPrice": 0, "finalPrice": 30, "excluded": false, "itemObservations": "sorvetes medio" } ], "payments": { "prepaid": 36.03, "pending": 0, "methods": [ { "paymentId": 65095637, "value": 36.03, "valueLiquid": 36.03, "paid": true, "paidOnline": false, "dueDate": "2026-09-02T00:00:00.000-03:00", "paymentDateTime": "2026-09-02T00:00:00.000-03:00", "method": { "methodId": 381234, "name": "Dinheiro", "type": "CASH" }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ] }, "total": { "itemsPrice": 0, "deliveryFee": 5, "discount": 0, "additionalFees": 1, "waiterServiceFee": 0, "orderAmount": 36.03 }, "delivery": { "deliveryType": "DELIVERY", "deliveryStatus": "DELIVERED", "timeline": { "acceptedDateTime": "2026-08-27T12:09:32.000-03:00", "startedDateTime": "2026-08-27T12:12:29.000-03:00" }, "address": { "addressId": 12137092, "street": "Rua das Flores", "number": "123", "complement": " -", "neighborhood": "Centro", "city": "Tupiratins", "state": "TO", "postalCode": "18040370", "latitude": -23.5015, "longitude": -47.4526 } } } ``` ### Marketplaces · iFood ```json { "orderId": 59621229, "saleNumber": 1133, "orderNumber": 1133, "orderType": "DELIVERY", "salesChannel": "IFOOD", "orderStatus": "RECEIVED", "createdAt": "2026-09-19T17:11:17.953-03:00", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "external": { "externalOrderId": "b4e2f7a1-6c39-4d08-85b7-1f2ae906c34d", "externalOrderShortId": "2740 - Coleta 6118", "phoneTempCode": "12345678" }, "customer": { "customerId": "13118938", "customerName": "Ana Moraes" }, "schedule": { "scheduledDateTimeStart": "2026-09-19T00:00:00.000-03:00" }, "items": [ { "itemId": "139230562", "productId": "1965722", "itemName": "Shake de Açaí (330 ml)", "quantity": 1, "unitPrice": 12.9, "optionsPrice": 0, "finalPrice": 12.9, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ], "total": { "itemsPrice": 12.9, "deliveryFee": 7, "discount": 0, "additionalFees": 0, "waiterServiceFee": 0, "orderAmount": 19.9 }, "delivery": { "deliveryType": "DELIVERY", "deliveryStatus": "DELIVERED", "timeline": { "acceptedDateTime": "2026-09-19T17:11:17.953-03:00", "startedDateTime": "2026-09-19T17:11:17.953-03:00" }, "pickupCode": "90612447", "address": { "addressId": 13268347, "street": "Rua das Flores", "number": "123", "neighborhood": "Centro", "city": "Sorocaba", "state": "SP", "postalCode": "18040370", "latitude": -23.5015, "longitude": -47.4526 } }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ``` ### Marketplaces · 99Food ```json { "orderId": 59621231, "saleNumber": 1135, "orderNumber": 1135, "orderType": "DELIVERY", "salesChannel": "99FOOD", "orderStatus": "RECEIVED", "createdAt": "2026-09-19T17:11:17.953-03:00", "orderObservations": "Cód. retirada 99: 4821", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "external": { "externalOrderId": "5764687533109824571", "externalOrderShortId": "392011" }, "customer": { "customerId": "13118940", "customerName": "Fernanda Lima" }, "schedule": { "scheduledDateTimeStart": "2026-09-19T00:00:00.000-03:00" }, "items": [ { "itemId": "139230565", "productId": "1965728", "itemName": "Açai Mini 220ml", "quantity": 1, "unitPrice": 17.9, "optionsPrice": 0, "finalPrice": 17.9, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } }, { "itemId": "139230566", "productId": "1965729", "itemName": "Sorvete Pequeno", "quantity": 1, "unitPrice": 20, "optionsPrice": 0, "finalPrice": 20, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } }, { "itemId": "139230568", "productId": "1965730", "itemName": "Sorvete Pequeno", "quantity": 1, "unitPrice": 20, "optionsPrice": 0, "finalPrice": 20, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ], "total": { "itemsPrice": 57.9, "deliveryFee": 6, "discount": 0, "additionalFees": 0, "waiterServiceFee": 0, "orderAmount": 63.9 }, "delivery": { "deliveryType": "DELIVERY", "deliveryStatus": "DELIVERED", "timeline": { "acceptedDateTime": "2026-09-19T17:11:17.953-03:00", "startedDateTime": "2026-09-19T17:11:17.953-03:00" }, "address": { "addressId": 13268349, "street": "Rua das Flores", "number": "123", "neighborhood": "Centro", "city": "Sorocaba", "state": "SP", "postalCode": "18040370", "latitude": -23.5015, "longitude": -47.4526 } }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ``` ### Método de pagamento · Cartão de crédito ```json { "orderId": 59816986, "saleNumber": 1151, "orderType": "DELIVERY", "salesChannel": "MANUAL", "orderStatus": "RECEIVED", "createdAt": "2026-09-22T10:33:37.173-03:00", "orderObservations": "Portão azul, chamar no interfone.", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "customer": { "customerId": "13183068", "customerName": "Gustavo Almeida" }, "schedule": { "scheduledDateTimeStart": "2026-09-22T00:00:00.000-03:00" }, "items": [ { "itemId": "139618936", "productId": "1965731", "itemName": "Shake de Açaí C/ Laranja (550 ML)", "quantity": 1, "unitPrice": 20.9, "optionsPrice": 0, "finalPrice": 20.9, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ], "payments": { "prepaid": 32.9, "pending": 0, "methods": [ { "paymentId": 67485277, "value": 32.9, "taxType": "PERCENT", "taxValue": 3.49, "valueLiquid": 31.75, "paid": true, "paidOnline": false, "dueDate": "2026-09-22T00:00:00.000-03:00", "paymentDateTime": "2026-09-22T15:15:56.000-03:00", "estimatedReceivedDate": "2026-10-22T00:00:00.000-03:00", "receivedDate": "2026-10-22T00:00:00.000-03:00", "method": { "methodId": 381236, "name": "Crédito", "type": "CREDIT_CARD" }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ] }, "total": { "itemsPrice": 20.9, "deliveryFee": 12, "discount": 0, "additionalFees": 0, "waiterServiceFee": 0, "orderAmount": 32.9 }, "delivery": { "deliveryType": "DELIVERY", "deliveryStatus": "DELIVERED", "timeline": { "acceptedDateTime": "2026-09-22T10:33:37.173-03:00", "startedDateTime": "2026-09-22T10:33:37.173-03:00", "deliveredDateTime": "2026-09-22T15:15:56.000-03:00" }, "address": { "addressId": 13334577, "street": "Rua das Flores", "number": "123", "neighborhood": "Centro", "city": "Sorocaba", "state": "SP", "postalCode": "18040370", "latitude": -23.5015, "longitude": -47.4526 }, "driver": { "employeeId": 194115, "employeeName": "Restaurante Exemplo" } }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ``` ### Método de pagamento · Cartão de débito ```json { "orderId": 59816985, "saleNumber": 1150, "orderType": "DELIVERY", "salesChannel": "MANUAL", "orderStatus": "RECEIVED", "createdAt": "2026-09-22T10:33:37.173-03:00", "orderObservations": "Portão azul, chamar no interfone.", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "customer": { "customerId": "13183067", "customerName": "Fernanda Lima" }, "schedule": { "scheduledDateTimeStart": "2026-09-22T00:00:00.000-03:00" }, "items": [ { "itemId": "139618932", "productId": "1965728", "itemName": "Açai Mini 220ml", "quantity": 1, "unitPrice": 17.9, "optionsPrice": 0, "finalPrice": 17.9, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } }, { "itemId": "139618933", "productId": "1965729", "itemName": "Sorvete Pequeno", "quantity": 1, "unitPrice": 20, "optionsPrice": 0, "finalPrice": 20, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } }, { "itemId": "139618934", "productId": "1965730", "itemName": "Sorvete Pequeno", "quantity": 1, "unitPrice": 20, "optionsPrice": 0, "finalPrice": 20, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ], "payments": { "prepaid": 63.9, "pending": 0, "methods": [ { "paymentId": 67485276, "value": 63.9, "taxType": "PERCENT", "taxValue": 2.5, "valueLiquid": 62.3, "paid": true, "paidOnline": false, "dueDate": "2026-09-22T00:00:00.000-03:00", "paymentDateTime": "2026-09-22T15:15:56.000-03:00", "estimatedReceivedDate": "2026-09-22T00:00:00.000-03:00", "receivedDate": "2026-09-22T00:00:00.000-03:00", "method": { "methodId": 381235, "name": "Débito", "type": "DEBIT_CARD" }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ] }, "total": { "itemsPrice": 57.9, "deliveryFee": 6, "discount": 0, "additionalFees": 0, "waiterServiceFee": 0, "orderAmount": 63.9 }, "delivery": { "deliveryType": "DELIVERY", "deliveryStatus": "DELIVERED", "timeline": { "acceptedDateTime": "2026-09-22T10:33:37.173-03:00", "startedDateTime": "2026-09-22T10:33:37.173-03:00", "deliveredDateTime": "2026-09-22T15:15:56.000-03:00" }, "address": { "addressId": 13334576, "street": "Rua das Flores", "number": "123", "neighborhood": "Centro", "city": "Sorocaba", "state": "SP", "postalCode": "18040370", "latitude": -23.5015, "longitude": -47.4526 }, "driver": { "employeeId": 194115, "employeeName": "Restaurante Exemplo" } }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ``` ### Método de pagamento · Dinheiro ```json { "orderId": 59835415, "saleNumber": 1167, "orderType": "DELIVERY", "salesChannel": "MANUAL", "orderStatus": "RECEIVED", "createdAt": "2026-09-22T15:57:03.513-03:00", "orderObservations": "[SEED-ENTREGAS] 2026-09-22 19:00", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "customer": { "customerId": "13188863", "customerName": "Simone Costa" }, "schedule": { "scheduledDateTimeStart": "2026-09-22T00:00:00.000-03:00" }, "items": [ { "itemId": "139647789", "productId": "1965746", "itemName": "Açaí Grande 770ml", "quantity": 1, "unitPrice": 33.9, "optionsPrice": 0, "finalPrice": 33.9, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } }, { "itemId": "139647790", "productId": "1965747", "itemName": "Açaí Médio com Nutella & Brownie", "quantity": 1, "unitPrice": 36, "optionsPrice": 0, "finalPrice": 36, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } }, { "itemId": "139647791", "productId": "1965748", "itemName": "Açaí Grande e Nutella", "quantity": 1, "unitPrice": 39.9, "optionsPrice": 0, "finalPrice": 39.9, "excluded": false, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ], "payments": { "prepaid": 120.8, "pending": 0, "methods": [ { "paymentId": 67487770, "value": 120.8, "valueLiquid": 120.8, "paid": true, "paidOnline": false, "dueDate": "2026-09-22T00:00:00.000-03:00", "paymentDateTime": "2026-09-22T16:10:47.000-03:00", "method": { "methodId": 381234, "name": "Dinheiro", "type": "CASH" }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ] }, "total": { "itemsPrice": 109.8, "deliveryFee": 11, "discount": 0, "additionalFees": 0, "waiterServiceFee": 0, "orderAmount": 120.8 }, "delivery": { "deliveryType": "DELIVERY", "deliveryStatus": "DELIVERED", "timeline": { "acceptedDateTime": "2026-09-22T15:57:03.513-03:00", "startedDateTime": "2026-09-22T15:57:03.513-03:00", "deliveredDateTime": "2026-09-22T16:10:47.000-03:00" }, "address": { "addressId": 13340615, "street": "Rua das Flores", "number": "123", "neighborhood": "Centro", "city": "Sorocaba", "state": "SP", "postalCode": "18040370", "latitude": -23.5015, "longitude": -47.4526 } }, "user": { "userId": 88711, "userLogin": "operador@exemplo.com" } } ``` ### Método de pagamento · Outro ```json { "orderId": 59434595, "saleNumber": 1012, "orderNumber": 46, "orderType": "DELIVERY", "salesChannel": "IFOOD", "orderStatus": "RECEIVED", "createdAt": "2026-09-17T10:10:44.707-03:00", "invoiceDocument": "FS999999", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "external": { "externalOrderId": "c8219a1f-9cea-4ce8-94e6-b25a28f81608", "externalOrderShortId": "3257 - Coleta 0771", "phoneTemp": "0800 000 0000", "phoneTempCode": "12345678" }, "customer": { "customerId": "12578119", "customerName": "Pedido de teste de integracao", "documentNumber": "FS999999" }, "schedule": { "scheduledDateTimeStart": "2026-09-17T00:00:00.000-03:00", "scheduledDateTimeEnd": "2026-09-17T10:55:00.000-03:00" }, "items": [ { "itemId": "138862961", "productId": "2515323", "itemName": "PRODUTO 1 - NÃO ENTREGAR - Primeiro Nível", "quantity": 1, "unitPrice": 5, "optionsPrice": 0, "finalPrice": 5, "excluded": false }, { "itemId": "138862962", "productId": "2515390", "itemName": "PRODUTO 2 (COMBO) - NÃO ENTREGAR - Primeiro Nível", "quantity": 1, "unitPrice": 16, "optionsPrice": 8, "finalPrice": 24, "excluded": false, "options": [ { "optionId": "100486278", "productId": "2515375", "optionName": "Complemento 1 - Segundo Nível", "quantity": 1, "unitPrice": 2 }, { "optionId": "100486279", "productId": "", "optionName": "Complemento 2 - Segundo Nível", "quantity": 1, "unitPrice": 2 }, { "optionId": "100486280", "productId": "", "optionName": "Complemento 3 - Segundo Nível", "quantity": 1, "unitPrice": 2 }, { "optionId": "100486281", "productId": "", "optionName": "Complemento 4 - Segundo Nível", "quantity": 1, "unitPrice": 2 } ] } ], "payments": { "prepaid": 27, "pending": 0, "methods": [ { "paymentId": 66987864, "value": 10, "valueLiquid": 10, "paid": true, "paidOnline": true, "dueDate": "2026-09-17T00:00:00.000-03:00", "brand": "Mastercard", "paymentDateTime": "2026-09-17T10:10:44.706-03:00", "method": { "methodId": 381240, "name": "iFood Online", "type": "OTHER" } }, { "paymentId": 66987863, "value": 17, "valueLiquid": 17, "paid": true, "paidOnline": true, "dueDate": "2026-09-17T00:00:00.000-03:00", "brand": "Visa", "paymentDateTime": "2026-09-17T10:10:44.706-03:00", "method": { "methodId": 381240, "name": "iFood Online", "type": "OTHER" } } ] }, "total": { "itemsPrice": 0, "deliveryFee": 5, "discount": 0, "additionalFees": 1, "waiterServiceFee": 0, "orderAmount": 27 }, "delivery": { "deliveryType": "DELIVERY", "estimatedDeliveryDateTime": "2026-09-17T10:55:00.000-03:00", "deliveryStatus": "DELIVERED", "timeline": { "acceptedDateTime": "2026-09-17T10:10:44.707-03:00", "startedDateTime": "2026-09-17T10:10:58.000-03:00", "deliveredDateTime": "2026-09-17T10:13:19.000-03:00" }, "pickupCode": "34391005", "address": { "addressId": 12721762, "street": "Rua das Flores", "number": "123", "complement": "Complemento TESTE - TESTE", "neighborhood": "Centro", "city": "", "state": "", "postalCode": "18040370" }, "driver": { "employeeId": 194115, "employeeName": "Restaurante Exemplo" } } } ``` ### Método de pagamento · Pix BeeFood ```json { "orderId": 55993945, "saleNumber": 767, "orderNumber": 43, "orderType": "DELIVERY", "salesChannel": "DIGITAL_MENU", "orderStatus": "RECEIVED", "createdAt": "2026-07-29T13:53:18.000-03:00", "merchant": { "storeId": 38311, "merchantId": 39202, "merchantName": "Restaurante Exemplo" }, "customer": { "customerId": "11900342", "customerName": "Gabriel Souza", "phone": { "number": "11999990000", "extension": "+55" } }, "schedule": { "scheduledDateTimeStart": "2026-07-29T00:00:00.000-03:00" }, "items": [ { "itemId": "132052797", "productId": "2207978", "itemName": "Coca Cola 350ml", "quantity": 3, "unitPrice": 4.44, "optionsPrice": 0, "finalPrice": 13.32, "excluded": false } ], "payments": { "prepaid": 13.32, "pending": 0, "methods": [ { "paymentId": 62649829, "value": 13.32, "taxType": "PERCENT", "taxValue": 1, "valueLiquid": 13.19, "paid": true, "paidOnline": true, "dueDate": "2026-07-29T00:00:00.000-03:00", "paymentDateTime": "2026-07-29T13:54:00.000-03:00", "estimatedReceivedDate": "2026-07-31T00:00:00.000-03:00", "receivedDate": "2026-07-29T00:00:00.000-03:00", "method": { "methodId": 486229, "name": "PIX Bee", "type": "PIX_BEEFOOD", "pix": { "pixId": 1114738, "txId": "g27LVdyEyGsCzBh9fgGbVzsNwxcQTE0uF2E", "status": "PAID", "qrCode": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAS...", "qrCodeText": "", "createdAt": "2026-07-29T13:53:19.000-03:00", "expiresAt": "2026-07-29T14:07:19.000-03:00" } } } ] }, "total": { "itemsPrice": 13.32, "deliveryFee": 0, "discount": 0, "additionalFees": 0, "waiterServiceFee": 0, "orderAmount": 13.32 }, "delivery": { "deliveryType": "TAKEOUT", "deliveryStatus": "DELIVERED", "timeline": { "acceptedDateTime": "2026-07-29T13:53:18.000-03:00", "deliveredDateTime": "2026-07-29T13:55:17.000-03:00" } } } ``` ## Campos da resposta - `orderId` *number* — ID do pedido. - `saleNumber` *number* — Número da venda no PDV. - `orderNumber` *number* — Número sequencial do pedido. - `displayId` *number* — Código amigável exibido ao cliente/restaurante. - `invoiceDocument` *string* — Documento para nota fiscal, se informado. - `cancellationReason` *string* — Motivo do cancelamento - `orderObservations` *string* — Observações gerais do pedido. - `orderType` *string* — Tipo do pedido. - *Valores:* `DELIVERY`, `PDV`, `TABLE` - `salesChannel` *string* — Canal de origem da venda. - *Valores:* `IFOOD`, `99FOOD`, `KEETA`, `AIQFOME`, `RAPPI`, `DELIVERYMUCH`, `UAIRANGO`, `TOTEM`, `EXTERNAL`, `WHATSAPP`, `DIGITAL_MENU`, `MANUAL` - `orderStatus` *string* — Situação atual do pedido. - *Valores:* `OPEN`, `RECEIVED`, `GROUPED`, `CLOSED`, `CANCELLED` - `orderIdGrouped` *number* — Identificador do pedido principal quando o pedido foi agrupado a outro (orderStatus GROUPED). - `merchant` *object* — Cardápio responsável pelo pedido. - `customer` *object* — Cliente do pedido. - `schedule` *object* — Agendamento do pedido - `items[]` *array* — Itens do pedido. - `discount` *object* — Desconto aplicado ao pedido. - `discount.coupon.target` *string* — Abrangência do cupom aplicado. - `payments` *object* — Pagamentos do pedido. - `payments.prepaid` *number* — Valor já pago antecipadamente. - `payments.pending` *number* — Valor pendente de pagamento. - `payments.methods[]` *array* — Lista de pagamentos realizados no pedido. - `payments.methods[].paymentId` *number* — Identificador único do pagamento. - `payments.methods[].value` *number* — Valor bruto do pagamento. - `payments.methods[].taxType` *string* — Tipo de taxa aplicada (PERCENT ou FIXED). - `payments.methods[].taxValue` *number* — Valor da taxa descontada. - `payments.methods[].valueLiquid` *number* — Valor líquido do pagamento após taxas. - `payments.methods[].paid` *boolean* — Indica se o pagamento já foi recebido. - `payments.methods[].paidOnline` *boolean* — Indica se o pagamento foi realizado online. - `payments.methods[].method` *object* — Método de pagamento utilizado (methodId, name, type). - `payments.methods[].method.methodId` *number* — Identificador do método de pagamento. - `payments.methods[].method.name` *string* — Nome legível do método de pagamento. - `payments.methods[].method.type` *string* — Tipo do método de pagamento (CREDIT_CARD, DEBIT_CARD, CASH, OTHER, PIX_BEEFOOD). - *Valores:* `CASH`, `CREDIT_CARD`, `DEBIT_CARD`, `PIX_BEEFOOD`, `FOOD_VOUCHER`, `MEAL_VOUCHER`, `DIGITAL_WALLET`, `STORE_CREDIT`, `OTHER` - `payments.methods[].brand` *string* — Bandeira do cartão, quando aplicável. - `payments.methods[].changeFor` *number* — Valor para troco, quando o pagamento for em dinheiro. - `payments.methods[].paymentDateTime` *string* — Data e hora em que o pagamento foi realizado. - `payments.methods[].estimatedReceivedDate` *string* — Data estimada de recebimento do valor. - `payments.methods[].receivedDate` *string* — Data efetiva de recebimento do valor. - `payments.methods[].dueDate` *string* — Data de vencimento do pagamento. - `payments.methods[].user` *object* — Operador responsável pelo registro do pagamento. - `payments.methods[].user.userId` *number* — Identificador do operador no sistema. - `payments.methods[].user.userLogin` *string* — Login do operador. - `payments.methods[].user.employeeId` *number* — Identificador do funcionário vinculado ao operador. - `payments.methods[].user.employeeName` *string* — Nome do funcionário vinculado ao operador. - `total` *object* — Totais do pedido. - `delivery` *object* — Dados da entrega ou retirada. - `indoor` *object* — Dados de mesa/salão. - `external` *object* — Dados do canal externo - `user` *object* — Quem registrou o pedido. - `user.userId` *number* — ID do usuário no sistema. - `user.employeeId` *number* — ID do funcionário. - `items[].user` *object* — Operador que registrou o item. - `items[].user.userId` *number* — ID do usuário no sistema. - `items[].user.employeeId` *number* — ID do funcionário. - `merchant.storeId` *number* — ID do restaurante. - `merchant.merchantId` *number* — ID do cardápio. - `merchant.merchantName` *string* — Nome do cardápio. - `external.externalOrderId` *string* — ID do pedido no marketplace ou, sem marketplace, o identificador enviado na criação. - `external.externalOrderShortId` *string* — ID curto do pedido no canal externo. - `external.phoneTemp` *string* — Telefone temporário do canal (quando houver). - `external.phoneTempCode` *string* — Código do telefone temporário. - `external.observation` *string* — Observação vinda do canal externo. - `customer.customerId` *string* — ID do cliente. - `customer.customerName` *string* — Nome principal do cadastro do cliente. - `customer.tradeName` *string* — Apelido do cliente, o mesmo de GET /v1/customers. - `customer.documentNumber` *string* — CPF/CNPJ do cliente. - `customer.email` *string* — E-mail do cliente. - `customer.phone` *object* — Telefone do cliente. - `customer.phone.number` *string* — Número do telefone. - `customer.phone.extension` *string* — DDI (ex.: +55). - `customer.ordersCount` *number* — Quantidade de pedidos deste cliente. - `schedule.scheduledDateTimeStart` *string (ISO 8601)* — Início da janela agendada. - `schedule.scheduledDateTimeEnd` *string (ISO 8601)* — Fim da janela agendada. - `items[].itemId` *string* — ID do item no pedido. - `items[].productId` *string* — ID do produto no cardápio. - `items[].itemName` *string* — Nome do item. - `items[].quantity` *number* — Quantidade pedida. - `items[].unitPrice` *number* — Preço unitário do item. - `items[].optionsPrice` *number* — Soma dos preços dos adicionais deste item. - `items[].finalPrice` *number* — Valor final do item, incluindo adicionais. - `items[].excluded` *boolean* — Indica se o item foi excluído do pedido. - `items[].itemObservations` *string* — Observação específica do item. - `items[].options` *array* — Lista de adicionais/opções do item. - `items[].options[].optionId` *string* — ID da opção adicional. - `items[].options[].productId` *string* — ID do produto da opção adicional. - `items[].options[].optionName` *string* — Nome da opção adicional. - `items[].options[].productGroupId` *string* — Grupo de opções a que pertence. - `items[].options[].quantity` *number* — Quantidade da opção adicional. - `items[].options[].unitPrice` *number* — Preço unitário da opção adicional. - `items[].user.userLogin` *string* — Login do usuário. - `items[].user.employeeName` *string* — Nome do funcionário. - `discount.type` *string* — Tipo do desconto aplicado. - `discount.value` *number* — Valor do desconto. - `discount.coupon` *object* — Cupom usado - `discount.coupon.couponId` *number* — ID do cupom. - `discount.coupon.code` *string* — Código do cupom. - `discount.coupon.type` *string* — Tipo do benefício do cupom. - `discount.coupon.discountValue` *number* — Valor concedido pelo cupom. - `payments.methods` *array* — Formas de pagamento usadas. - `total.itemsPrice` *number* — Soma dos itens. - `total.deliveryFee` *number* — Taxa de entrega. - `total.discount` *number* — Total de descontos. - `total.additionalFees` *number* — Taxas adicionais. - `total.waiterServiceFee` *number* — Valor da taxa de serviço cobrado no pedido. - `total.orderAmount` *number* — Valor final do pedido. - `delivery.deliveryType` *string* — Modalidade de entrega/retirada. - *Valores:* `DELIVERY`, `TAKEOUT`, `DINE_IN` - `delivery.deliveredBy` *string* — Quem realiza a entrega. - `delivery.estimatedDeliveryDateTime` *string* — Previsão de entrega. - `delivery.deliveryStatus` *string* — Status atual da entrega. - *Valores:* `WAITING`, `ACCEPTED`, `PREPARING`, `READY`, `DISPATCHED`, `DELIVERED`, `CANCELLED` - `delivery.paymentIntent` *object* — Intenção de pagamento avisada no pedido; omitido sem forma e sem troco. O que foi pago fica em payments. - `delivery.paymentIntent.paymentMethod` *string* — Forma avisada na intenção, em texto livre (ex.: Dinheiro). - `delivery.paymentIntent.brand` *string* — Bandeira avisada na intenção. - `delivery.paymentIntent.changeFor` *number* — Troco para. Omitido quando não informado. - `delivery.pickupCode` *string* — Código para retirada. - `delivery.timeline` *object* — Marcos de tempo da entrega. - `delivery.timeline.acceptedDateTime` *string* — Quando o pedido foi aceito. - `delivery.timeline.startedDateTime` *string* — Quando a preparação começou. - `delivery.timeline.readyDateTime` *string* — Quando ficou pronto. - `delivery.timeline.pickupDateTime` *string* — Quando saiu para entrega / foi retirado. - `delivery.timeline.deliveredDateTime` *string* — Quando foi entregue. - `delivery.address` *object* — Endereço de entrega. - `delivery.address.addressId` *string* — ID do endereço. - `delivery.address.street` *string* — Rua. - `delivery.address.number` *string* — Número. - `delivery.address.complement` *string* — Complemento. - `delivery.address.neighborhood` *string* — Bairro. - `delivery.address.city` *string* — Cidade. - `delivery.address.state` *string* — UF. - `delivery.address.postalCode` *string* — CEP, só dígitos. - `delivery.address.latitude` *number* — Latitude. - `delivery.address.longitude` *number* — Longitude. - `delivery.driver` *object* — Entregador vinculado. - `delivery.driver.employeeId` *number* — ID do entregador. - `delivery.driver.employeeName` *string* — Nome do entregador. - `delivery.driver.driverEarning` *number* — Valor pago ao entregador. - `indoor.commandId` *string* — ID da comanda. - `indoor.commandCode` *string* — Código da comanda. - `indoor.commandDescription` *string* — Descrição da comanda. - `indoor.tableId` *string* — ID da mesa cadastrada. - `indoor.tableCode` *string* — Código da mesa cadastrada. - `indoor.tableDescription` *string* — Descrição da mesa cadastrada. - `indoor.randomName` *string* — Nome avulso informado na mesa. - `indoor.waiter` *object* — Garçom responsável. - `indoor.waiter.employeeId` *number* — ID do garçom. - `indoor.waiter.employeeName` *string* — Nome do garçom. - `indoor.waiter.waiterServiceFeeType` *string* — Tipo da taxa de serviço: PERCENT ou FIXED. - `indoor.waiter.waiterServiceFeeValue` *number* — Alíquota quando PERCENT ou valor em reais quando FIXED. - `user.userLogin` *string* — Login do usuário. - `user.employeeName` *string* — Nome do funcionário. ## Erros | Status | Mensagem | | --- | --- | | 400 | 'id' must be a positive integer | | 401 | Authentication token is missing | | 401 | Invalid or expired access token | | 403 | This credential does not include the orders:read scope | | 404 | Order ID 123 not found | | 429 | Too Many Requests | | 500 | Database error when trying to … | ## Vocabulários usados neste endpoint ## Pedidos · orderStatus | Valor | Significado | Uso | | --- | --- | --- | | `OPEN` | Aberto | Lista e detalhe de pedidos | | `RECEIVED` | Recebido | Lista e detalhe de pedidos | | `GROUPED` | Agrupado a outro pedido | Pedido somado a outro; orderIdGrouped indica o pedido principal | | `CLOSED` | Fechado | Lista e detalhe de pedidos | | `CANCELLED` | Cancelado | Lista e detalhe de pedidos | ## Pedidos · deliveryStatus Situação operacional do pedido. Aparece na lista e no detalhe e é espelhada nos webhooks de status. | Valor | Significado | Uso | | --- | --- | --- | | `WAITING` | Aguardando | Pedidos e webhooks | | `ACCEPTED` | Aceito | Pedidos e webhooks | | `PREPARING` | Em preparo | Pedidos e webhooks | | `READY` | Pronto | Pedidos e webhooks | | `DISPATCHED` | Despachado | Pedidos e webhooks | | `DELIVERED` | Entregue | Pedidos e webhooks | | `CANCELLED` | Cancelado | Pedidos e webhooks | ## Pedidos · deliveryType | Valor | Significado | Uso | | --- | --- | --- | | `DELIVERY` | Entrega | Lista e detalhe de pedidos | | `TAKEOUT` | Retirada | Lista e detalhe de pedidos | | `DINE_IN` | Consumo no local | Lista e detalhe de pedidos | ## Pedidos · orderType Outros literais vindos do PDV podem aparecer sem tradução. | Valor | Significado | Uso | | --- | --- | --- | | `DELIVERY` | Pedido delivery | Detalhe do pedido | | `PDV` | Pedido lançado no PDV | Detalhe do pedido | | `TABLE` | Mesa / presencial | Detalhe do pedido | ## Pedidos · salesChannel | Valor | Significado | Uso | | --- | --- | --- | | `IFOOD` | iFood | Detalhe, listagem (filtro), polling e webhooks | | `99FOOD` | 99Food | Detalhe, listagem (filtro), polling e webhooks | | `KEETA` | Keeta | Detalhe, listagem (filtro), polling e webhooks | | `AIQFOME` | Aiqfome | Detalhe, listagem (filtro), polling e webhooks | | `RAPPI` | Rappi | Detalhe, listagem (filtro), polling e webhooks | | `DELIVERYMUCH` | Delivery Much | Detalhe, listagem (filtro), polling e webhooks | | `UAIRANGO` | UaiRango | Detalhe, listagem (filtro), polling e webhooks | | `TOTEM` | Totem | Detalhe, listagem (filtro), polling e webhooks | | `EXTERNAL` | Integração externa | Detalhe, listagem (filtro), polling e webhooks | | `WHATSAPP` | Cardápio digital via WhatsApp | Detalhe, listagem (filtro), polling e webhooks | | `DIGITAL_MENU` | Cardápio digital | Detalhe, listagem (filtro), polling e webhooks | | `MANUAL` | Lançamento manual / PDV | Detalhe, listagem (filtro), polling e webhooks | ## Pagamento · method.type Mesmo vocabulário usado no bloco payments do pedido e nas formas de pagamento permitidas em cupons. | Valor | Significado | Uso | | --- | --- | --- | | `CASH` | Dinheiro | Pedidos e cupons | | `CREDIT_CARD` | Cartão de crédito | Pedidos e cupons | | `DEBIT_CARD` | Cartão de débito | Pedidos e cupons | | `PIX_BEEFOOD` | Pix BeeFood | Pedidos e cupons | | `FOOD_VOUCHER` | Vale-alimentação | Pedidos e cupons | | `MEAL_VOUCHER` | Vale-refeição | Pedidos e cupons | | `DIGITAL_WALLET` | Carteira digital | Pedidos e cupons | | `STORE_CREDIT` | Crédito no restaurante | Pedidos e cupons | | `OTHER` | Outro | Pedidos e cupons |