Hotmart

Hotmart is a platform specialized in the distribution of digital products, which connects producers to affiliates. Explaining a little better: Content producers at Hotmart are the people who create classes, videos, or any product that can be sold digitally. Affiliates are the people who will sell these products.

Among the types of products that can be created on the platform are E-books, video classes, lectures, screencasts, software, scripts or any type of file that can be downloaded over the internet.

Adding the data source

To integrate Hotmart buyers, subscriptions and product data into your database,;

add the data source on the Kondado platform following the tutorial below:

Follow the steps bellow with the user "master"/principal of the account, as other collaborators may not have the necessary permissions

1) Log in to your Hotmart account and, on the right side of the menu, click on Tools

2) On the tools page, (1) select “For Producer”, search for “credentials” and (2) select the option “Hotmart Credentials”

If you cannot find the credentials option, you can access them directly through this link:

3) On the credentials page click on “Create credential”

4) In the popup that will open, check the “Hotmart API” option, name your credential (for example “kondado”) and click on “Create credential”

5) After clicking on “Create credential”, locate your credential in the list and expand the parameters – we will use them in the next steps

6) Login to Kondado platform

7) On the Kondado platform, go to add data sources section and select the Hotmart data source

8) On the Hotmart data source addition page, fill in the information with the values obtained in step (5) as shown below:

Name: The internal description of the data source, for example: “Hotmart Affiliates”

Client ID: Value obtained in step 5 (just click copy)

Client Secret: Value obtained in step 5 (just click copy)

Basic: Value obtained in step 5 (just click copy)

Now just click SAVE to access your hotmart data in your data warehouse or data lake

Pipelines

Relationship Chart

Gráfico de relacionamento entre tabelas

Sales History

Field	Type
purchase_transaction	text	[pt] Mostra o codigo unico de referencia para um transacao, por exemplo HP17715690036014. Uma transacao acontece quando um pedido e efetuado. Um pedido pode ser um boleto gerado, uma compra aprovada, uma recorrencia de compra e mais.
purchase_approved_date	timestamp	[pt] Data em que o pedido foi aprovado
purchase_commission_as	text
purchase_hotmart_fee_base	float	[pt] Valor base utilizado para a cobranca da taxa da Hotmart
purchase_hotmart_fee_total	float	[pt] Taxa total cobrada pela Hotmart sobre a transacao
purchase_hotmart_fee_currency_code	text	[pt] Moeda referente aos valores das tarifas, no padrao internacional de tres letras. Por exemplo: BRL, USD, EUR, MXN e mais
purchase_hotmart_fee_fixed	float	[pt] Taxa fixa cobrada pelo Hotmart sobre toda transacao
purchase_is_subscription	boolean
purchase_offer_code	text	[pt] Codigo identificador da oferta
purchase_offer_payment_mode	text	[pt] Modo de pagamento. Os valores possiveis para este campo sao: UNIQUE_PAYMENT, SUBSCRITPION, MULTIPLE_PAYMENTS, PAY_IN_FULL, NOT_DEFINED, INVOICE, SMART_INSTALLMENT
purchase_order_date	timestamp	[pt] Data em que o pedido foi realizado
purchase_payment_method	text	[pt] Metodo de pagamento da compra. Os valores possiveis para este campo sao: BILLET, PAYPAL, BANK_TRANSFER_BB, BANK_TRANSFER_BRADESCO, BANK_TRANSFER_ITAU, CREDIT_CARD, CREDIT_CARD_MASTERCARD, CREDIT_CARD_AMERICAN_EXPRESS, CREDIT_CARD_AURA, CREDIT_CARD_DINERS, CREDIT_CARD_HIPERCARD, CREDIT_CARD_ELO, HOTMART, BANK_DEBIT, CREDIT_CARD_DISCOVER, SEPA_DIRECT_DEBIT, MULTIBANCO, GOOGLE_PAY, BALOTO, OXXO, CUPON_DE_PAGO, SAMSUNG_PAY, PAGO_EFECTIVO, BACS_DIRECT_DEBIT, PICPAY, FINANCED_INSTALLMENT_ADYEN_ONEY, DIRECT_BANK_TRANSFER_ADYEN_SOFORT, FINANCED_INSTALLMENT_ADYEN_ONEY_3X, FINANCED_INSTALLMENT_ADYEN_ONEY_4X, FINANCED_INSTALLMENT_ADYEN_ONEY_6X, FINANCED_INSTALLMENT_ADYEN_ONEY_10X, FINANCED_INSTALLMENT_ADYEN_ONEY_12X, PIX
purchase_payment_type	text	[pt] Tipo de pagamento da compra, que pode ser: BILLET, CREDIT_CARD, PAYPAL, BANK_DEBT, HOTMART_BALANCE, CASH_PAYMENT, PIX, SAMSUNG_PAY ou GOOGLE_PAY
purchase_payment_installments_number	float	[pt] Número total de parcelas, no caso de uma compra parcelada em BRL, MXN ou COP
purchase_price_currency_code	text	[pt] Moeda referente ao valor base, no padrao internacional de tres letras. Por exemplo: BRL, USD, EUR, MXN e mais
purchase_price_value	float	[pt] Valor total pago pelo comprador, incluindo taxas e juros
purchase_recurrency_number	float	[pt] Numero da recorrencia correspondente para compras parceledas no cartao ou via Parcelamento Inteligente.
purchase_status	text	[pt] Mostra o status de compra, que pode ser: STARTED , PROCESSING_TRANSACTION , COMPLETE , PRINTED_BILLET , WAITING_PAYMENT , APPROVED , UNDER_ANALISYS , CANCELLED , PROTESTED , REFUNDED , CHARGEBACK , BLOCKED , OVERDUE , PRE_ORDER , NO_FUNDS ou EXPIRED. A descricao de cada status pode ser encontrado na pagina do suporte do Hotmart
purchase_tracking_source_sck	text	[pt] Codigo de rastreamento que o produtor cadastra pra saber a origem da venda. Esse codigo e exclusivo do produtor e funciona para identificar uma pagina de checkout
purchase_tracking_source	text	[pt] Codigo de rastreamento referente ao campo src que o vendedor cadastra pra saber a origem da venda
purchase_tracking_external_code	text	[pt] Codigo de rastreamento referente ao campo xcod passado como parametro na URL da pagina de checkout
purchase_warranty_expire_date	timestamp	[pt] Data de vencimento da garantia. o periodo no qual o comprador pode solicitar o reembolso do pedido.
buyer_name	text	[pt] Nome do comprador
buyer_ucode	text	[pt] Identificador nico do comprador
buyer_email	text	[pt] E-mail da pessoa compradora. Você pode utilizar este dado para buscar compras de pessoas específicas
producer_name	text	[pt] Nome do produtor
producer_ucode	text	[pt] Identificador unico do produtor
product_id	text	[pt] Identificador unico (ID) do produto vendido
product_name	text	[pt] Nome do produto

Sales Commissions

Field	Type
transaction	text	[pt] Mostra o codigo unico de referencia para um transacao, por exemplo HP17715690036014. Uma transacao acontece quando um pedido e efetuado. Um pedido pode ser um boleto gerado, uma compra aprovada, uma recorrencia de compra e mais.
product_id	text	[pt] Identificador unico (ID) do produto vendido (numero de 7 digitos)
product_name	text	[pt] Nome do produto
exchange_rate_currency_payout	float	[pt] Taxa de conversao utilizada para converter o valor de compra sem impostos no valor bruto da comissao (ainda sem divisao entre as partes envolvidas) em sua respectiva moeda. Quando nao acontece conversao, o valor retornado nesse campo e 1
source	text	[pt] Indica qual a fonte da comissao, podendo ser um dos seguintes valores: PRODUCER, COPRODUCER, AFFILIATE ou ADDON
user_name	text	[pt] Nome do participante da comissao
user_ucode	text	[pt] Identificador unico do participante da comissao
commission_currency_code	text	[pt] Moeda utilizada para comissionamento, no padrao internacional de tres letras. Por exemplo: BRL, USD, EUR, MXN e mais
commission_value	float	[pt] Valor da comissao

Breakdown of Sales Price

Field	Type
transaction	text	[pt] Mostra o codigo unico de referencia para um transacao, por exemplo HP17715690036014. Uma transacao acontece quando um pedido e efetuado. Um pedido pode ser um boleto gerado, uma compra aprovada, uma recorrencia de compra e mais.
product_id	text	[pt] Identificador unico (ID) do produto vendido (numero de 7 digitos)
product_name	text	[pt] Nome do produto
real_conversion_rate	float	[pt] Taxa de conversao utilizada para converter o valor original da oferta no valor a ser pago pela pessoa compradora em sua moeda local
total_currency_code	text	[pt] Moeda referente ao valor total, no padrao internacional de tres letras. Por exemplo: BRL, USD, EUR, MXN e mais
total_value	float	[pt] Composicao dos valores base, VAT e juros. O valor vat somente sera cobrado caso a venda seja realizada em territorio europeu e mexicano
fee_currency_code	text	[pt] Moeda referente aos juros, no padrao internacional de tres letras. Por exemplo: BRL, USD, EUR, MXN e mais
fee_value	float	[pt] Valor de juros que sera cobrado em uma compra parcelada em BRL ou MXN. Este valor pode ser pago pelo produtor ou pelo comprador, dependendo da configuracao de venda do produto
vat_currency_code	text	[pt] Moeda referente ao VAT, no padrao internacional de tres letras. Por exemplo: BRL, USD, EUR, MXN e mais
vat_value	float	[pt] VAT (Value Added Tax) representa o imposto sobre o valor agregado do produto
base_currency_code	text	[pt] Moeda referente ao valor base, no padrao internacional de tres letras. Por exemplo: BRL, USD, EUR, MXN e mais
base_value	float	[pt] Utilizado para a divisao de comissionamento entre produtores, afiliados e coprodutores. Alem disso, e dele retirado as taxas dos addons
coupon_code	text	[pt] Codigo identificador de um cupom
coupon_value	float	[pt] Caso tenha sido aplicado cupom de desconto, representa a porcentagem de desconto do cupom aplicado sobre o valor do produto. Seu valor esta entre 0 e 1

Subscriptions

Field	Type
subscribercode	text	[pt] Traz o codigo daquele assinante. Este campo e usado pelo sistema externo para identificar um assinante de uma assinatura. Um mesmo comprador tera 2 subscribersCode diferentes se ele assinar dois produtos diferentes
subscriber_ucode	text	[pt] Mostra a identificacao externa do assinante. E o que você vai usar em seu sistema para identificar seu produto
subscriber_name	text	[pt] Mostra o nome do assinante
subscriber_email	text	[pt] Mostra o email do assinante
status	text	[pt] Mostra os status do momento em que aquela assinatura se encontra. Estes status podem ser: ACTIVE, INACTIVE, DELAYED, CANCELLED_BY_CUSTOMER, CANCELLED_BY_SELLER, CANCELLED_BY_ADMIN, STARTED ou OVERDUE
trial	boolean	[pt] Indica se assinatura tem ou teve um periodo de teste. O valor 'true' significa que sim, 'false' que nao
product_ucode	text	[pt] Identificacao externa de um produto. E o que você vai usar em seu sistema para identificar seu produto
product_id	text	[pt] ID do produto
product__name	text	[pt] Nome do produto
request_date	timestamp	[pt] data da criacao da assinatura
accession_date	timestamp	[pt] data inicial de liberacao para acesso ao conteudo da assinatura
plan_name	text	[pt] nome do plano de assinatura
subscription_id	text	[pt] identificacao da assinatura na Hotmart
price_currencycode	text	[pt] identificacao da assinatura na Hotmart
price_value	float	[pt] Preco de cada recorrencia da assinatura

Subscriber Purchases

Field	Type
transaction	text	[pt] Codigo de referencia da transacao
subscriber_code	text	[pt] Traz o codigo daquele assinante. Este campo e usado pelo sistema externo para identificar um assinante de uma assinatura. Um mesmo comprador tera 2 subscribersCode diferentes se ele assinar dois produtos diferentes
payment_engine	text	[pt] Plataforma de pagamento. Por exemplo, se foi feito usando HotPay ou HotPay Internacional
payment_method	text	[pt] Mostra o metodo de pagamento, que pode ser: BILLET, PAYPAL, BANCO_BRASIL_ONLINE_TRANSFER, BRADESCO_ONLINE_TRANSFER, ITAU_ONLINE_TRANSFER, VISA_CREDIT_CARD, MASTERCARD_CREDIT_CARD, AMERICAN_EXPRESS_CREDIT_CARD, AURA_CREDIT_CARD, DINERS_CREDIT_CARD, HIPERCARD_CREDIT_CARD, ELO_CREDIT_CARD, HOTMART, BANK_DEBT, DISCOVER_CREDIT_CARD, SEPA_DIRECT_DEBT ou MULTIBANK
payment_type	text	[pt] Tipo de pagamento, que sao: BILLET, CREDIT_CARD, PAYPAL, BANK_DEBT, HOTMART_BALANCE, CASH_PAYMENT, SAMSUNG_PAY e GOOGLE_PAY
price_currency_code	text	[pt] Qual moeda foi usada, no padrão internacional de três letras. Por exemplo: BRL, USD, EUR, MXN, etc...
price_value	float	[pt] Valor da transacao
recurrency_number	float	[pt] Mostra o numero da recorrencia correspondente
status	text	[pt] Status de compra, que pode ser: STARTED, PROCESSING_TRANSACTION, COMPLETE, PRINTED_BILLET, WAITING_PAYMENT, APPROVED, UNDER_ANALISYS, CANCELLED, PROTESTED, REFUNDED, CHARGEBACK, BLOCKED, OVERDUE, PRE_ORDER, NO_FUNDS ou EXPIRED
under_warranty	boolean	[pt] Se a transacao esta dentro do prazo de garantia