Documentação técnica dos endpoints da API Alfa Labs (versão 2.0).
\nAutenticação: Todas as rotas exigem Bearer Token via variável de ambiente token.
Busca pedidos com filtros opcionais.
\n{\n \"success\": true,\n \"totalPags\": null,\n \"data\": [\n {\n \"id\": \"3218614\",\n \"created_at\": \"2025-11-25 15:03:13\",\n \"status\": \"Finalizado\",\n \"number\": 3967,\n \"origin\": \"Telefone\",\n \"deliveryType\": \"Delivery\",\n \"documentReceipt\": null,\n \"observations\": \"pedido de teste\",\n \"merchant\": {\n \"id\": 1,\n \"name\": \"A\"\n },\n \"rating\": {\n \"value\": null,\n \"description\": null\n },\n \"customer\": {\n \"id\": 721566,\n \"name\": \"felipe\",\n \"email\": \"\",\n \"phone\": \"(47) 99987-0488\",\n \"document\": \"00.000.000/0000-00\"\n },\n \"address\": {\n \"id\": 737653,\n \"pickupCode\": null,\n \"streetName\": \"Rua Leão Marinho\",\n \"streetNumber\": \"123\",\n \"postalCode\": \"88215000\",\n \"city\": \"São Paulo\",\n \"neighborhood\": \"Vila Marieta\",\n \"state\": null,\n \"country\": \"Brasil\",\n \"reference\": \"lado\",\n \"complement\": \"casa\",\n \"coordinates\": {\n \"latitude\": null,\n \"longitude\": null\n }\n },\n \"payments\": [\n {\n \"method\": \"Cartão de Débito\",\n \"value\": 50,\n \"pending\": false,\n \"card\": {\n \"brand\": \"Maestro\"\n }\n },\n {\n \"method\": \"Dinheiro\",\n \"value\": 53,\n \"pending\": false,\n \"cash\": {\n \"changeFor\": 100\n }\n }\n ],\n \"items\": [\n {\n \"id\": \"6045565\",\n \"name\": \"X-Tudo\",\n \"externalCode\": null,\n \"quantity\": 2,\n \"unitPrice\": 50,\n \"price\": 100,\n \"observations\": null,\n \"category\": \"Sobremesa\",\n \"flavors\": [],\n \"additions\": [],\n \"complements\": [\n {\n \"title\": \"Ponto da carne\",\n \"chargeHigherPrice\": false,\n \"chargeMediumPrice\": false,\n \"options\": [\n {\n \"name\": \"Mal passado\",\n \"externalCode\": \"mp\",\n \"quantity\": 1,\n \"unitPrice\": 0,\n \"price\": 0\n }\n ]\n }\n ]\n }\n ],\n \"timeline\": [\n {\n \"status\": \"Realizado\",\n \"date\": \"2025-11-25 15:03:13\"\n },\n {\n \"status\": \"Finalizado\",\n \"date\": \"2025-11-25 15:03:20\"\n }\n ],\n \"discountDetails\": {\n \"code\": null,\n \"discount\": 0,\n \"marketplace\": 0,\n \"fixe\": 0,\n \"cashback\": 0,\n \"total\": 0\n },\n \"total\": {\n \"subTotal\": 100,\n \"deliveryFee\": 3,\n \"discount\": 0,\n \"addition\": 0,\n \"orderAmount\": 103\n }\n }\n ]\n}\n\nCria um novo pedido no sistema.
\norigin (string, obrigatório) — Origem do pedido (WhatsApp, Totem).
deliveryType (string, obrigatório) — Tipo de entrega (Delivery, Balcão).
customer (object, obrigatório) — Cliente associado ao pedido.
address (object, obrigatório se Delivery) — Endereço de entrega.
payments (array, obrigatório) — Métodos de pagamento e valores.
items (array, obrigatório) — Lista de itens do pedido.
total (object, obrigatório) — Totais e descontos.
{\n \"origin\": \"WhatsApp\",\n \"deliveryType\": \"Delivery\",\n \"documentReceipt\": \"123.456.789-00\",\n \"observations\": \"Entregar na portaria\",\n \"customer\": {\n \"id\": 123\n },\n \"address\": {\n \"streetName\": \"Rua das Flores\",\n \"streetNumber\": \"123\",\n \"postalCode\": \"12345678\",\n \"city\": \"Florianópolis\",\n \"neighborhood\": \"Centro\",\n \"state\": \"SC\",\n \"country\": \"Brasil\",\n \"reference\": \"Próximo ao mercado\",\n \"complement\": \"Apto 101\",\n \"coordinates\": {\n \"latitude\": -27.5954,\n \"longitude\": -48.5480\n }\n },\n \"payments\": [\n {\n \"method\": \"Cartão de Crédito\",\n \"value\": 50.00,\n \"card\": {\n \"brand\": \"Visa\"\n }\n },\n {\n \"method\": \"Dinheiro\",\n \"value\": 25.50,\n \"cash\": {\n \"changeFor\": 30.00\n }\n }\n ],\n \"items\": [\n {\n \"name\": \"X-Burguer Completo\",\n \"externalCode\": \"XB001\",\n \"quantity\": 1,\n \"unitPrice\": 25.50,\n \"price\": 25.50,\n \"category\": \"Lanches\",\n \"observations\": \"Sem cebola\",\n \"flavors\": [\"Bovino\"],\n \"additions\": [\"Bacon\", \"Queijo Extra\"],\n \"complements\": [\n {\n \"title\": \"Escolha o Pão\",\n \"isFraction\": false,\n \"chargeHigherPrice\": false,\n \"chargeMediumPrice\": false,\n \"options\": [\n {\n \"name\": \"Pão Australiano\",\n \"externalCode\": \"PAO001\",\n \"quantity\": 1,\n \"unitPrice\": 2.00,\n \"price\": 2.00\n }\n ]\n },\n {\n \"title\": \"Adicionais\",\n \"isFraction\": false,\n \"chargeHigherPrice\": true,\n \"chargeMediumPrice\": false,\n \"options\": [\n {\n \"name\": \"Ovo\",\n \"externalCode\": \"OVO001\",\n \"quantity\": 1,\n \"unitPrice\": 1.50,\n \"price\": 1.50\n },\n {\n \"name\": \"Batata Palha\",\n \"externalCode\": \"BAT001\",\n \"quantity\": 1,\n \"unitPrice\": 1.00,\n \"price\": 1.00\n }\n ]\n },\n {\n \"title\": \"Bebida\",\n \"isFraction\": false,\n \"chargeHigherPrice\": false,\n \"chargeMediumPrice\": true,\n \"options\": [\n {\n \"name\": \"Coca-Cola 350ml\",\n \"externalCode\": \"COC001\",\n \"quantity\": 1,\n \"unitPrice\": 4.50,\n \"price\": 4.50\n }\n ]\n }\n ]\n },\n {\n \"name\": \"Batata Frita\",\n \"externalCode\": \"BAT002\",\n \"quantity\": 2,\n \"unitPrice\": 8.00,\n \"price\": 16.00,\n \"category\": \"Acompanhamentos\",\n \"observations\": null,\n \"flavors\": [],\n \"additions\": [\"Cheddar\", \"Bacon\"],\n \"complements\": []\n }\n ],\n \"total\": {\n \"subTotal\": 51.00,\n \"deliveryFee\": 5.00,\n \"discount\": 5.00,\n \"addition\": 2.50,\n \"orderAmount\": 53.50\n }\n}\n\nAtualiza o status de um pedido.
\nObs: Envie trackingUrl apenas quando o status == 4 (Saiu p/ entrega);
\n{\n \"success\": true,\n \"message\": \"Order status updated successfully\"\n}\n\nEndpoints responsáveis pelo gerenciamento de pedidos do sistema Alfa Labs, incluindo busca, criação e atualização de status.
\n","_postman_id":"8925a20a-4935-4198-96ac-ec401fa0b67a"},{"name":"Users","item":[{"name":"GET /users","id":"f896cae3-3436-44ff-8e86-3a26a2e9a413","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"url":"https://api.alfalabs.com.br/v2/users","description":"Busca usuários com filtros opcionais.
\n{\n \"success\": true,\n \"data\": [\n {\n \"id\": 100,\n \"name\": \"João Silva\",\n \"email\": \"joao@email.com\",\n \"phone\": \"(47) 99987-0488\",\n \"document\": \"123.456.789-00\"\n }\n ]\n}\nEndpoints para consulta e gerenciamento de usuários registrados no sistema Alfa Labs.
\n","_postman_id":"544f81a4-6068-496e-b42a-defa94b7d03c"},{"name":"Delivery","item":[{"name":"GET /deliveryAreas","id":"4b6c79e2-3455-41fb-8485-b275744a3142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer token","type":"text"}],"url":"https://api.alfalabs.com.br/v2/deliveryAreas","description":"Lista as áreas de entrega disponíveis para a filial autenticada.
\n{\n \"success\": true,\n \"data\": [\n { \"type\": \"correios\", \"areas\": [...] }\n ]\n}\nEndpoints relacionados às áreas de entrega das filiais cadastradas no sistema Alfa Labs.
\n","_postman_id":"81482f82-8a60-495c-b5f1-30cd3f43caef"},{"name":"Nfc","item":[{"name":"GET /nfc","id":"30c618a1-7ab1-4bf2-ac8d-b8c50768f1f1","protocolProfileBehavior":{"disableBodyPruning":false,"followRedirects":true,"disableUrlEncoding":false,"disableCookies":false},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"token"}]},"isInherited":false},"method":"GET","header":[{"key":"Authorization","value":"Bearer token"}],"url":"https://api.alfalabs.com.br/v2/nfc/:order_id","description":"Consulta uma NFCe
\nGET /v2/nfc/{order_id}
{\n \"success\": true,\n \"data\": {\n \"emission_date\": \"2025-10-22 14:45:27\",\n \"status\": \"autorizado\",\n \"number\": \"000123457\",\n \"link_danfe\": \"https://api.focusnfe.com.br/v2/nfce/98765432109876543210987654321098765432109876?danfe\",\n \"link_xml\": \"https://api.focusnfe.com.br/v2/nfce/98765432109876543210987654321098765432109876.xml\",\n \"cancellation_reason\": null\n }\n}\n\nEmite uma NFCe
\nPOST /v2/nfc/{order_id}
{\n \"success\": true,\n \"data\": {\n \"emission_date\": \"2025-10-22 14:45:27\",\n \"status\": \"autorizado\",\n \"number\": \"000123457\",\n \"link_danfe\": \"https://api.focusnfe.com.br/v2/nfce/98765432109876543210987654321098765432109876?danfe\",\n \"link_xml\": \"https://api.focusnfe.com.br/v2/nfce/98765432109876543210987654321098765432109876.xml\",\n \"cancellation_reason\": null\n }\n}\n\nConsulta as avaliações dos pedidos
\nGET /v2/ratings
{\n \"success\": true,\n \"page\": 1,\n \"totalPages\": 1,\n \"data\": [\n {\n \"order_id\": \"3217492\",\n \"emission_date\": \"2025-07-21 16:09:53\",\n \"rating\": \"5\",\n \"comment\": null,\n \"user_id\": \"2\",\n \"user_name\": \"Juarez Rocha\",\n \"filial_id\": \"1\"\n },\n {\n \"order_id\": \"3217491\",\n \"emission_date\": \"2025-07-21 16:09:53\",\n \"rating\": \"3\",\n \"comment\": null,\n \"user_id\": \"2\",\n \"user_name\": \"Juarez Rocha\",\n \"filial_id\": \"1\"\n }\n}\n\nConsulta as contas de uma filial
\nGET /v2/accounts
Parâmetro de status:
C = cancelado
A = em aberto
P = pagas
Parâmetro de date_type:
V = vencimento
L = liquidação
E = emissão
Parâmetro de operation:
R = receber
P = pagar
{\n \"success\": true,\n \"page\": 1,\n \"totalPages\": 1,\n \"data\": [\n {\n \"order_id\": \"3217492\",\n \"emission_date\": \"2025-07-21 16:09:53\",\n \"rating\": \"5\",\n \"comment\": null,\n \"user_id\": \"2\",\n \"user_name\": \"Juarez Rocha\",\n \"filial_id\": \"1\"\n },\n {\n \"order_id\": \"3217491\",\n \"emission_date\": \"2025-07-21 16:09:53\",\n \"rating\": \"3\",\n \"comment\": null,\n \"user_id\": \"2\",\n \"user_name\": \"Juarez Rocha\",\n \"filial_id\": \"1\"\n }\n}\n\nLista os cupons de desconto
\nGET /v2/discountCoupons
{\n \"coupons\": [\n {\n \"id\": 2110,\n \"code\": \"ASDASD\",\n \"active\": false,\n \"description\": \"asdasd\",\n \"discount_type\": \"%\",\n \"discount_value\": 20,\n \"valid_above\": 0,\n \"first_order_only\": false,\n \"uses_per_customer\": 99,\n \"start_date\": \"2022-11-11\",\n \"end_date\": \"2022-11-12\",\n \"delivery_discount\": false,\n \"free_delivery\": false,\n \"filial_id\": 608,\n \"block_promotion\": true,\n \"visible\": true,\n \"auto_apply\": false,\n \"restrictions\": {\n \"delivery_type\": \"todos\",\n \"week_days\": [\n true,\n true,\n true,\n true,\n true,\n true,\n true\n ],\n \"menu\": [\n {\n \"id\": \"424\",\n \"name\": \"X-Burguer\",\n \"type\": \"produto\"\n }\n ],\n \"neighborhoods\": [\n {\n \"id\": 1,\n \"name\": \"Bombas\"\n }\n ],\n \"customers\": [\n {\n \"id\": \"1\",\n \"name\": \"Bruno Delfim\"\n }\n ]\n }\n }\n ]\n}\n\nCria um novo cupom de desconto
\nPOST /v2/discountCoupons
Parâmetro de discount_type:
R$ = desconto fixo em reais
% = desconto percentual
Parâmetro de delivery_type (dentro de restrictions):
delivery = apenas delivery
balcao = apenas balcão
todos = todos os tipos de entrega
Parâmetro de type (dentro de restrictions.menu):
categoria = categoria do cardápio
promoção = promoção
pizza = pizza
produto = produto individual
Parâmetro de week_days:
Array de 7 valores booleanos representando os dias da semana (Domingo a Sábado)
{\n \"code\": \"TESTE_API_V2\",\n \"description\": \"Cupom de teste via API v2\",\n \"discount_type\": \"R$\",\n \"discount_value\": 9.99,\n \"valid_above\": 11.54,\n \"first_order_only\": true,\n \"uses_per_customer\": 10,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"delivery_discount\": false,\n \"free_delivery\": false,\n \"filial_id\": 1,\n \"block_promotion\": true,\n \"visible\": true,\n \"auto_apply\": true,\n \"restrictions\": {\n \"delivery_type\": \"delivery\",\n \"week_days\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"menu\": [\n {\n \"id\": \"38\",\n \"name\": \"Categoria Bebidas\",\n \"type\": \"categoria\"\n },\n {\n \"id\": \"107\",\n \"name\": \"Monte seu Lanche\",\n \"type\": \"promoção\"\n }\n ],\n \"neighborhoods\": [\n {\n \"id\": 1,\n \"name\": \"Bombas\"\n }\n ],\n \"customers\": [\n {\n \"id\": 1,\n \"name\": \"Bruno Delfim\"\n }\n ]\n }\n}###ExemplodeResposta(200/201){\n \"id\": 2110,\n \"code\": \"TESTE_API_V2\",\n \"active\": false,\n \"description\": \"Cupom de teste via API v2\",\n \"discount_type\": \"R$\",\n \"discount_value\": 9.99,\n \"valid_above\": 11.54,\n \"first_order_only\": true,\n \"uses_per_customer\": 10,\n \"start_date\": \"2024-01-01\",\n \"end_date\": \"2024-12-31\",\n \"delivery_discount\": false,\n \"free_delivery\": false,\n \"filial_id\": 1,\n \"block_promotion\": true,\n \"visible\": true,\n \"auto_apply\": true,\n \"restrictions\": {\n \"delivery_type\": \"delivery\",\n \"week_days\": [\n false,\n true,\n true,\n true,\n true,\n true,\n false\n ],\n \"menu\": [\n {\n \"id\": \"38\",\n \"name\": \"Categoria Bebidas\",\n \"type\": \"categoria\"\n }\n ],\n \"neighborhoods\": [\n {\n \"id\": 1,\n \"name\": \"Bombas\"\n }\n ],\n \"customers\": [\n {\n \"id\": 1,\n \"name\": \"Bruno Delfim\"\n }\n ]\n }\n}\n\nPUT /v2/discountCoupons/:id
Parâmetro de discount_type:
R$ = desconto fixo em reais
% = desconto percentual
Parâmetro de delivery_type (dentro de restrictions):
delivery = apenas delivery
balcao = apenas balcão
todos = todos os tipos de entrega
Parâmetro de type (dentro de restrictions.menu):
categoria = categoria do cardápio
promoção = promoção
pizza = pizza
produto = produto individual
Parâmetro de week_days:
Array de 7 valores booleanos representando os dias da semana (Domingo a Sábado)
{\n \"code\": \"TESTE_API_V2_UPDATED\",\n \"description\": \"Cupom atualizado via API v2\",\n \"discount_type\": \"%\",\n \"discount_value\": 15.0,\n \"valid_above\": 20.00,\n \"first_order_only\": false,\n \"uses_per_customer\": 5,\n \"start_date\": \"2024-02-01\",\n \"end_date\": \"2024-11-30\",\n \"delivery_discount\": true,\n \"free_delivery\": false,\n \"filial_id\": 1,\n \"block_promotion\": false,\n \"visible\": true,\n \"auto_apply\": false,\n \"restrictions\": {\n \"delivery_type\": \"todos\",\n \"week_days\": [\n true,\n true,\n true,\n true,\n true,\n false,\n false\n ],\n \"menu\": [\n {\n \"id\": \"50\",\n \"name\": \"Categoria Pizzas\",\n \"type\": \"categoria\"\n }\n ],\n \"neighborhoods\": [\n {\n \"id\": 1,\n \"name\": \"Bombas\"\n }\n ],\n \"customers\": null\n }\n}###ExemplodeResposta(200){\n \"id\": 2110,\n \"code\": \"TESTE_API_V2_UPDATED\",\n \"active\": false,\n \"description\": \"Cupom atualizado via API v2\",\n \"discount_type\": \"%\",\n \"discount_value\": 15.0,\n \"valid_above\": 20.00,\n \"first_order_only\": false,\n \"uses_per_customer\": 5,\n \"start_date\": \"2024-02-01\",\n \"end_date\": \"2024-11-30\",\n \"delivery_discount\": true,\n \"free_delivery\": false,\n \"filial_id\": 1,\n \"block_promotion\": false,\n \"visible\": true,\n \"auto_apply\": false,\n \"restrictions\": {\n \"delivery_type\": \"todos\",\n \"week_days\": [\n true,\n true,\n true,\n true,\n true,\n false,\n false\n ],\n \"menu\": [\n {\n \"id\": \"50\",\n \"name\": \"Categoria Pizzas\",\n \"type\": \"categoria\"\n }\n ],\n \"neighborhoods\": [\n {\n \"id\": 1,\n \"name\": \"Bombas\"\n }\n ],\n \"customers\": null\n }\n}\n\nDELETE /v2/discountCoupons/:id
{\n \"success\": true\n}\n\nOs webhooks permitem que você receba notificações em tempo real sobre eventos que ocorrem no sistema.
\nEntre nas configurações da loja e cadastre o endpoint para onde o webhook será enviado.
\nDisparado quando um novo pedido é criado no sistema.
\nEvent: order.created
\n{\n \"event\": \"order.created\",\n \"timestamp\": \"2025-10-22T14:32:18Z\",\n \"data\": {\n \"order_id\": \"12345678\",\n \"external_code\": \"external_code\",\n \"merchant_id\": \"1\",\n \"status\": \"Realizado\",\n \"created_at\": \"2025-10-22 11:32:18\"\n }\n}\n\nDisparado quando um pedido é editado no sistema.
\nEvent: order.updated
\n{\n \"event\": \"order.updated\",\n \"timestamp\": \"2025-10-22T14:32:18Z\",\n \"data\": {\n \"order_id\": \"12345678\",\n \"merchant_id\": \"1\"\n }\n}\n\nDisparado quando o status de um pedido é alterado.
\nEvent: order.updated_status
\n{\n \"event\": \"order.updated_status\",\n \"timestamp\": \"2025-10-22T14:45:30Z\",\n \"data\": {\n \"order_id\": \"12345678\",\n \"merchant_id\": \"1\",\n \"status\": \"Em preparação\"\n }\n}\n\nDisparado quando um cliente avalia um pedido.
\nEvent: order.reviewed
\n{\n \"event\": \"order.reviewed\",\n \"timestamp\": \"2025-10-22T15:20:45Z\",\n \"data\": {\n \"order_id\": \"12345678\",\n \"rating\": \"5\",\n \"comment\": \"Excelente atendimento! Comida deliciosa.\",\n \"reviewed_at\": \"2025-10-22 12:20:45\"\n }\n}\n\nUse HTTPS: Sempre configure URLs HTTPS para receber webhooks
\nResponda rapidamente: Retorne status 200 em até 30 segundos
\nSe sua URL não responder ou retornar erro, o webhook irá fazer 5 tentativas automáticas a cada 30 segundos.
\n","_postman_id":"2c7b3aff-e52e-4720-b04f-4b845f176b07"}],"event":[{"listen":"prerequest","script":{"id":"62bd6a21-528f-4330-8d73-abafdb363809","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"9b7fa3f3-5afb-4a08-a053-0ee31528db73","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"variable":[{"key":"base_url","value":"https://api.alfalabs.com.br"},{"key":"token","value":"token"}]}