Comando Interromper

Objetivo

Solicitar para API que o fluxo seja interrompido. A seguir exemplos de como executar esta operação.

Response Example

O integrador (parceiro) responderá para API PDV executar o comando de Interromper (nesse exemplo), “execution”:”cetInterrupt” solicitando a interrupção do fluxo, passando o código e texto da mensagem.

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

Exemplo Fluxo Interromper

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

Imagem 1

JSON enviado ao parceiro:

{
 "Event": "cetBefore",
 "Execution": "cetContinue",
 "ID": "001212000628832",
 "Operation": "cotStartSale",
 "ParkingTicket": null,
 "Pay": null,
 "Response": "",
 "Sale": {
    "Discount": 0.0,
    "DiscountCodes": [],
    "Header": {
       "AccountingDate": "2020-12-29T00:00:00",
       "DateTimeIssue": "2020-12-29T08:05:01",
       "IdDocument": 628832,
       "IdStore": 1,
       "IdTerminal": 212,
       "IdUser": 2,
       "Identification": [],
       "Status": "sttValid"
     },
    "ID": "001212000628832",
    "Increase": 0.0,
    "Items": [],
    "Messages": {
       "Customer": [],
       "User": []
     },
    "PartitionDiscount": [],
    "PartitionIncrease": [],
    "PaymentChange": null,
    "Payments": [],
    "SolidaryChange": null,
    "Total": 0.0,
    "VouchersPrint": []
  },
 "Version": 1
}

 JSON retornado pelo parceiro:

{
 "version": 1,
 "sale": {
    "increase": 0,
    "discount": 0,
    "total": 0,
    "header": null,
    "payments": [],
    "paymentChange": null,
    "solidaryChange": null,
    "items": [],
    "discountCodes": [],
    "messages": {
       "customer": [],
       "user": []
     },
    "vouchersPrint": [],
    "partitionIncrease": [],
    "partitionDiscount": [ 
        {
         "price": 0,
         "partnerCode": 0,
         "promotionCode": 0,
         "discountAmount": 0
        }
     ]
  },
 "pay": null,
 "return": {
    "code": 0
  },
 "execution": "cetContinue",
 "interpret": {
    "commandType": "cctGetOption",
    "messageCommand": null,
    "options": {
       "title": "Cliente fidelidade",
       "subtitle": "Tipo do cartão fidelidade",
       "options": [
          "Cartão da loja",
          "Cartão clube especial",
          "Cartão vantagens"
        ],
       "response": [
         "1",
         "2",
         "3"
        ]
     },
    "value": null
  },
 "vouchersPrint": []
}

Tela apresentada ao operador:

Imagem 2

Operador do PDV pressiona a tecla “ESC” ou fecha a caixa de diálogo no “X”:

Imagem 3

Tela do operador após interromper o processo:

Imagem 4

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

{
 "version": 1,
 "sale": null,
 "pay": null,
 "return": null,
 "execution": "cetInterrupt",
 "interpret": null,
 "vouchersPrint": []
}