Comando Falhar

Objetivo

Informar para API que houve falha no fluxo. A seguir exemplos de como executar esta operação.

Response Example

O integrador (parceiro) responderá para API PDV executar o comando de Falhado (nesse exemplo), “execution”:”cetFailed” informando que houve falha durante o fluxo, passando o código e texto da mensagem.

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

Exemplo Fluxo Falhar

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

Imagem 1

JSON enviado ao parceiro:

{
 "Event": "cetBefore",
 "Execution": "cetContinue",
 "ID": "001212000628834",
 "Operation": "cotStartSale",
 "ParkingTicket": null,
 "Pay": null,
 "Response": "",
 "Sale": {
    "Discount": 0.0,
    "DiscountCodes": [],
    "Header": {
       "AccountingDate": "2020-12-29T00:00:00",
       "DateTimeIssue": "2020-12-29T08:24:09",
       "IdDocument": 628834,
       "IdStore": 1,
       "IdTerminal": 212,
       "IdUser": 2,
       "Identification": [],
       "Status": "sttValid"
     },
    "ID": "001212000628834",
    "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": 763,
         "discountAmount": 0
        }
     ]
  },
 "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": []
}

Tela apresentada ao operador:

Imagem 2

Operador do PDV seleciona uma opção, neste caso foi selecionado “Sim”:

Imagem 3

JSON enviado pelo parceiro para informar ao PDV que ocorreu falha durante o processo:

{
 "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": -1,
    "messageText": "-1"
  },
 "execution": "cetFailed",
 "interpret": null,
 "vouchersPrint": []
}

Tela do operador após falha do processo:

Imagem 4