Recurso para o o parceiro ao identificar o cliente, retorno um token do cliente para que seja compartilhado com outras integração.
Essa operação será utilizada no evento de Início da Venda.
Quando o parceiro retorna para o PDV a propriedade execution como cetCompleted, essa opção trará o campo token cliente para ser gravado no PDV.
As informações de resposta fornecidas neste documento são partes que compõem o comando Completado.
POST {url}
| PARÂMETRO | TIPO | TAMANHO | 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 | |
| return.clientToken | String | 36 | Não | Informa o token do cliente que foi identificado pelo parceiro via API |
| execution | String | Sim | Tipo de operação que o PDV deve executar |
Exemplo simplificado (Sample)
{
"return":{
"code":0,
"messageText":"",
"skipNextEvents":true,
"clientToken": "7ec731ad-c901-4baa-8f87-14e349362797"
},
"execution":"cetCompleted"
}
Veja o exemplo de utilização no PDV usando o Simulador da API do PDV.
O evento configurado: Início da Venda.
No Simulador da API do PDV, para este exemplo, está configurado Obter valor e o comando Completado.
Imagem 1 - Simulador da API do PDV.
Observe que, na operação do PDV, no Início da Venda, irá chamar o obter valor solicitando a identificação do cliente
Imagem 2 - PDV
Após a digitação do CPF ou CNPJ e enviado ao parceiro, irá ter um retorno do evento Complete do simulador irá envia o token para o cliente identificado.
{
"version": 1,
"sale": null,
"pay": null,
"return": {
"code": 0,
"messageText": "0",
"skipNextEvents": false,
"clientToken": "7ec731ad-c901-4baa-8f87-14e349362797"
},
"execution": "cetCompleted",
"interpret": null,
"vouchersPrint": [
]
}