Pular para o conteúdo

Greenn - Order

Eventos da família order.* na integração Greenn.

Eventos Disponíveis

  • order.paid
  • order.failed
  • order.disputed
  • order.refunded
  • order.canceled
  • order.waiting_payment

Estrutura do Payload

{
"event": "saleUpdated",
"type": "SALE",
"currentStatus": "paid",
"client": {
"id": "12345",
"name": "João Silva",
"email": "[email protected]",
"document": "12345678900",
"cellphone": "5511999999999"
},
"product": {
"id": "PROD-001",
"name": "Curso Online",
"amount": 9970
},
"sale": {
"id": "SALE-123",
"status": "paid",
"created_at": 1705319000,
"updated_at": 1705319100,
"paid_at": 1705319100,
"amount": 9970,
"method": "PIX",
"shipping_amount": 0,
"coupon": {
"id": "COUPON-001",
"name": "DESCONTO10",
"amount": 10,
"type": "PERCENTAGE"
}
},
"link_checkout": "https://greenn.com/checkout/abc123"
}

Componentes do Payload

Customer

CampoTipoDescrição
idstring | nullID do cliente
namestring | nullNome do cliente
emailstring | nullE-mail do cliente
documentstring | nullDocumento (CPF/CNPJ)
phone_numbersCollectionColeção de telefones
addressEmptyAddressSempre vazio

Telefone

CampoTipoDescrição
formatted_phonestring | nullTelefone formatado
typenullSempre null
raw_numberstring | nullNúmero bruto
area_codenullSempre null
international_dialing_codenullSempre null

Order

CampoTipoDescrição
idstring | nullID do pedido
statusstringStatus normalizado do pedido
created_atinteger | nullTimestamp de criação
updated_atinteger | nullTimestamp de atualização
paid_atinteger | nullTimestamp do pagamento
warranty_untilnullSempre null
canceled_atnullSempre null
refunded_atnullSempre null
raw_statusstring | nullStatus original do provider

Status Normalizados (OrderStatus)

A Greenn retorna os seguintes valores normalizados para o status do pedido:

ValorDescrição
waiting_paymentAguardando pagamento
paidPago
failedFalhou
disputedEm disputa/chargedback
refundedReembolsado
expiredExpirado
canceledCancelado

Cupom

CampoTipoDescrição
idstring | nullID do cupom
codestring | nullCódigo do cupom
valueinteger | nullValor do desconto (em centavos)
percentagefloat | nullPercentual do desconto
incidencestringSempre total
incidence_typestringTipo de incidência (percentage ou value)
expiration_datenullSempre null

Payment

CampoTipoDescrição
currencystringSempre BRL
totalinteger | nullValor total (em centavos)
discount_valuenullSempre null
shipping_valueinteger | nullValor do frete (em centavos)
total_products_valuenullSempre null
payment_methodPaymentMethodMétodo de pagamento
couponsCollectionColeção de cupons

Cupom

CampoTipoDescrição
idstring | nullID do cupom
codestring | nullCódigo do cupom
valueinteger | nullValor do desconto (em centavos)
percentagefloat | nullPercentual do desconto
incidencestringSempre total
incidence_typestringTipo de incidência (percentage ou value)
expiration_datenullSempre null

Product

CampoTipoDescrição
idstring | nullID do produto
namestring | nullNome do produto
quantityintegerSempre 1
unit_valueinteger | nullValor unitário (em centavos)
total_valueinteger | nullValor total (em centavos)
image_urlnullSempre null
typestringSempre product
offer_typestringSempre main

Checkout

CampoTipoDescrição
idnullSempre null
urlstring | nullURL do checkout

Shipping (vazio)

CampoTipoDescrição
carriernullSempre null
total_valuenullSempre null
tracking_urlnullSempre null
tracking_codenullSempre null
methodnullSempre null
delivery_address[EmptyAddress]Endereço vazio
estimated_delivery_datenullSempre null
estimated_delivery_time_in_daysnullSempre null
statusnullSempre null
raw_statusnullSempre null

Delivery Address (Vazio)

CampoTipoDescrição
streetnullSempre null
numbernullSempre null
complementnullSempre null
neighborhoodnullSempre null
citynullSempre null
statenullSempre null
countrynullSempre null
postal_codenullSempre null

[!NOTE] Essa integração não disponibiliza informações de endereço.

[!NOTE] Essa integração não disponibiliza informações de envio.


Lead Tracking (vazio)

CampoTipoDescrição
srcnullSempre null
scknullSempre null
utm_sourcenullSempre null
utm_campaignnullSempre null
utm_mediumnullSempre null
utm_contentnullSempre null
utm_termnullSempre null
utm_idnullSempre null
meta_fbpnullSempre null
google_ga_idnullSempre null
google_gclidnullSempre null
google_gclsrcnullSempre null
google_dclidnullSempre null
google_gbraidnullSempre null
google_wbraidnullSempre null
tiktok_ttlidnullSempre null
ipnullSempre null

[!NOTE] Essa integração não disponibiliza informações de lead tracking.


Voltar para visão geral da integração