Árvore de páginas

Versões comparadas

Chave

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

...

Quando houver a necessidade de interagir com a API no fechamento da venda.

Nesta etapa de conclusão da venda, o parceiro integra a venda na integra, podendo ser utilizado para relatórios ou gerenciamento do parceiro. 

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 := 30 ==> 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
citUnknownDesconhecido


Temos a opção de informar na integração o segmento e a pré-venda que deu origem a mesma, veja na tag Items:

  • IdSegment: Integer; – Número do segmento de faturamento
  • OrderNumber: String; – Número da pré-venda de faturamento

O campo com número da chave do SAT ou chave da NFC-e, é o campo IdInvoiceKey, que no final da venda será populado e passado para o parceiro

Na tag TaxDocument, seráenviado os campos relacionado ao tipo de documento fiscal que foi emitido no PDV: 

Tag

Descrição 

DocumentXML da nota (NF-e, NFCE ou SAT)
IdDocumentNúmero da nota (NF-e, NFCE ou SAT)
KindDocumentModelo do documento fiscal
SerialNumberSérie do documento fiscal
URLUrl QrCode do documento eleltrônico


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.

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”, qual a versão da API “Version”.

...

{
 "Version": 1, 
 "Event": "cetBefore",
 "Execution": "cetContinue",
 "ID": "001212000628810",
 "Operation": "cotEndSale",
 "ParkingTicket": null,
 "Pay": null,
 "Response": "",
 "Sale": {
             "Discount": 0.0,
             "DiscountCodes": [],
             "Header": {
                              "AccountingDate": "2020-12-28T00:00:00",
                              "DateTimeIssue": "2020-12-28T11:13:48",
     "IdDocument": 628810,
        "CooDocument": 527,
       "IdStore": 1,
        "IdDocumentIdTerminal": 628810212,
       "IdUser": 2,
                      "IdStore": 1,
                              "IdTerminal": 212,
                              "IdUser": 2,
                              "Identification": [],
                      "Identification": [
{
"IdentificationType" : citInternal,
"Document" : LCpfCnpj,
"DocumentType" : 11111111111,
"PartnerCode" := 0
}
],
        "Status": "sttValid"  },
        },
     "ID": "001212000628810",
             "Increase": 0.0,
             "Items": [  {
                {
              "BarCode": "255",
                              "CaptionPacking": "KG",
                              "Description": "SALADA MISTA kg",
                              "DiscountPrice": 1.98,
                              "IncreasePrice": 0.0,
                              "InternalCode": "255",
                              "ItemNumber": 1,
                              "PackingQuantity": 1.0,
                              "PartitionDiscount": [  {
                                    {
                               "DiscountAmount": 1.0,
                                                                   "PartnerCode": 20,
                                                                   "Price": 0.99,
                                                                   "PromotionCode": 24 }24,
               "IncreDiscType":  2  
                        },
                      {
                                                                   "DiscountAmount": 1.0,
                                                                   "PartnerCode": 20,
                                                                   "Price": 0.99,
                                                                   "PromotionCodeIncreDiscType": 1 }
                                        }
                        ],
                               "PartitionIncrease": [],
                               "Quantity": 2.0,
                               "SellerCode": 0,
                               "Status": "sttValid",
                    "SellerCode": 0,
"IdSegment": 3,
"OrderNumber": 1526,
"Status": "sttValid",
           "TotalPrice": 17.82,
                               "UnitPrice": 9.9
}
                          ],
             "Messages": {
                                  "Customer": [],
                                  "User": [] 
},
             "PartitionDiscount": [],
             "PartitionIncrease": [],
             "PaymentChange": null,
             "Payments": [ 
{
                                     "AuthorizationCode": "",
                                     "Discount": 0.0,
                                     "ExpirationDateCard": "",
                                     "FirstDigitCard": "",
                                     "FlagCard": "",
                                     "IdWallet": "",
                                     "Increase": 0.0,
                                     "InstallmentAmount": 0,
                                     "ItemNumber": 1,
                                     "LastDigitCard": "",
                                     "NetworkCard": "",
                                     "OwnerCard": "",
                                     "PartitionDiscount": [],
                                     "PartitionIncrease": [],
                                     "PaymentNumber": 1,
         "PaymentType": "cptMoney",
                "Total": 17.82,
           "PaymentTypeTransactionCanceledCode": "cptMoney",
         "TransactionCode": "",
         "TypeWallet": "" 
}
        ],
       "TotalSolidaryChange": 17.82null,
                "TaxDocument": {
                     "TransactionCanceledCode"Document": "",
              "IdDocument": 689,
                       "TransactionCode"KindDocument": "65",
                       "SerialNumber": "412",
             "TypeWalletURL": "" }
                                 ], }
             "SolidaryChange"Total": null17.82,
             "Total"VouchersPrint": 17.82[],
             "VouchersPrintIdInvoiceKey" : []  },"29210214200166000166657020000001019138217110"
}
}