Integração carrinho inteligente utilizando APIs do PDV

CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Tabelas utilizadas
4. Tecnologias Homologadas

01. VISÃO GERAL

Esta documentação tem como objetivo explicar quais são os parâmetros necessários e qual o funcionamento da utilização dos eventos da API do PDV para a inclusão de produtos em uma venda, realizando a integração com um carrinho inteligente.

02. EXEMPLO DE UTILIZAÇÃO

Caminho

Acrux PDV e Acrux Monitor.

Pré-Requisitos e Restrições

Necessário realizar as seguinte configurações:

Acrux Monitor > Configurações > Configurações de PDVs > Gerais > Modo de operação > Neste exemplo utilizaremos "Self-Checkout":

Imagem 1 - Modo de operação

Se o modo for o "Self-Checkout pagamento", é necessário conferir se o parâmetro da balança está desativado (neste modo não se utiliza balança):

Acrux Monitor > Configurações > Configurações de PDVs > Self-Checkout > Balança de conferência > Ativo > Configurar como "Não":

Imagem 2 - Balança de conferência

Se o modo for o "Self-Checkout pagamento", é necessário habilitar o botão de início para esta operação, de acordo com a documentação Configurar Interface. O parâmetro fica no caminho abaixo:

Acrux Monitor > Configurações > Configurações de PDVs > Self-Checkout > Interface > Tela inicial > Botão iniciar > "Ativo no self pagamento" > colocar "Sim".

Necessário configurar os parâmetros da função "Receber Operações":

Acrux Monitor > Configurações > Configurações de PDVs > Integrações externas > "Receber operações" > Configurar "Ativo" como "Sim" e parametrizar as outras configurações:

Obs.: campo "Código do parceiro" preencher com o código do parceiro cadastrado e campo "Permitir venda de itens avulsos" configurar como "Sim" caso seja permitido incluir também produtos de forma manual (e não apenas através API).

Imagem 3 - Custom receber operações

Para que no início da venda sejam executados os eventos da API do PDV "Menu venda fechada", é necessário realizar a configuração de acordo com a documentação Configurar Interface. O parâmetro fica no caminho abaixo:

Acrux Monitor > Configurações > Configurações de PDVs > Self-Checkout > Interface > Tela inicial > Botão iniciar > "Executar funções custom venda fechada" > colocar "Sim".

Para parametrizar uma ou mais integrações da API do PDV com o evento "Menu venda fechada" acesse:

Acrux Monitor > Configurações > Configurações de PDVs > Integrações externas > Vendas > Integração > Eventos > "Menu venda fechada":

Obs.: se o parâmetro "Executar funções custom venda fechada no início" (citado anteriormente) estiver configurado como "Sim", este evento será executado ao iniciar a venda, para que seja realizada a integração com a API do parceiro.

Imagem 4 - Evento menu venda fechada

Acesse a documentação deste evento aqui: 06 - Menu Venda Fechada (veja também a opção Comando Obter Valor, para que o parceiro solicite por exemplo uma informação ao PDV quando a integração for executada).

Obs.: de acordo com o modo de operação utilizado e com as configurações realizadas, é necessário se atentar também aos parâmetros de áudios e temas do PDV.

Passo a Passo 

Neste exemplo, utilizaremos o modo "Self-Checkout". Toque no botão "Iniciar":

Imagem 5 - Iniciar venda

Caso parametrizado, o PDV realizará a comunicação com o a API do(s) parceiro(s). E, se parametrizado também, irá solicitar alguma informação:

Imagem 6 - Comunicação com API do(s) parceiro(s)

Após isso, o parceiro pode enviar os produtos que deseja registrar através da API (ver documentação Receber Itens Vendidos - POST).

Realizada a comunicação através da API, o PDV irá inserir os itens na venda:

Imagem 7 - Itens incluídos na venda

É possível enviar produtos desta forma mais de uma vez e também um por vez ou vários, de acordo com a melhor opção para a operação que estiver sendo realizada.

A partir deste momento, o fluxo do PDV segue normalmente, de acordo com as configurações e modo de operação, para a finalização\pagamento.

03. TABELAS UTILIZADAS

Não há.

04. TECNOLOGIAS HOMOLOGADAS