Hotmart - Order

Eventos da família order.* na integração Hotmart.

Veja também Estrutura geral dos eventos Order para referência completa.

Eventos Disponíveis

• order.waiting_payment
• order.paid
• order.finalized
• order.refunded
• order.disputed
• order.expired
• order.canceled

Estrutura do Payload

{
  "customer": {
    "id": null,
    "name": "João Silva",
    "email": "[email protected]",
    "document": "12345678900",
    "phone_numbers": [
      {
        "formatted_phone": "+5511999999999",
        "type": null,
        "raw_number": "11999999999",
        "area_code": "11",
        "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"
    }
  },
  "order": {
    "id": "ABC123456",
    "status": "paid",
    "raw_status": "APPROVED",
    "created_at": 1705319000,
    "paid_at": 1705319100,
    "updated_at": null,
    "warranty_until": 1707911000,
    "canceled_at": null,
    "refunded_at": null
  },
  "checkout": {
    "id": null,
    "url": null
  },
  "payment": {
    "currency": "BRL",
    "total": 29990,
    "discount_value": null,
    "shipping_value": null,
    "total_products_value": 29990,
    "payment_method": {
      "type": "credit_card",
      "brand": null,
      "last_digits": null,
      "expiration_month": null,
      "expiration_year": null
    },
    "coupons": []
  },
  "shipping": {
    "carrier": null,
    "total_value": null,
    "tracking_code": null,
    "method": null,
    "delivery_address": {
      "street": "Rua Principal",
      "number": "123",
      "complement": "Apto 45",
      "city": "São Paulo",
      "state": "SP",
      "postal_code": "01000-000"
    },
    "estimated_delivery_date": null,
    "estimated_delivery_time_in_days": null,
    "status": null,
    "raw_status": null
  },
  "products": [
    {
      "id": "prod_789",
      "name": "Curso Online",
      "type": "product",
      "offer_type": "main",
      "quantity": 1,
      "unit_value": 29990,
      "total_value": 29990,
      "image_url": null
    }
  ],
  "lead_tracking": {
    "src": "facebook",
    "sck": "campaign123",
    "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

Informações do cliente.

Campo	Tipo	Descricao
id	null	Sempre null - Hotmart nao fornece 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	Colecao de telefones do cliente
address	Address	Endereco do cliente

Address

Endereco do cliente.

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

Phone

Telefone do cliente. Hotmart pode enviar ate dois telefones (phone_number e phone_checkout_number).

Campo	Tipo	Descrição
formatted_phone	string | null	Telefone formatado em E.164
type	null	Sempre null
raw_number	string | null	Número sem formatação
area_code	string | null	Código de área (DDD)
international_dialing_code	null	Sempre null

---

Order

Dados do pedido.

Campo	Tipo	Descrição
id	string | null	ID da transação na Hotmart
status	string	Status normalizado
raw_status	string | null	Status original da Hotmart
created_at	integer | null	Timestamp de criação
paid_at	integer | null	Timestamp do pagamento
updated_at	null	Sempre null - Não fornecido pela Hotmart
warranty_until	integer | null	Timestamp de expiração da garantia
canceled_at	null	Sempre null - Não fornecido pela Hotmart
refunded_at	null	Sempre null - Não fornecido pela Hotmart

Status Normalizados (OrderStatus)

A Hotmart retorna os seguintes valores normalizados para o status do pedido:

Valor	Descrição
waiting_payment	Aguardando pagamento
paid	Pago
finalized	Finalizado
refunded	Reembolsado
disputed	Em disputa
expired	Expirado
canceled	Cancelado

---

Checkout

Informações do checkout.

Informações do checkout.

Campo	Tipo	Descrição
id	null	Sempre null
url	null	Sempre null

---

Payment

Dados financeiros.

Campo	Tipo	Descrição
currency	string | null	Moeda em formato ISO 4217
total	integer | null	Valor total em centavos
discount_value	null	Sempre null
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 vazio (não suportado)

---

Shipping

Informações de envio.

Informações de envio. Como a Hotmart é focada em produtos digitais, a maioria dos campos será null.

Campo	Tipo	Descrição
carrier	null	Sempre null
total_value	null	Sempre null
tracking_code	null	Sempre null
method	null	Sempre null
delivery_address	object	Endereço 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

Endereço de entrega.

Campo	Tipo	Descrição
street	string | null	Logradouro
number	string | null	Número
complement	string | null	Complemento
city	string | null	Cidade
state	string | null	Estado/UF
postal_code	string | null	CEP

---

Product

Produtos incluídos no pedido (array).

Campo	Tipo	Descrição
id	string | null	ID do produto
name	string | null	Nome do produto
type	string	Tipo: product
offer_type	string	Tipo de oferta: main, order_bump
quantity	integer | null	Quantidade
unit_value	integer | null	Valor unitário em centavos
total_value	integer | null	Valor total em centavos
image_url	string | null	URL da imagem

---

LeadTracking

Dados de rastreamento de marketing.

Campo	Tipo	Descrição
src	string | null	Fonte genérica
sck	string | null	Código de rastreamento interno
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

---

Métodos de Pagamento

Veja Métodos de Pagamento.

---

Voltar para visão geral da integração