Pular para o conteúdo

Ecomplus - Checkout

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

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": "CART-123",
"url": "https://loja.ecomplus.com/checkout/abc123"
},
"lead_tracking": {
"src": null,
"sck": null,
"utm_source": "google",
"utm_campaign": "campanha_verao",
"utm_medium": "cpc",
"utm_content": "banner_principal",
"utm_term": "produto_barato",
"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[CustomerAddress]Endereço do cliente

CustomerAddress

Endereço do cliente.

CampoTipoDescrição
streetstring | nullNome da rua
numberstring | nullNúmero
complementstring | nullComplemento
neighborhoodstring | nullBairro
citystring | nullCidade
statestring | nullEstado (sigla)
countrystringCódigo ISO (sempre BR)
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

LeadTracking

CampoTipoDescrição
srcnullSempre null
scknullSempre null
utm_sourcestring | nullFonte da campanha
utm_campaignstring | nullNome da campanha
utm_mediumstring | nullMeio da campanha
utm_contentstring | nullConteúdo da campanha
utm_termstring | nullTermo da campanha
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