Appmax - Checkout

Eventos da familia checkout.* na integracao Appmax.

Eventos Disponiveis

• checkout.abandoned - Checkout abandonado

Estrutura do Payload

{
  "customer": {
    "id": null,
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "999999999",
        "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": null,
      "postal_code": "01000-000"
    }
  },
  "checkout": {
    "id": "checkout_abc123",
    "url": "https://checkout.appmax.com.br/abc123"
  },
  "payment": {
    "currency": "BRL",
    "total": 29900,
    "discount_value": 0,
    "shipping_value": 0,
    "total_products_value": 29900,
    "payment_method": {
      "type": "credit_card",
      "brand": "visa",
      "last_digits": null,
      "expiration_month": null,
      "expiration_year": null
    },
    "coupons": []
  },
  "shipping": {
    "carrier": null,
    "total_value": 0,
    "tracking_url": null,
    "tracking_code": null,
    "method": null,
    "delivery_address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "neighborhood": "Centro",
      "city": "São Paulo",
      "state": "SP",
      "country": null,
      "postal_code": "01000-000"
    },
    "estimated_delivery_date": null,
    "estimated_delivery_time_in_days": null,
    "status": null,
    "raw_status": null
  },
  "products": [
    {
      "id": "prod_789",
      "name": "Produto Exemplo",
      "type": "product",
      "quantity": 1,
      "unit_value": 29900,
      "total_value": 29900,
      "image_url": "https://example.com/product.jpg",
      "offer_type": "main"
    }
  ],
  "lead_tracking": {
    "src": null,
    "sck": null,
    "utm_source": "facebook",
    "utm_campaign": "black_friday",
    "utm_medium": "cpc",
    "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	Descricao
id	string | null	ID do cliente
name	string | null	Nome do cliente
email	string | null	E-mail do cliente
document	string | null	Documento (CPF/CNPJ)
phone_numbers	array	Lista de telefones
address	object	Endereco

Phone Numbers

Campo	Tipo	Descricao
formatted_phone	string | null	Telefone formatado em E.164
type	null	Sempre null
raw_number	string | null	Numero sem formatacao
area_code	null	Sempre null
international_dialing_code	null	Sempre null

Address

Campo	Tipo	Descricao
street	string | null	Nome da rua
number	string | null	Numero
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (sigla)
country	null	Sempre null
postal_code	string | null	CEP

---

Checkout

Campo	Tipo	Descricao
id	string | null	ID do checkout
url	string | null	URL do checkout

---

Payment

Campo	Tipo	Descricao
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	object | null	Metodo de pagamento
coupons	array	Sempre []

Payment Method

O payment_method pode ser um dos seguintes tipos:

Campo	Tipo	Descricao
type	string	Sempre credit_card
brand	string | null	Bandeira do cartao
last_digits	null	Sempre null
expiration_month	null	Sempre null
expiration_year	null	Sempre null

Campo	Tipo	Descricao
type	string	Sempre boleto
expiration_date	integer | null	Timestamp de vencimento do boleto
digitable_line	string | null	Linha digitavel do boleto
url	string | null	URL para download do boleto

Campo	Tipo	Descricao
type	string	Sempre pix
qrcode_url	string | null	URL do QR Code PIX
qrcode_signature	string | null	EMV do QR Code PIX
expiration_date	integer | null	Timestamp de expiracao do PIX
pix_key	null	Sempre null
pix_key_type	null	Sempre null

---

Shipping

Campo	Tipo	Descricao
carrier	null	Sempre null
total_value	integer | null	Valor do frete em centavos
tracking_url	null	Sempre null
tracking_code	null	Sempre null
method	string | null	Metodo de envio
delivery_address	object	Endereco de entrega
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

Campo	Tipo	Descricao
street	string | null	Nome da rua
number	string | null	Numero
complement	string | null	Complemento
neighborhood	string | null	Bairro
city	string | null	Cidade
state	string | null	Estado (sigla)
country	null	Sempre null
postal_code	string | null	CEP

---

Product

Campo	Tipo	Descricao
id	string | null	ID ou SKU do produto
name	string | null	Nome do produto
type	string	Sempre product
quantity	integer | null	Quantidade
unit_value	integer | null	Valor unitario em centavos
total_value	integer | null	Valor total em centavos
image_url	string | null	URL da imagem
offer_type	string	Sempre main

---

LeadTracking

Campo	Tipo	Descricao
src	null	Sempre null
sck	null	Sempre null
utm_source	string | null	UTM Fonte
utm_campaign	string | null	UTM Campanha
utm_medium	string | null	UTM Midia
utm_content	string | null	UTM Conteudo
utm_term	string | null	UTM Termo
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

---

Voltar para visao geral da integracao