Controle de cancelamento em descontos via API

CONTEÚDO

1. Visão Geral
2. Exemplo de utilização
3. Tela Controle de cancelamento em descontos via API
   1. Outras Ações / Ações relacionadas
      
4. Tela Controle de cancelamento em descontos via API
   1. Principais Campos e Parâmetros
      
5. Tabelas utilizadas

01. VISÃO GERAL

Será implementado no PDV o bloqueio do cancelamento dos itens que serviram como base para concessão de descontos no cupom. Antes do evento de Subtotal da venda, os itens poderão ser cancelados normalmente. Após a execução do evento de  Subtotal da venda, o parceiro retornará ao PDV a lista dos itens envolvidos no desconto. E caso retorne para a tela de venda para realizar algum cancelamento, o sistema impedirá que esses itens, inclusive o que recebeu o desconto, sejam cancelados.

02. EXEMPLO DE UTILIZAÇÃO

Caminho

Monitor PDV / Configurações / Configurações de PDVs / Integrações externas / Vendas

Monitor PDV / Configurações / Configurações de PDVs / Regras de negócios / Regras de incentivos

Pré-Requisitos e Restrições

Ter acesso ao monitor para realizar as configurações necessárias.

O recurso deverá ser utilizado nos eventos do subtotal(cotSubtotalSale).

Passo a Passo

Configurações no Monitor PDV

Acesse o Monitor PDV de um navegador na URL http://<ipservidor>/monitorpdv. Troque os símbolos maior e menor e o que está entre eles pelo IP do servidor.

Na sequência informe um Usuário e Senha com permissão para acessar a aplicação.

No menu lateral do lado esquerdo, acesse Configurações e depois Configurações de PDV.

Na tela de Configurações de PDVs, no menu superior, informe a Loja, o Segmento e os PDVs que receberão as novas configurações. Em seguida, clique no botão Carregar Parâmetros.

Imagem 1 - Tela de configurações de PDVs.

Acesso o grupo Integrações externas > Vendas.

Escolha uma das 4 integrações disponíveis.

Informe o Código do parceiro.

Imagem 2 - Código do parceiro.

Acesse o grupo o Eventos > Subtotal da venda.

Configure a URL, para acionar o evento.

Imagem 3 - Evento subtotal.

Operação de comunicação na API do PDV

Durante a operação do subtotal, o PDV realiza uma requisição no evento correspondente. Ao final da interação, o parceiro deverá responder com o status completado (cetCompleted) e informar na propriedade PartnerGroupItems, os itens que atuam como gatilho ou que receberão descontos no cupom.

A propriedade ItemNumber do objeto PartnerGroupItems deve receber o mesmo valor informado na requisição Sale.Items[0].ItemNumber.

A estrutura de requisição e resposta do evento subtotal contém somente as propriedades essenciais para realizar a operação de controle de cancelamento em descontos. Para consultar todas as propriedades disponíveis, verifique a documentação completa do Subtotal da venda. 

Veja a baixo a estrutura de requisição e resposta.

Requisição subtotal da venda

{
   "Version":1,
   "Event":"cetAfter",
   "Execution":"cetContinue",
   "ID":"001032001669485",
   "Operation":"cotSubtotalSale",
   "Sale":{
      "Header":{
         "AccountingDate":"2025-07-17T00:00:00",
         "CooDocument":279,
         "DateTimeIssue":"2025-07-17T16:08:13",
         "IdDocument":1669485,
         "IdStore":1,
         "IdTerminal":32,
         "IdUser":2,
         "Status":"sttValid"
      },
      "Items":[
         {
            "BarCode":"7891000100103",
            "CaptionPacking":"UN",
            "Description":"LEITE COND MOCA LATa 395G",
            "InternalCode":"4900",
            "ItemNumber":1,
            "PackingQuantity":1,
            "Quantity":1,
            "Status":"sttValid",
            "TotalPrice":3,
            "UnitPrice":3
         },
         {
            "BarCode":"7891000100103",
            "CaptionPacking":"UN",
            "Description":"LEITE COND MOCA LATa 395G",
            "InternalCode":"4900",
            "ItemNumber":2,
            "PackingQuantity":1,
            "Quantity":1,
            "Status":"sttValid",
            "TotalPrice":3,
            "UnitPrice":3
         },
         {
            "BarCode":"7891000100103",
            "CaptionPacking":"UN",
            "Description":"LEITE COND MOCA LATa 395G",
            "InternalCode":"4900",
            "ItemNumber":3,
            "PackingQuantity":1,
            "Quantity":1,
            "Status":"sttValid",
            "TotalPrice":3,
            "UnitPrice":3
         },
         {
            "BarCode":"7891000100103",
            "CaptionPacking":"UN",
            "Description":"LEITE COND MOCA LATa 395G",
            "InternalCode":"4900",
            "ItemNumber":4,
            "PackingQuantity":1,
            "Quantity":1,
            "Status":"sttValid",
            "TotalPrice":3,
            "UnitPrice":3
         },
         {
            "BarCode":"7893218003719",
            "CaptionPacking":"UN",
            "Description":"WHISKY JOHNNIE WALKER RE",
            "InternalCode":"548",
            "ItemNumber":5,
            "PackingQuantity":1,
            "Quantity":1,
            "Status":"sttValid",
            "TotalPrice":3,
            "UnitPrice":3
         }
      ],
      "Total":15,
      "TotalSale":15
   }
}

Resposta subtotal da venda

{
   "sale":{
      "partnerGroupItems":[
         {
            "itemNumber":"1"
         },
         {
            "itemNumber":"2"
         },
         {
            "itemNumber":"5"
         }
      ]
   },
      "execution":"cetCompleted"
}

03. TELA Controle de cancelamento em descontos via API

Não há.

04. TELA Calcular desconto não aplicado

Principais Campos e Parâmetros

05. TABELAS UTILIZADAS

Não há.

06. TECNOLOGIAS HOMOLOGADAS