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", "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
| Campo | Tipo | Descrição |
|---|---|---|
id | string | null | ID do cliente |
name | string | null | Nome completo do cliente |
email | string | null | E-mail do cliente |
document | string | null | CPF ou CNPJ do cliente |
phone_numbers | Phone[] | null | Coleção de telefones do cliente |
address | [Address] | Endereço do cliente |
Address
Endereço do cliente.
| Campo | Tipo | Descrição |
|---|---|---|
street | string | null | Nome da rua |
number | string | null | Número |
complement | string | null | Complemento |
neighborhood | string | null | Bairro |
city | string | null | Cidade |
state | string | null | Estado (sigla) |
country | string | null | Código do país |
postal_code | string | null | CEP |
Phone
Telefone do cliente.
| Campo | Tipo | Descrição |
|---|---|---|
formatted_phone | string | null | Telefone formatado |
type | null | Sempre null |
raw_number | string | null | Número bruto |
area_code | null | Sempre null |
international_dialing_code | null | Sempre null |
Checkout
| Campo | Tipo | Descrição |
|---|---|---|
id | string | null | ID do checkout/carrinho |
url | string | null | URL do checkout |
Payment
| Campo | Tipo | Descrição |
|---|---|---|
currency | string | null | Moeda em formato ISO 4217 |
total | integer | null | Valor total em centavos |
discount_value | integer | null | Valor do desconto em centavos |
shipping_value | null | Sempre null |
total_products_value | integer | null | Valor total dos produtos em centavos |
payment_method | object | null | Método de pagamento |
coupons | array | Array de cupons |
Métodos de Pagamento
Boleto
| Campo | Tipo | Descrição |
|---|---|---|
type | string | Sempre boleto |
digitable_line | string | null | Linha digitável do boleto |
url | string | null | URL do boleto |
expiration_date | integer | null | Timestamp de expiração |
Pix
| Campo | Tipo | Descrição |
|---|---|---|
type | string | Sempre pix |
qrcode_url | string | null | URL do QR Code Pix |
qrcode_signature | null | Sempre null |
expiration_date | integer | null | Timestamp de expiração |
pix_key | null | Sempre null |
pix_key_type | null | Sempre null |
CreditCard
| Campo | Tipo | Descrição |
|---|---|---|
type | null | Sempre null |
brand | null | Sempre null |
last_digits | null | Sempre null |
expiration_month | null | Sempre null |
expiration_year | null | Sempre null |
[!NOTE] A Eduzz não expõe informações detalhadas do cartão de crédito nos webhooks.
Coupon
| Campo | Tipo | Descrição |
|---|---|---|
id | null | Sempre null |
code | string | null | Código do cupom |
value | integer | null | Valor do cupom em centavos |
percentage | null | Sempre null |
incidence | string | Incidência (products) |
incidence_type | string | Tipo (value) |
expiration_date | null | Sempre null |
Shipping
| Campo | Tipo | Descrição |
|---|---|---|
carrier | null | Sempre null |
total_value | null | Sempre null |
tracking_url | null | Sempre null |
tracking_code | null | Sempre null |
method | null | Sempre null |
delivery_address | null | Sempre null |
estimated_delivery_date | null | Sempre null |
estimated_delivery_time_in_days | null | Sempre null |
status | null | Sempre null |
raw_status | null | Sempre null |
[!NOTE] A Eduzz não disponibiliza informações de envio/entrega.
Product
| Campo | Tipo | Descrição |
|---|---|---|
id | string | null | ID do produto |
name | string | null | Nome do produto |
quantity | integer | null | Quantidade |
unit_value | integer | null | Valor unitário em centavos |
total_value | integer | null | Valor total em centavos |
image_url | null | Sempre null |
type | string | Tipo do produto (product ou subscription_plan) |
offer_type | string | Tipo da oferta (main) |
LeadTracking
| Campo | Tipo | Descrição |
|---|---|---|
src | string | null | Fonte do tracker |
sck | string | null | Código do tracker |
utm_source | string | null | Fonte da campanha |
utm_campaign | string | null | Nome da campanha |
utm_medium | string | null | Meio da campanha |
utm_content | string | null | Conteúdo da campanha |
utm_term | null | Sempre null |
utm_id | null | Sempre null |
meta_fbp | null | Sempre null |
google_ga_id | null | Sempre null |
google_gclid | null | Sempre null |
google_gclsrc | null | Sempre null |
google_dclid | null | Sempre null |
google_gbraid | null | Sempre null |
google_wbraid | null | Sempre null |
tiktok_ttlid | null | Sempre null |
ip | null | Sempre null |