Webhook de Pedidos

Criada por Alex Camargo, Modificado em Seg, 7 Jul na (o) 2:17 PM por Alex Camargo

O Webhook de pedidos permite comunicar quando um pedido é recebido pela primeira vez na BonifiQ ou então quando este é atualizado em nossa base.

Webhook - Pedido Inserido

Esse webhook é acionado quando uma venda chega até a base da BonifiQ. Esse pedido pode chegar na BonifiQ através de integrações nativas de ecommerce, PDVs ou através de APIs.

Ele pode ser útil para comunicar consumidores logo após estes realizarem uma compra em um PDV, por exemplo.

{
   "Uuid":"ae5539ff-9da9-43f5-ba00-c85700279418",
   "Timestamp":"2025-07-07T16:59:16.659698",
   "Topic":22,
   "TopicName":"OrderInsert",
   "Payload":{
      "Customer":{
         "Email":"teste@bonifiq.com.br",
         "Id":"212227130",
         "Name":"Sofia melo",
         "Phone":"",
         "Document":"1234567",
         "BirthdayDate":null,
         "PointsBalance":1059
      },
      "OrderId":"1722878935",
      "BonifiQOrderId":12045940,
      "OrderPlacementDate":"2025-07-04T18:22:31",
      "OrderTotal":199.60000000000000000000000000,
      "EarnedPoints":398,
      "EarnedCashback":39
   }
}

Os campos retornados são:

- Customer.Email: Email do consumidor que realizou a compra

- Customer.Id: Id do consumidor na BonifiQ

- Customer.Name: Nome completo do consumidor

- Customer.Phone: número de celular do consumidor

- Customer.Document: CPF ou CNPJ do consumidor

- Customer.BirthdayDate: Data de nascimento do consumidor

- Customer.PointsBalance: Saldo geral de pontos do consumidor

- OrderId: Identificador do pedido na plataforma

- BonifiQOrderId: Identificador do pedido na BonifiQ

- OrderPlacementDate: data em que o pedido foi realizado

- OrderTotal: Valor líquido da venda que será considerado para Bonificação. Exclui frete, promoções, descontos, uso de cashback, etc

- EardnedPoints: Quantos pontos essa venda irá gerar

- EarnedCashback: Quanto de cashback esa venda irá gerar. Possuirá valor apenas se a recompensa de cashback estiver ativa

Webhook - Pedido Alterado

Esse webhook é acionado quando uma venda é atualizada na base da BonifiQ. Esse pedido pode chegar na BonifiQ através de integrações nativas de ecommerce, PDVs ou através de APIs.

{
   "Uuid":"ae5539ff-9da9-43f5-ba00-c85700279418",
   "Timestamp":"2025-07-07T16:59:16.659698",
   "Topic":22,
   "TopicName":"OrderUpdate",
   "Payload":{
      "Customer":{
         "Email":"teste@bonifiq.com.br",
         "Id":"212227130",
         "Name":"Sofia melo",
         "Phone":"",
         "Document":"1234567",
         "BirthdayDate":null,
         "PointsBalance":1059
      },
      "OrderId":"1722878935",
      "BonifiQOrderId":12045940,
      "OrderPlacementDate":"2025-07-04T18:22:31",
      "OrderTotal":199.60000000000000000000000000,
      "EarnedPoints":398,
      "EarnedCashback":39
   }
}