Solicitar para a aplicação de PDV que exiba uma caixa de diálogo ao operador com um campo editável, utilizado para obter informações e enviar para a API do parceiro conforme necessidade. A seguir exemplos de como executar esta operação e os parâmetros necessários.
| PARÂMETRO | TIPO | OBRIGATÓRIO | DESCRIÇÃO |
| Execution | string | true | Tipo da execução: cetContinue, cetInterrupt, cetFailed |
| Version | string | true | Versão da API |
| CommandType | string | true | Tipo do comando: cctMessage, cctGetOption, cctGetValue |
| Title | string | false | Título da caixa de diálogo |
| Subtitle | string | false | Subtítulo da caixa de diálogo |
| DataType | string | true | Tipo de dado informado cvtString cvtNumber cvtDate cvtTime cvtQRCode cvtPersonalDocument cvtPhoneNumber |
| Size | integer | true | Tamanho do documento para tipos “String” e “Number”, demais tipos recebem o valor “0” |
| DocumentType | String List | true | Tipo do documento cdtIDInternal cdtCPF cdtCNPJ cdtIDForeign |
Com o PDV na operação “Início da venda”, a requisição da API trará o “Operation” com valor “cotStartSale”.
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": "001212000628814",
"Operation": "cotStartSale",
"ParkingTicket": null,
"Pay": null,
"Response": "",
"Sale": {
"Discount": 0.00,
"DiscountCodes": [],
"Header": {
"AccountingDate": "2020-12-28T00:00:00",
"DateTimeIssue": "2020-12-28T17:01:04",
"IdDocument": 628814,
"IdStore": 1,
"IdTerminal": 212,
"IdUser": 2,
"Identification": [],
"Status": "sttValid"
},
"ID": "001212000628814",
"Increase": 0.00,
"Items": [],
"Messages": {
"Customer": [],
"User": []
},
"PartitionDiscount": [],
"PartitionIncrease": [],
"PaymentChange": null,
"Payments": [],
"SolidaryChange": null,
"Total": 0.00,
"VouchersPrint": []
},
"Version": 1
}O integrador (parceiro) responderá para API PDV executar o comando de Obter valor (neste exemplo) “commandType: cctGetValue”, informando o título e subtítulo para a caixa de diálogo, o tipo do documento e tamanho do dado que será capturado, neste caso um CPF.
{
"version": 1,
"sale": {
"increase": 0,
"discount": 0,
"total": 0,
"header": null,
"payments": [],
"paymentChange": null,
"solidaryChange": null,
"items": [],
"discountCodes": [],
"messages": {
"customer": [ {
"text": "Ganhou 1000 pontos nessa compra\r\n"
}
],
"user": [ {
"text": "Ganhou 100 pontos nessa compra\r\n"
}
]
},
"vouchersPrint": [ {
"text": " CUPOM DESCONTO 1\r\n\r\n Cupom de 5% de desconto para \r\npróxima\r\ncompra, aplicado para todos os \r\nprodutos.\r\n\r\n[ImpBarra]1234567890\r\n[ImpFimBarra]\r\n"
},
{
"text": " CUPOM DESCONTO 2\r\n\r\n Cupom de 10% de desconto para \r\npróxima\r\ncompra, aplicado para todos os \r\nprodutos.\r\n\r\n[ImpBarra]1234567890\r\n[ImpFimBarra]\r\n"
}
],
"partitionIncrease": [],
"partitionDiscount": [ {
"price": 0,
"partnerCode": 0,
"promotionCode": 696,
"discountAmount": 0
}
]
},
"pay": null,
"return": {
"code": 0
},
"execution": "cetContinue",
"interpret": {
"commandType": "cctGetValue",
"messageCommand": null,
"options": null,
"value": {
"title": "Cliente fidelidade",
"subtitle": "Informe o CPF",
"dataType": "cvtPersonalDocument",
"size": 0,
"documentTypes": [
"cdtCPF",
"cdtCNPJ"
]
}
},
"vouchersPrint": []
}A API PDV requisitará para o integrador (parceiro) uma nova ação à ser tomada informando qual foi a resposta obtida pela aplicação de PDV, (neste exemplo), foi informado o número do CPF no “Response” o valor “12345678909”.
{
"Event": "cetBefore",
"Execution": "cetContinue",
"ID": "001212000628814",
"Operation": "cotStartSale",
"ParkingTicket": null,
"Pay": null,
"Response": "12345678909",
"Sale": {
"Discount": 0.0,
"DiscountCodes": [],
"Header": {
"AccountingDate": "2020-12-28T00:00:00",
"DateTimeIssue": "2020-12-28T17:01:04",
"IdDocument": 628814,
"IdStore": 1,
"IdTerminal": 212,
"IdUser": 2,
"Identification": [],
"Status": "sttValid"
},
"ID": "001212000628814",
"Increase": 0.0,
"Items": [],
"Messages": {
"Customer": [],
"User": []
},
"PartitionDiscount": [],
"PartitionIncrease": [],
"PaymentChange": null,
"Payments": [],
"SolidaryChange": null,
"Total": 0.0,
"VouchersPrint": []
},
"Version": 1
}Com o PDV na operação “Subtotal da venda”, a requisição da API trará o “Operation” com valor “cotSubtotalSale”.
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”, qual a versão da API “Version”.
Informará também os dados da venda “Sale” e dos itens “Items”.
{
"Event": "cetBefore",
"Execution": "cetContinue",
"ID": "001600000590853",
"Operation": "cotSubtotalSale",
"Sale": {
"Header": {
"AccountingDate": "2020-01-22T00:00:00",
"DateTimeIssue": "2020-01-22T14:15:36"
},
"ID": "001600000590853",
"Items": [
{
"CaptionPacking": "UN",
"Description": "COCA COLA",
"InternalCode": "3988",
"ItemNumber": 1,
"PackingQuantity": 1.000,
"Quantity": 5.000
}
]
}
}Com o PDV na operação “Finalização da venda”, a notificação da API trará o “Operation” com valor “cotEndSale”, informará também as informações da venda e dos itens.
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”, qual a versão da API “Version”.
Informará também os dados da venda “Sale”, itens “Items” e dos pagamentos “Payments”.
{
"Event""cetBefore",
"Execution""cetContinue",
"ID""001600000590853",
"Operation""cotEndSale",
"Sale"{
"Header"{
"AccountingDate""2020-01-22T00 00 00",
"DateTimeIssue""2020-01-22T14 15 36""IdDocument"154625,
"IdStore"1,
"IdTerminal"1,
"IdUser"2,
"Identifcation"[
{
"Document""12345678909",
"PartnerCode""10",
"DocumentType""cdtCPF"
}
],
},
"ID""001600000590853",
"Items"[
{
"CaptionPacking""UN",
"Description""COCA COLA",
"InternalCode""3988",
"ItemNumber"1,
"PackingQuantity"1.000,
"Quantity"5.000"Status""sttValid",
"TotalPrice"9.89,
"UnitPrice"1.00
}
],
"PaymentChange"{
"PaymentType""cptMoney",
"Total"0.00
},
"Payments"[
{
"ItemNumber"1,
"authorizationCode""FD455FKL34SS1100AXV",
"PaymentNumber"1,
"PaymentType""cptMoney",
"Total"9.89
}
],
"Total"0.000
},
"Version"1
}