07 - Fluxo Completo da API

Objetivo

Informar para API que o fluxo foi completado. A seguir exemplos de como executar esta operação.

Response Example

O integrador (parceiro) responderá para API PDV executar o comando de Completado (nesse exemplo), “execution”:”cetCompleted” informando que o fluxo foi encerrado, passando o código e texto da mensagem.

{
 "version": 1,
 "sale": null,
 "pay": null,
 "return": {
    "code": 0,
    "messageText": "0"
  },
 "execution": "cetCompleted",
 "interpret": null,
 "vouchersPrint": []
}

Exemplo Fluxo Completo

Início da venda no PDV, foi inserido um produto e teclado Enter.

Imagem 1 – Tela de Venda

JSON enviado ao parceiro

{
"Event" "cetBefore",
"Execution" “cetContinue",
"ID" "001600000590894",
"Operation" "cotStartSale",
"Version" 1
}

JSON retornado pelo parceiro

{
  "version"1,
  "execution""cetContinue",
  "interpret"{
    "commandType""cctMessage",
    "messageCommand"{
      "title""Cliente fdelidade",
      "text""É um cliente fdelidade?",
      "defaultButton""Sim",
      "messageType""cmtConfrmation",
      "buttons"[
        {
          "caption""Sim",
          "response""1"
        },
        {
          "caption""Não",
          "response""2"
        }
      ]
    }
  }
}

Tela apresentada ao operador.

Imagem 2 – Cliente Fidelidade

Operador do PDV seleciona uma opção, neste caso foi selecionado Sim.

Imagem 3 – Cliente Fidelidade

JSON enviado ao parceiro

{
  "Event""cetBefore",
  "Execution""cetContinue",
  "ID""001600000590894",
  "Operation""cotStartSale",
  "Response""1",
  "Version"1
}

JSON retornado pelo parceiro

{
  "version"1,
  "execution""cetContinue",
  "interpret"{
    "commandType""cctGetOption",
    "options"{
      "title""Cliente fdelidade",
      "subtitle""Cartão fdelidade",
      "options"[
        "Cartão da loja",
        "Cartão clube especial",
        "Cartão vantagens"
      ],
      "response"[
        "1",
        "2",
        "3"
      ]
    }
  }

Tela apresentada ao operador.

Imagem 4 – Cartão da Loja

Operador do PDV seleciona uma opção, neste caso foi selecionado 01 – Cartão da loja. 

Imagem 5 – Cartão da Loja

JSON enviado ao parceiro

{
  "Event""cetBefore",
  "Execution""cetContinue",
  "ID""001600000590899",
  "Operation""cotStartSale",
  "Response""1",
  "Version"1
}

JSON retornado pelo parceiro

{
  "version"1,
  "execution""cetContinue",
  "interpret"{
    "commandType""cctGetValue",
    "value"{
      "title""Cliente fdelidade",
      "subtitle""Informe o CPF",
      "dataType""cvtPersonalDocument",
      "documentTypes"[
        "cdtCPF",
        "cdtCNPJ"
      ]
    }
  }
}

Tela apresentada ao operador.

Imagem 6 – CPF / CNPJ

Operador preencherá a informação solicitada.

Imagem 7 – CPF / CNPJ

JSON enviado para o Parceiro

{
  "Event""cetBefore",
  "Execution""cetContinue",
  "ID""001600000590894",
  "Operation""cotStartSale",
  "Response""12345678909",
  "Version"1
}

JSON enviado pelo parceiro para informar ao PDV que o processo foi completado

{
  "version"1,
  "execution""cetCompleted"
}

Tela do operador após completar o processo.

Imagem 8 – Tela de Venda