Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Utilizar no inicio da venda quando precisar realizar requisições de integração com a API.

No inicio da venda, pode-se utilizar todos os comandos da API para o PDV aplicar o retorno.
Exemplos : Exibir uma mensagem ou mostrar um menu de opções ou Obter Valor.

Na maioria dos casos, utiliza-se o comando Obter valor no inicio da venda para identificar o Cliente pelo CPF ou CNPJ.

Na Header, temos um campo para identificação do cliente para envio ao parceiro, o campo Identification  que contém os seguintes campos : 

IdentificationType : citInternal (veja a tabela abaixo os tipos de identificações)
DocumentType: cdtCPF  (cdtCNPJ ou cdtCPF) ==> Tipo de documento
Document : 11111111111 ==> Dados do documento apresentado
PartnerCode := 0 ==> Código do parceiro

Valores para TIdentificationType abaixo :  

TIdentificationType Descrição do tipo de identificação
citInternal,Identificação interna
citInvoiceIdentificação fiscal (Nota fiscal paulista e outros)
citRewardIdentificação de recompensas, parceiros, etc.
citOtherOutras identificações
citUnknown Desconhecido

Com o PDV na operação “Início da venda”, a requisição da API trará o “Operation” com valor “cotStartSale”.


Observação importante para Identificação Unificada : Independente do parâmetro de identificação unificada ativo ou não sempre exibir a tela de identificação quando solicitado pelo parceiro através da API Custom do PDV, atualmente quando ativo o parâmetro e anteriormente a operadora abortar uma identificação não abrirá a a tela de identificação solicitado pelo parceiro


Request Example

A API PDV requisitará para o integrador(parceiro) qual ação deverá ser executada, informando o ciclo da operação que ele está “Operation”, a identificação única da operação/documento “ID”, se a ação será executada antes ou após o evento “Event” e qual a versão da API “Version”.

{
"Event": "cetBefore",
"Execution": "cetContinue",
"ID": "001212000628826",
"Operation": "cotStartSale",
"ParkingTicket": null,
"Pay": null,
"Response": "",
"Sale": {
"Discount": 0.0,
"DiscountCodes": [],
"Header": {
"AccountingDate": "2020-12-28T00:00:00",
"DateTimeIssue": "2020-12-28T17:56:42",
"IdDocument": 628826,
"CooDocument": 527,
"IdStore": 1,
"IdTerminal": 212,
"IdUser": 2,
"Identification": [
{
"IdentificationType" : citInternal,
"Document" : LCpfCnpj,
"DocumentType" : 11111111111,
"PartnerCode" : 0
}
],
"Status": "sttValid"
},
"ID": "001212000628826",
"Increase": 0.0,
"Items": [],
"Messages": {
"Customer": [],
"User": []
},
"PartitionDiscount": [],
"PartitionIncrease": [],
"PaymentChange": null,
"Payments": [],
"SolidaryChange": null,
"Total": 0.0,
"VouchersPrint": []
},
"Version": 1
}

...

{
"Event": "cetBefore",
"Execution": "cetContinue",
"ID": "001212000628828",
"Operation": "cotStartSale",
"ParkingTicket": null,
"Pay": null,
"Response": "1",
"Sale": {
"Discount": 0.0,
"DiscountCodes": [],
"Header": {
"AccountingDate": "2020-12-28T00:00:00",
"DateTimeIssue": "2020-12-28T18:02:49",
"IdDocument": 628828,
      "CooDocument": 527,
"IdStore": 1,
"IdTerminal": 212,
"IdUser": 2,
"Identification": [],
"Status": "sttValid"
},
"ID": "001212000628828",
"Increase": 0.0,
"Items": [],
"Messages": {
"Customer": [],
"User": []
},
"PartitionDiscount": [],
"PartitionIncrease": [],
"PaymentChange": null,
"Payments": [],
"SolidaryChange": null,
"Total": 0.0,
"VouchersPrint": []
},
"Version": 1
}