A API de integração de pedidos permite o acesso aos pedidos realizados pela plataforma de Cardápio Digital Na Loja e alteração dos status dos pedidos para notificação dos clientes responsáveis pelos pedidos feitos.
\nTodas as respostas são feitas no formato JSON.
\nA Autenticação das requisições é feita utilizando um token no Header gerado pelo painel do parceiro na plataforma (veja como fazer).
\n\n\n400 - Erro nas informações enviadas
\n
429 - Limite de requisições excedido
401 - Autenticação falhou
Lista os pedidos que estão pendentes na loja.
\nEstrutura:
\nLista os QrCodes da loja.
\nLista os pedidos de um QrCode específico.
\nEstrutura:
\nLista os meios de pagamento existentes na plataforma
\n","urlObject":{"protocol":"https","path":["api","cardapiodigital","getlistpaymentsmethods"],"host":["api","{{host}}"],"query":[],"variable":[]}},"response":[{"id":"1653b151-21a8-43e8-be4d-14afb8074754","name":"Get list of payments methods","originalRequest":{"method":"GET","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":"https://api.{{host}}/api/cardapiodigital/getlistpaymentsmethods"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 18 Jun 2021 14:11:06 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.2.29"},{"key":"X-Powered-By","value":"PHP/7.2.29"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"52"},{"key":"Content-Length","value":"3644"},{"key":"Keep-Alive","value":"timeout=5, max=98"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"formas\": [\n {\n \"id\": 1,\n \"nome\": \"Vale - Sodexo (Cartão)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 2,\n \"nome\": \"Vale - VR Smart (Cartão)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 3,\n \"nome\": \"Visa Refeição\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 4,\n \"nome\": \"Crédito - Mastercard\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 5,\n \"nome\": \"Crédito - Elo\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 6,\n \"nome\": \"Dinheiro\",\n \"categoria\": \"Outros\",\n \"tag\": null\n },\n {\n \"id\": 7,\n \"nome\": \"Cheque\",\n \"categoria\": \"Outros\",\n \"tag\": null\n },\n {\n \"id\": 8,\n \"nome\": \"Vale - Verocard (Cartão)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 9,\n \"nome\": \"Nutricard Refeicão E Alimentação\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 10,\n \"nome\": \"Vale - Alelo Refeição / Visa Vale (Cartão)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 11,\n \"nome\": \"Vale - Refeisul (Cartão)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 12,\n \"nome\": \"Vale - Green Card (Papel)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 13,\n \"nome\": \"Vale - Green Card (Cartão)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 14,\n \"nome\": \"Vale - Ticket Restaurante (Cartão)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 15,\n \"nome\": \"Vale - Vale Card\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 16,\n \"nome\": \"Ben Visa Refeição\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 17,\n \"nome\": \"Vale - Cooper Card (Cartão)\",\n \"categoria\": \"Vale-refeição\",\n \"tag\": null\n },\n {\n \"id\": 18,\n \"nome\": \"Crédito - Diners\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 19,\n \"nome\": \"Crédito - Goodcard\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 20,\n \"nome\": \"Débito - Elo\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 21,\n \"nome\": \"Crédito - Visa\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 22,\n \"nome\": \"Crédito - Hipercard\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 23,\n \"nome\": \"Crédito - Banricompras\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 24,\n \"nome\": \"Débito - Visa\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 25,\n \"nome\": \"Crédito - American Express\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 26,\n \"nome\": \"Crédito - Nugo\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 27,\n \"nome\": \"Crédito - Verdecard\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 28,\n \"nome\": \"Débito - Mastercard\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 29,\n \"nome\": \"PicPay\",\n \"categoria\": \"Outros\",\n \"tag\": \"link-whatsapp\"\n },\n {\n \"id\": 30,\n \"nome\": \"Cartão de crédito Online\",\n \"categoria\": \"Outros\",\n \"tag\": \"link-whatsapp\"\n },\n {\n \"id\": 31,\n \"nome\": \"Cartão de débito Online\",\n \"categoria\": \"Outros\",\n \"tag\": \"link-whatsapp\"\n },\n {\n \"id\": 32,\n \"nome\": \"Débito - Banricompras\",\n \"categoria\": \"Cartões de crédito e débito\",\n \"tag\": null\n },\n {\n \"id\": 33,\n \"nome\": \"AME\",\n \"categoria\": \"Outros\",\n \"tag\": \"link-whatsapp\"\n },\n {\n \"id\": 35,\n \"nome\": \"Pix\",\n \"categoria\": \"Outros\",\n \"tag\": \"link-whatsapp\"\n },\n {\n \"id\": 36,\n \"nome\": \"Transferência bancária\",\n \"categoria\": \"Outros\",\n \"tag\": \"link-whatsapp\"\n },\n {\n \"id\": 37,\n \"nome\": \"Papayas\",\n \"categoria\": \"Outros\",\n \"tag\": \"link-whatsapp\"\n },\n {\n \"id\": 38,\n \"nome\": \"WhatsApp Pay\",\n \"categoria\": \"Outros\",\n \"tag\": \"link-whatsapp\"\n }\n ]\n}"}],"_postman_id":"a9f7f1a7-06d8-46b7-9b89-10a0fa0cf635"},{"name":"Get Notifications","id":"749663e2-1488-4f5a-9ef6-5e01b161cb2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":"https://api.{{host}}/api/cardapiodigital/getNotifications","description":"Lista notificações em aberto.
\nAltera o status do pedido para o próximo status disponível, notificando o cliente que realizou o pedido e atualiza ele como integrado, removendo-o da lista de pedidos pendentes para integração.
\nQuando um pedido é feito, ele possui o status inicial de Pendente, ou seja, aguardando confirmação do restaurante.
\nO próximo status em um fluxo normal do pedido é Em produção, no qual notifica o cliente através do aplicativo que o pedido dele foi confirmado e está sendo preparado.
\nDepois do status confirmado, o próximo pedido é Pronto que indica para o cliente se o pedido dele já saiu para entrega ou está pronto para coleta em caso de pedidos de retirada em loja.
\nO último status de pedido é Finalizado, que indica que o pedido foi entregue na mesa.
\nDispensa notificação informada.
\n","urlObject":{"protocol":"https","path":["api","cardapiodigital","dismissNotification"],"host":["api","{{host}}"],"query":[{"key":"cod_notification","value":"{{Codigo da notificacao}}"}],"variable":[]}},"response":[{"id":"7144e1c3-5284-4b30-9c8f-89c8dfebbfde","name":"Dismiss Notification","originalRequest":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":{"raw":"https://api.{{host}}/api/cardapiodigital/dismissNotification?cod_notification={{Codigo da notificacao}}","protocol":"https","host":["api","{{host}}"],"path":["api","cardapiodigital","dismissNotification"],"query":[{"key":"cod_notification","value":"{{Codigo da notificacao}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 24 Aug 2021 11:10:08 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.2.29"},{"key":"X-Powered-By","value":"PHP/7.2.29"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"30"},{"key":"X-RateLimit-Remaining","value":"29"},{"key":"Content-Length","value":"33"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\"\n}"}],"_postman_id":"fce53df3-51e6-4f41-bfa9-6371be9cebfb"},{"name":"Cancel Order","id":"75990adf-f21c-4d05-96ce-50172a950ff5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":"https://api.{{host}}/api/cardapiodigital/cancelaPedido?pedido_ref={{Referência do pedido}}","description":"Cancela o pedido, notificando o cliente que realizou o pedido.
\n","urlObject":{"protocol":"https","path":["api","cardapiodigital","cancelaPedido"],"host":["api","{{host}}"],"query":[{"key":"pedido_ref","value":"{{Referência do pedido}}"}],"variable":[]}},"response":[{"id":"77085d6e-4702-4e86-8314-c71bacb8e758","name":"Cancel Order","originalRequest":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":{"raw":"https://api.{{host}}/api/cardapiodigital/cancelaPedido?pedido_ref={{Referência do pedido}}","protocol":"https","host":["api","{{host}}"],"path":["api","cardapiodigital","cancelaPedido"],"query":[{"key":"pedido_ref","value":"{{Referência do pedido}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 10 Jul 2021 18:05:59 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.2.29"},{"key":"X-Powered-By","value":"PHP/7.2.29"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"58"},{"key":"Content-Length","value":"51"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"status_pedido\": 0\n}"}],"_postman_id":"75990adf-f21c-4d05-96ce-50172a950ff5"},{"name":"Transfer Orders","id":"e1aad2af-0c17-4fb2-9b56-a0d024927c1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":"https://api.{{host}}/api/cardapiodigital/transferirPedidos?cod_pdv_origem={{cod_pdv_origem}}&cod_pdv_destino={{cod_pdv_destino}}","urlObject":{"protocol":"https","path":["api","cardapiodigital","transferirPedidos"],"host":["api","{{host}}"],"query":[{"key":"cod_pdv_origem","value":"{{cod_pdv_origem}}"},{"key":"cod_pdv_destino","value":"{{cod_pdv_destino}}"}],"variable":[]}},"response":[{"id":"a79f39e6-84db-44a5-a9f8-28e247291bcd","name":"Transfer Orders","originalRequest":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":{"raw":"https://api.{{host}}/api/cardapiodigital/transferirPedidos?cod_pdv_origem={{cod_pdv_origem}}&cod_pdv_destino={{cod_pdv_destino}}","protocol":"https","host":["api","{{host}}"],"path":["api","cardapiodigital","transferirPedidos"],"query":[{"key":"cod_pdv_origem","value":"{{cod_pdv_origem}}"},{"key":"cod_pdv_destino","value":"{{cod_pdv_destino}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 02 Jun 2023 12:46:43 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.2.29"},{"key":"X-Powered-By","value":"PHP/7.2.29"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"360"},{"key":"X-RateLimit-Remaining","value":"359"},{"key":"Content-Length","value":"84"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"notification\": \"Pedidos transferidos com sucesso.\"\n}"}],"_postman_id":"e1aad2af-0c17-4fb2-9b56-a0d024927c1c"},{"name":"Close QrCode","id":"c77f4a0b-e7b4-4353-95d0-321db0ff577c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":"https://api.{{host}}/api/cardapiodigital/fechaMesa?codPdv={{Referência do QrCode}}&forma={{Forma de pagamento}}","description":"Fecha Mesa/Balcão/Comanda
\n","urlObject":{"protocol":"https","path":["api","cardapiodigital","fechaMesa"],"host":["api","{{host}}"],"query":[{"key":"codPdv","value":"{{Referência do QrCode}}"},{"key":"forma","value":"{{Forma de pagamento}}"}],"variable":[]}},"response":[{"id":"cfcbea37-f938-401f-b8e7-c42fba8b5b80","name":"Close QrCode","originalRequest":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":{"raw":"https://api.{{host}}/api/cardapiodigital/fechaMesa?codPdv={{Referência do QrCode}}&forma={{Forma de pagamento}}","protocol":"https","host":["api","{{host}}"],"path":["api","cardapiodigital","fechaMesa"],"query":[{"key":"codPdv","value":"{{Referência do QrCode}}"},{"key":"forma","value":"{{Forma de pagamento}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 10 Jul 2021 17:23:58 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.2.29"},{"key":"X-Powered-By","value":"PHP/7.2.29"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"56"},{"key":"Content-Length","value":"78"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"notification\": \"Mesa encerrada com sucesso.\"\n}"}],"_postman_id":"c77f4a0b-e7b4-4353-95d0-321db0ff577c"},{"name":"Create QrCode","id":"3b33cbb0-13bb-4207-bb3d-d92dff1dfa0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":"https://api.{{host}}/api/cardapiodigital/createQrCode?tipo={{qrcode_tipo}}&nome={{nome_qrcode}}&codigo_pdv={{cod_pdv}}","description":"Cria novo QrCode
\n1 - Mesa
\n2 - Balcão
\n3 - Garçom
\n6 - Comanda
\nExclui QrCode
\n","urlObject":{"protocol":"https","path":["api","cardapiodigital","deleteQrCode"],"host":["api","{{host}}"],"query":[{"key":"codigo_pdv","value":"{{cod_pdv}}"}],"variable":[]}},"response":[{"id":"c4f84b0b-f109-4452-ad57-d8f3602850e0","name":"Delete QrCode","originalRequest":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}","type":"text"}],"url":{"raw":"https://api.{{host}}/api/cardapiodigital/deleteQrCode?codigo_pdv={{cod_pdv}}","protocol":"https","host":["api","{{host}}"],"path":["api","cardapiodigital","deleteQrCode"],"query":[{"key":"codigo_pdv","value":"{{cod_pdv}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 25 Oct 2021 20:49:16 GMT"},{"key":"Server","value":"Apache/2.4.41 (Win64) OpenSSL/1.1.1c PHP/7.2.29"},{"key":"X-Powered-By","value":"PHP/7.2.29"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"X-RateLimit-Limit","value":"30"},{"key":"X-RateLimit-Remaining","value":"27"},{"key":"Content-Length","value":"74"},{"key":"Keep-Alive","value":"timeout=5, max=98"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"code\": \"200\",\n \"message\": \"QrCode excluido com sucesso.\"\n}"}],"_postman_id":"f35a9d7c-b539-47c5-ab80-d88bbb92670a"},{"name":"Release Command","id":"b055663d-f1c2-4d85-84e5-877c1ed4410a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}"}],"url":"https://api.{{host}}/api/cardapiodigital/liberaComanda?codPdv={{Referência do QrCode}}","description":"Desconecta todo e qualquer dispositivo conectado na comanda.
\n","urlObject":{"protocol":"https","path":["api","cardapiodigital","liberaComanda"],"host":["api","{{host}}"],"query":[{"key":"codPdv","value":"{{Referência do QrCode}}"}],"variable":[]}},"response":[],"_postman_id":"b055663d-f1c2-4d85-84e5-877c1ed4410a"},{"name":"Block Qrcode","id":"bb6ea84f-6908-4af7-874a-13460927bb3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}"}],"url":"https://api.{{host}}/api/cardapiodigital/bloqueiaQrcode?codPdv={{Referência do QrCode}}","description":"Bloqueia Qrcode, com o bloqueio não é possível fazer mais nenhum tipo de pedido por parte do cliente final.
\n","urlObject":{"protocol":"https","path":["api","cardapiodigital","bloqueiaQrcode"],"host":["api","{{host}}"],"query":[{"key":"codPdv","value":"{{Referência do QrCode}}"}],"variable":[]}},"response":[],"_postman_id":"bb6ea84f-6908-4af7-874a-13460927bb3a"},{"name":"Unlock Qrcode","id":"78ddec44-58fc-4b27-abb0-e81df8d1f5d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Bearer","value":"{{Token da loja}}"}],"url":"https://api.{{host}}/api/cardapiodigital/desbloqueiaQrcode?codPdv={{Referência do QrCode}}","description":"Desbloqueia Qrcode, assim o cliente final pode voltar a realizar pedidos.
\n","urlObject":{"protocol":"https","path":["api","cardapiodigital","desbloqueiaQrcode"],"host":["api","{{host}}"],"query":[{"key":"codPdv","value":"{{Referência do QrCode}}"}],"variable":[]}},"response":[],"_postman_id":"78ddec44-58fc-4b27-abb0-e81df8d1f5d5"}]}