Monetizze - Checkout

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

Eventos Disponíveis

• checkout.abandoned

Estrutura do Payload

{
  "customer": {
    "id": null,
    "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": null,
      "number": null,
      "complement": null,
      "neighborhood": null,
      "city": null,
      "state": null,
      "country": null,
      "postal_code": null
    }
  },
  "checkout": {
    "id": "abc123def456",
    "url": "https://monetizze.com.br/checkout/abc123"
  },
  "payment": {
    "currency": "BRL",
    "total": 9970,
    "discount_value": null,
    "shipping_value": null,
    "total_products_value": 9970,
    "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-001",
      "name": "Produto Exemplo",
      "type": "product",
      "offer_type": "main",
      "quantity": 1,
      "unit_value": 9970,
      "total_value": 9970,
      "image_url": null
    }
  ],
  "lead_tracking": {
    "src": null,
    "sck": null,
    "utm_source": null,
    "utm_campaign": null,
    "utm_medium": null,
    "utm_content": null,
    "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	null	Sempre null
name	string | null	Nome do comprador
email	string | null	E-mail do comprador
document	string | null	CPF ou CNPJ
phone_numbers	Collection	Coleção de telefones
address	Address	Endereço do comprador

Telefone

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

Endereço

Campo	Tipo	Descrição
street	string | null	Rua
number	string | null	Número
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado
country	string | null	País
postal_code	string | null	CEP

---

Checkout

Campo	Tipo	Descrição
id	string | null	ID do checkout
url	string | null	URL de recuperação do checkout

---

Payment

Campo	Tipo	Descrição
currency	string	Sempre BRL
total	integer | null	Valor total (em centavos)
discount_value	integer | null	Valor do desconto (em centavos)
shipping_value	integer | null	Valor do frete (em centavos)
total_products_value	integer | null	Valor total dos produtos (em centavos)
payment_method	PaymentMethod	Método de pagamento
coupons	Collection	Coleção de cupons

Cupom

Campo	Tipo	Descrição
id	null	Sempre null
code	string | null	Código do cupom
value	integer | null	Valor do desconto (em centavos)
percentage	null	Sempre null
incidence	string	Sempre products
incidence_type	string	Sempre value
expiration_date	null	Sempre null

Métodos de Pagamento (PaymentMethod)

A Monetizze retorna os seguintes métodos de pagamento:

Valor	Descrição
credit_card	Cartão de Crédito
pix	PIX
boleto	Boleto Bancário

---

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 de oferta (main ou order_bump)

---

Lead Tracking (vazio)

Este componente nunca possui dados úteis na Monetizze. Todos os campos retornam null.

Campo	Tipo	Descrição
src	null	Sempre null
sck	null	Sempre null
utm_source	null	Sempre null
utm_campaign	null	Sempre null
utm_medium	null	Sempre null
utm_content	null	Sempre null
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

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

---

Shipping (vazio)

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	[EmptyAddress]	Endereço vazio
estimated_delivery_date	null	Sempre null
estimated_delivery_time_in_days	null	Sempre null
status	null	Sempre null
raw_status	null	Sempre null

Delivery Address (Vazio)

Campo	Tipo	Descrição
street	null	Sempre null
number	null	Sempre null
complement	null	Sempre null
neighborhood	null	Sempre null
city	null	Sempre null
state	null	Sempre null
country	null	Sempre null
postal_code	null	Sempre null

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

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

---

Voltar para visão geral da integração