Histórico da Página

...

Observação : 

Existe também um recurso novo implantado a partir da versão 23.10.001 que trata um tipo de mensagem específico para que o parceiro utilize a confirmação no PINPAD do PDV.

O parceiro deverá, na mensagem MessageType escolher o tipo cmtConfirmationPinPad.

Início da venda

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": "001003000134284001212000628838",

 "Operation": "cotStartSale",
 "ParkingTicket": null,

  "VersionPay": 1
}

Response Example

O integrador (parceiro) responderá para API PDV executar o comando de Exibir mensagem (neste exemplo) “commandType: cctMessage”, informando o título, subtítulo e o texto para a caixa de diálogo, será solicitado também o tipo da mensagem “messageType” e um array com dois botões, aguardando uma resposta informando qual botão foi pressionado pelo operador, “Sim : 1” e “Não : 2”. Obs (Poderão ter nenhum, um ou dois botões na caixa de diálogo).

{
 "version": 1,
 "execution": "cetContinue",
 "interpret": {
    "commandType": "cctMessage",
    "messageCommand": {
       "title": "Cliente fidelidade",
       "subtitle": "Deseja participar?",
       "text": "É um cliente fidelidade?",
       "defaultButton": "Sim",
       "messageType": "cmtConfirmation",
          "buttons": [
             {
              "caption": "Sim",
              "response": "1"             
             },
             {
              "caption": "Não",
              "response": "2"             
             }          
           ]      
     }   
  }
}

Request Example

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 pressionado o botão Sim, informado no “Response” o valor “1”.

null,
 "Response": "",
 "Sale": {
    "Discount": 0.0,
    "DiscountCodes": [],
    "Header": {
       "AccountingDate": "2020-12-29T00:00:00",
       "DateTimeIssue": "2020-12-29T10:39:01",
       "IdDocument": 628838,
       "IdStore": 1,
       "IdTerminal": 212,
       "IdUser": 2,
       "Identification": [],
       "Status": "sttValid"
     },
    "ID": "001212000628838",
    "Increase": 0.0,
    "Items": [],
    "Messages": {
       "Customer": [],
       "User": []
     },
    "PartitionDiscount": [],
    "PartitionIncrease": [],
    "PaymentChange": null,
    "Payments": [],
    "SolidaryChange": null,
    "Total": 0.0,
    "VouchersPrint": []
  },
 "Version": 1
}

Response Example

O integrador (parceiro) responderá para API PDV executar o comando de Exibir mensagem (neste exemplo) “commandType: cctMessage”, informando o título, subtítulo e o texto para a caixa de diálogo, será solicitado também o tipo da mensagem “messageType” e um array com dois botões, aguardando uma resposta informando qual botão foi pressionado pelo operador, “Sim : 1” e “Não : 2”. Obs (Poderão ter nenhum, um ou dois botões na caixa de diálogo).

{
 "version": 1,
 "sale": {
    "increase": 0,
    "discount": 0,
    "total": 0,
    "header": null,
    "payments": [],
    "paymentChange": null,
    "solidaryChange": null,
    "items": [],
    "discountCodes": [],
    "messages": {
       "customer": [],
       "user": []
     },
    "vouchersPrint": [],
    "partitionIncrease": [],
    "partitionDiscount": []
  },
 "pay": null,
 "return": {
    "code": 0
  },
 "execution": "cetContinue",
 "interpret": {
    "commandType": "cctMessage",
    "messageCommand": {
      "title": "Cliente fidelidade",
      "text": "É um cliente fidelidade?\r\n",
      "defaultButton": "Sim",
      "messageType": "cmtConfirmation",
      "buttons": [
         {
          "caption": "Sim",
          "response": "1"
         },
         {
          "caption": "Não",
          "response": "2"
         }
      ]
     },
    "options": null,
    "value": null
  },
 "vouchersPrint": []
}

Request Example

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 pressionado o botão Sim, informado no “Response” o valor “1”.

{
 "Event": "cetBefore",
 "Execution": "cetContinue",
 "ID": "001212000628838",
 "Operation": "cotStartSale",
 "ParkingTicket": null,
 "Pay": null,
 "Response": "1",
 "Sale": {
    "Discount": 0.0,
    "DiscountCodes": [],
    "Header": {
       "AccountingDate": "2020-12-29T00:00:00",
       "DateTimeIssue": "2020-12-29T10:39:01",
       "IdDocument": 628838,
       "IdStore": 1,
       "IdTerminal": 212,
       "IdUser": 2,
       "Identification": [],
        "Status": "sttValid"
     },
    "ID": "001212000628838",
    "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": "001003000134284",
 "Operation": "cotStartSale",
 "Response": "1",
 "Version": 1
}

Subtotal da venda

Com o PDV na operação “Subtotal da venda”, a notificação da API trará o “Operation” com valor “cotSubtotalSale”, informará também as informações da venda e dos itens.

...