Interromper próximos eventos

Objetivo

O recurso para interromper os próximos eventos visa agilizar a venda quando não há necessidade de executar o evento, mesmo que esteja configurado. Essa opção é controlada pelo parceiro (o integrador) quando necessário.

Essa operação é recomendada para ser utilizada no evento de Início da Venda.

Quando o parceiro retorna para o PDV a propriedade execution como cetCompleted, essa opção permite interromper os próximos eventos.

As informações de resposta fornecidas neste documento são partes que compõem o comando Completado.

Chamada

POST {url}

Informações para Resposta (Response Information)

Parâmetros do Corpo (Body Parameters)

PARÂMETRO	TIPO	OBRIGATÓRIO	DESCRIÇÃO
return.code	Integer	Não	Código de retorno
return.messageText	String	Não	Mensagem de retorno
return.skipNextEvents	Boolean	Não	Indica se interrompe os próximos eventos
execution	String	Sim	Tipo de operação que o PDV deve executar

Formatos de Resposta (Response Formats)

application/json

Exemplo simplificado (Sample)

{
   "return":{
      "code":0,
      "messageText":"",
      "skipNextEvents":true
   },
   "execution":"cetCompleted"
}

Operação no PDV

Veja o exemplo de utilização no PDV usando o Simulador da API do PDV.

Os seguintes eventos estão configurados: Início da Venda, Subtotal da Venda e Finalização da Venda.

No Simulador da API do PDV, para este exemplo, está configurado apenas o comando Completado.

Para interromper os próximos eventos, a propriedade Skip Next Events precisa estar marcada.

Imagem 1 - Simulador da API do PDV.

Observe que, na operação do PDV, mesmo com os eventos Início da Venda, Subtotal da Venda e Finalização da Venda configurados, o PDV não acionou esses eventos porque o Simulador da API do PDV retornou uma instrução para interromper os próximos eventos.

Imagem 2 - PDV.

Árvore de páginas