Skip to main content
Este documento descreve os payloads de webhook relacionados a pedidos.

​
Pedidos

Enviado quando um novo pedido é registrado.
Enviado quando um pedido existente é atualizado.
Estrutura do Payload (ambos os tópicos): 
{
  "Customer": { ... },
  "OrderId": "pedido_original_456",
  "BonifiQOrderId": 12345,
  "OrderPlacementDate": "2025-04-15T10:30:00Z",
  "OrderTotal": 250.00,
  "PointsBalance": { ... },
  "EarnedPoints": 250,
  "EarnedCashback": 2.50
}
​
Customer
object
required
Objeto Cliente
​
OrderId
string
required
ID do pedido no sistema de origem
​
BonifiQOrderId
number
required
ID interno no sistema BonifiQ
​
OrderPlacementDate
string
required
Data do pedido (ISO 8601)
​
OrderTotal
number
required
Valor total do pedido
​
PointsBalance
object
required
Objeto Saldo de Pontos
​
EarnedPoints
number
required
Pontos ganhos/associados
​
EarnedCashback
number
required
Cashback ganho/associado

​
Tópicos Disponíveis

TópicoDescrição
OrderInsertPedido inserido
OrderUpdatePedido atualizado
Documentação atualizada em Dezembro de 2025.