Introdução
Para simplificar a integração com apps de terceiros, o Sischef disponibiliza uma forma de enviar/atualizar pedidos para o nosso PDV online.
Caso ainda não conheça o PDV online Sischef, acesse:
- https://sischef.com/sistema-para-delivery/
- https://www.youtube.com/watch?v=g-jSIQYzJEg
- https://www.youtube.com/watch?v=W09b6XR7lV8
Funcionamento da integração
Para o envio dos dados do pedido para o Sischef, alguns requisitos precisam ser cumpridos.
Passo 01:
Solicitar o Token (token-integracao
) para a equipe de suporte do Sischef. A solicitação pode ser realizada através do e-mail suporte@parseint.com.br. Não esqueça de informar os dados como Nome e CNPJ da empresa.
PASSO 02:
Já com o TOKEN
em mão, o próximo passo será enviar o pedido em formato JSON (ver exemplo aqui) para a seguinte Método e URL:
Method | POST |
URL | https://sistema.sischef.com/api-v2/webhook/integracao/OT |
Ah, e lembre-se de adicionar o token no Header da requisição, da seguinte forma:
token-integracao |
<token_recebido_no_passo_01> |
Observação 01:
O campo “id
” no JSON do pedido deverá ser único. É possível enviar o mesmo pedido mais de uma vez. Neste caso, o Sischef irá atualizar os dados do pedido com o novo JSON informado.
Sugestão: Faça o envio do pedido para o Sischef após a confirmação pelo restaurante.
Observação 02:
Lista com as situações possíveis para o pedido
Situações | Descrição |
PENDENTE |
Pedido ainda não confirmado pelo restaurante |
CONFIRMADO |
Pedido confirmado pelo restaurante |
ENVIADO |
Pedido enviado para o cliente |
ENTREGUE |
Pedido entregue (processo finalizado) |
CANCELADO |
Pedido cancelado |
Observação 03:
Para que o Sischef consiga associar tanto o ITEM PRINCIPAL quanto o SUB ITEM ao produto correto (visando a baixa correta no estoque) – deverá ser utilizado o campo "codigoExterno"
para tal. Veja o exemplo abaixo
PASSO 03:
Verificar o código de retorno do Sischef:
Código 200 | Pedido recebido e processado com sucesso. |
Código 404 (not found) | Falha ao processar pedido. Verificar texto de retorno com motivo principal do problema. |
Consulta de pedidos por ID (depreciado – utilize a consulta por ‘idUnicoIntegracao’)
Caso seja necessário, também existe um endpoint específico para a consulta de pedidos utilizando o ID do pedido salvo (esse ID deve ser o mesmo utilizado para a inclusão). Para fazer isso, basta utilizar a seguinte URL:
Method | GET |
URL | https://sistema.sischef.com/api-v2/webhook/integracao/OT/detalharPedido/<ID> |
Exemplo: | https://sistema.sischef.com/api-v2/webhook/integracao/OT/detalharPedido/123456 |
Ex. retorno: | EXEMPLO RETORNO POR ID |
Lembre-se de adicionar o token no Header da requisição, da seguinte forma:
token-integracao |
<token_recebido_no_passo_01> |
Consulta de pedidos por Identificador principal
Primeiro, precisamos definir o que seria o “Identificador principal”:
O “Identificador principal” pode ser tanto o número da mesa quanto o número da comanda (dependendo da configuração da empresa dentro do Sistema Sischef). Ou seja, todas as empresas no Sischef precisam definir qual será o “Identificador principal” – COMANDA ou MESA.
Existe um endpoint específico para a consulta de pedidos utilizando o número da comanda (ou mesa) – chamado pelo Sischef como “Identificador principal”. Para fazer isso, basta utilizar a seguinte URL:
Method | GET |
URL | https://sistema.sischef.com/api-v2/webhook/integracao/OT/pedidosPorIdentificadorPrincipal/<IDENTIFICADO R PRINCIPAL> |
Exemplo: | https://sistema.sischef.com/api-v2/webhook/integracao/OT/pedidosPorIdentificadorPrincipal/10 |
Ex. retorno: | EXEMPLO RETORNO |
Lembre-se de adicionar o token no Header da requisição, da seguinte forma:
token-integracao |
<token_recebido_no_passo_01> |
Consulta de pedidos por ‘idUnicoIntegracao’
Primeiro, precisamos definir o que seria o “idUnicoIntegracao“:
O “idUnicoIntegracao” é um código único gerado pelo sistema Sischef. Ou seja, independente de quem gerou o pedido (Sischef ou uma plataforma de terceiros), esse código será um identificador único do pedido.
Para identificar o ‘idUnicoIntegracao’ no Sischef, basta detalhar o pedido. Veja a imagem abaixo:
Esse endpoint irá retornar sempre 1 pedido (ou o código de erro NOT FOUND – 404 caso não encontrado). Veja como acessar:
Method | GET |
URL | https://sistema.sischef.com/api-v2/webhook/integracao/OT/idUnicoIntegracao/<idUnicoIntegracao> |
Exemplo: | https://sistema.sischef.com/api-v2/webhook/integracao/OT/idUnicoIntegracao/123456 |
Ex. retorno: | EXEMPLO RETORNO |
Lembre-se de adicionar o token no Header da requisição, da seguinte forma:
token-integracao |
<token_recebido_no_passo_01> |
Criar ou editar um novo pedido
É possível criar ou editar um pedido através dos nossos endpoints. O campo “idUnicoIntegracao” será utilizado para verificar se o pedido já existe (e será editado) ou se um novo pedido será criado.
Campos principais
id | código único por pedido (opcional) – pode utilizar o mesmo valor do códigoUnicoIntegracao |
codigoUnicoIntegracao | código único por pedido |
identificador.numero | Número da comanda/mesa |
identificador.tipo | Tipo COMANDA ou MESA |
identificadorSecundario | Caso o tipo seja COMANDA é possível incluir um identificador secundário (como exemplo o número da mesa) |
itens.codigoExterno | Código SKU do produto dentro do Sischef |
tipoPedido | COMANDA ou DELIVERY |
Descrição do endpoint:
METHOD | POST |
URL | https://sistema.sischef.com//api-v2/webhook/integracao/OT |
Body content (exemplo): | { “id”: “codigoUnico01”, “idUnicoIntegracao”: “codigoUnico01”, “dataPedido”: “2023-02-06T10:50:47.964”, “createdAt”: “2023-02-06T10:50:47.964”, “descricao”: “Descricao do pedido”, “tipoPedido”: “COMANDA”, “situacao”: “CONFIRMADO”, “identificador”: { “numero”: “15”, “tipo”: “COMANDA” }, “identificadorSecundario”: “3”, “itens”: [ { “nome”:”TAXA DE SERVIÇO”, “id”:”48774371-43af-45b2-82e9-3afb76964286″, “quantidade”:1.0, “valorDesconto”:0.0, “valorUnitario”:0.0, “valorTotal”:0.0, “subItens”:[], “codigoExterno”:”1970713″ } ], “troco”: 0, “valorDesconto”: 0, “valorTotal”: 0 } |
Ex. retorno: |
{ “message”: “Pedido integracao criado com sucesso #7635709 – pedidoId no APP codigoUnico01” } |
Lembre-se de adicionar o token no Header da requisição, da seguinte forma:
token-integracao |
|
Realizar pagamento de um pedido
É possível realizar pagamentos parciais ou totais de pedidos. Para isso, foi criado o endpoint específico, onde deverá ser informado o “idUnicoIntegracao” e o seu respectivo pagamento. Veja o exemplo abaixo:
Campos principais
idUnicoIntegracao |
Código único do pedido dentro do Sischef |
codigoExterno |
ID da forma de pagamento dentro do Sischef. Será preciso verificar quais as formas de pagamento disponível na base do cliente. |
Descrição do endpoint:
Method | POST |
URL | https://sistema.sischef.com//api-v2/webhook/integracao/OT?acao=pagamento |
Exemplo: | https://sistema.sischef.com//api-v2/webhook/integracao/OT?acao=pagamento |
Body content: | { |
Ex. retorno: | EXEMPLO RETORNO |
Lembre-se de adicionar o token no Header da requisição, da seguinte forma:
token-integracao |
<token_recebido_no_passo_01> |
Conclusão
Para facilitar o desenvolvimento, disponibilizamos um link com alguns arquivos úteis – como os exemplos dos principais endpoint utilizando o Insomnia e alguns JSONs. Para acessar basta clicar aqui.
Em caso de dúvida, entre em contato pelo suporte@parseint.com.br – Teremos prazer em ajudar!