Pular para o conteúdo

Eduzz - Checkout

Eventos da família checkout.* na integração Eduzz.

Eventos Disponíveis

  • checkout.abandoned

Estrutura do Payload

{
"customer": {
"id": "CUST-123",
"name": "João Silva",
"email": "[email protected]",
"document": "12345678900",
"phone_numbers": [
{
"formatted_phone": "+5511999999999",
"type": null,
"raw_number": "5511999999999",
"area_code": null,
"international_dialing_code": null
}
],
"address": {
"street": "Rua Principal",
"number": "123",
"complement": "Apto 45",
"neighborhood": "Centro",
"city": "São Paulo",
"state": "SP",
"country": "BR",
"postal_code": "01000-000"
}
},
"checkout": {
"id": "CHECKOUT-123",
"url": "https://checkout.eduzz.com/abc123"
},
"payment": {
"currency": null,
"total": null,
"discount_value": null,
"shipping_value": null,
"total_products_value": null,
"payment_method": null,
"coupons": [
{
"code": "DESCONTO10",
"value": 1000
}
]
},
"shipping": {
"carrier": null,
"total_value": null,
"tracking_url": null,
"tracking_code": null,
"method": null,
"delivery_address": null,
"estimated_delivery_date": null,
"estimated_delivery_time_in_days": null,
"status": null,
"raw_status": null
},
"products": [
{
"id": "PROD-456",
"name": "Curso Online",
"quantity": 1,
"unit_value": null,
"total_value": null,
"image_url": null,
"type": "product",
"offer_type": "main"
}
],
"lead_tracking": {
"src": "facebook",
"sck": "campaign123",
"utm_source": "facebook",
"utm_campaign": "campanha_verao",
"utm_medium": "cpc",
"utm_content": "banner_principal",
"utm_term": null,
"utm_id": null,
"meta_fbp": null,
"google_ga_id": null,
"google_gclid": null,
"google_gclsrc": null,
"google_dclid": null,
"google_gbraid": null,
"google_wbraid": null,
"tiktok_ttlid": null,
"ip": null
}
}

Componentes do Payload

Customer

CampoTipoDescrição
idstring | nullID do cliente
namestring | nullNome completo do cliente
emailstring | nullE-mail do cliente
documentstring | nullCPF ou CNPJ do cliente
phone_numbersPhone[] | nullColeção de telefones do cliente
address[Address]Endereço do cliente

Address

Endereço do cliente.

CampoTipoDescrição
streetstring | nullNome da rua
numberstring | nullNúmero
complementstring | nullComplemento
neighborhoodstring | nullBairro
citystring | nullCidade
statestring | nullEstado (sigla)
countrystring | nullCódigo do país
postal_codestring | nullCEP

Phone

Telefone do cliente.

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

Checkout

CampoTipoDescrição
idstring | nullID do checkout/carrinho
urlstring | nullURL do checkout

Payment

CampoTipoDescrição
currencystring | nullMoeda em formato ISO 4217
totalinteger | nullValor total em centavos
discount_valueinteger | nullValor do desconto em centavos
shipping_valuenullSempre null
total_products_valueinteger | nullValor total dos produtos em centavos
payment_methodobject | nullMétodo de pagamento
couponsarrayArray de cupons

Métodos de Pagamento

Boleto

CampoTipoDescrição
typestringSempre boleto
digitable_linestring | nullLinha digitável do boleto
urlstring | nullURL do boleto
expiration_dateinteger | nullTimestamp de expiração

Pix

CampoTipoDescrição
typestringSempre pix
qrcode_urlstring | nullURL do QR Code Pix
qrcode_signaturenullSempre null
expiration_dateinteger | nullTimestamp de expiração
pix_keynullSempre null
pix_key_typenullSempre null

CreditCard

CampoTipoDescrição
typenullSempre null
brandnullSempre null
last_digitsnullSempre null
expiration_monthnullSempre null
expiration_yearnullSempre null

[!NOTE] A Eduzz não expõe informações detalhadas do cartão de crédito nos webhooks.

Coupon

CampoTipoDescrição
idnullSempre null
codestring | nullCódigo do cupom
valueinteger | nullValor do cupom em centavos
percentagenullSempre null
incidencestringIncidência (products)
incidence_typestringTipo (value)
expiration_datenullSempre null

Shipping

CampoTipoDescrição
carriernullSempre null
total_valuenullSempre null
tracking_urlnullSempre null
tracking_codenullSempre null
methodnullSempre null
delivery_addressnullSempre null
estimated_delivery_datenullSempre null
estimated_delivery_time_in_daysnullSempre null
statusnullSempre null
raw_statusnullSempre null

[!NOTE] A Eduzz não disponibiliza informações de envio/entrega.


Product

CampoTipoDescrição
idstring | nullID do produto
namestring | nullNome do produto
quantityinteger | nullQuantidade
unit_valueinteger | nullValor unitário em centavos
total_valueinteger | nullValor total em centavos
image_urlnullSempre null
typestringTipo do produto (product ou subscription_plan)
offer_typestringTipo da oferta (main)

LeadTracking

CampoTipoDescrição
srcstring | nullFonte do tracker
sckstring | nullCódigo do tracker
utm_sourcestring | nullFonte da campanha
utm_campaignstring | nullNome da campanha
utm_mediumstring | nullMeio da campanha
utm_contentstring | nullConteúdo da campanha
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

Voltar para visão geral da integração