Hotmart

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

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

    Produtos > > id

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

date_next_charge

timestamp

[pt] Data de tentativa do próximo pagamento. No caso de assinaturas canceladas, indicará a última data de acesso do assinante ao produto e, portanto, nenhuma cobrança será efetuada após este período

plan_name

text

[pt] nome do plano de assinatura

plan_id

text

[pt] id do plano de assinatura

plan_max_charge_cycles

float

[pt] Exibe a quantidade máxima de cobranças (recorrências) que serão feitas no plano de assinatura

plan_recurrency_period

text

[pt] Período de recorrência definido para o plano selecionado

subscription_id

text

[pt] identificacao da assinatura na Hotmart

price_currency_code

text

[pt] identificacao da assinatura na Hotmart

price_value

float

[pt] Preco de cada recorrencia da assinatura

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.

    Histórico das vendas > > purchase_transaction

product_id

text

[pt] Identificador unico (ID) do produto vendido (numero de 7 digitos)

    Produtos > > id

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

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

    Assinantes > > subscriber_code

transaction

text

[pt] Codigo de referencia da transacao

    Histórico das vendas > > purchase_transaction

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

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.

    Histórico das vendas > > purchase_transaction

product_id

text

[pt] Identificador unico (ID) do produto vendido (numero de 7 digitos)

    Produtos > > id

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

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

    Produtos > > id

product_name

text

[pt] Nome do produto

user_id

text

[pt] Identificador único do aluno no Club.

subdomain

text

[pt] Nome do subdomínio.

access_count

int

[pt] Número de acessos realizados na Área de Membros.

class_id

text

[pt] Identificador da turma em que o aluno está associado.

is_deletable

boolean

[pt] Indica se o aluno poderá ou não ser bloqueado. O valor true significa que sim, false que não.

progress_completed_percentage

float

[pt] Indica o percentual de páginas concluídas.

progress_completed

float

[pt] Indica número de páginas concluídas.

progress_total

float

[pt] Número total de páginas da Área de Membros.

engagement

text

[pt] Engajamento do aluno dentro do curso. O engajamento é um índice que mede o quanto os seus usuários estão interagindo de forma geral com o seu produto. Cada usuário tem os seus pontos que determinam se o engajamento dele é

locale

text

[pt] Idioma no qual o usuário realizou a compra, ou idioma que foi utilizado para importar o usuário.

first_access_date

timestamp

[pt] Data do primeiro acesso do aluno à Área de Membros, representada como timestamp em milissegundos.

purchase_date

timestamp

[pt] Data da compra do curso pelo aluno, representada como timestamp em milissegundos.

last_access_date

timestamp

[pt] Data do último acesso do aluno à Área de Membros, representada como timestamp em milissegundos.

email

text

[pt] Endereço de e-mail do aluno.

name

text

[pt] Nome completo do aluno.

role

text

[pt] Função do aluno na plataforma (ex: ALUNO, MODERATOR).

status

text

[pt] Status atual do aluno na Área de Membros.

plus_access

text

[pt] Indica se o aluno possui acesso Plus na plataforma.

type

text

[pt] Tipo do aluno no sistema (ex: IMPORTADO, CADASTRADO).

module_id

text

[pt] Identificador único do módulo.

subdomain

text

[pt] Nome do subdomínio.

name

text

[pt] Nome do módulo definido pelo produtor dentro do Club.

sequence

int

[pt] Ordenação sequencial em que o módulo será exibido para os alunos.

is_public

boolean

[pt] Indica se o módulo é gratuito. Módulos gratuitos são disponibilizados para pessoas que ainda não compraram o seu curso. O valor true significa é gratuito, false que não.

is_extra

boolean

[pt] Indica se o módulo é extra. Módulos extras são módulos com conteúdos adicionais que podem ser oferecidos para os alunos, os módulos extra podem ser gratuitos ou podem ser cobrado dos usuários que desejam ter acesso ao conteúdo adicional. O valor true significa que é um módulo extra, false que não.

is_extra_paid

boolean

[pt] Indica se o módulo extra é um módulo pago ou se é um módulo gratuito. O valor true significa que é pago, false que é gratuito.

classes

text

[pt] Mostra as aulas do módulo.

total_pages

int

[pt] Indica a quantidade total de páginas relacionadas ao módulo.

student_id

text

[pt] Identificador único do aluno no Club.

    Hotmart Club: alunos > > user_id

page_id

text

[pt] Identificador único da página.

    Hotmart Club: páginas > > page_id

subdomain

text

[pt] Nome do subdomínio.

student_email

text

[pt] Email do aluno no Club.

page_name

text

[pt] Nome da página definida pelo produtor dentro do Club.

is_module_extra

boolean

[pt] Indica se é um módulo extra. O valor true significa que sim, false que não.

is_completed

boolean

[pt] Indica se a página já foi concluída pelo aluno. O valor true significa que sim, false que não.

module_name

text

[pt] Nome do módulo definido pelo produtor no Club.

completed_date

timestamp

[pt] Data em que a página foi concluída. Esse valor só será retornado caso o parâmetro is_completed seja true.

page_id

text

[pt] Identificador único da página.

subdomain

text

[pt] Nome do subdomínio.

product_id

text

[pt] Nome do subdomínio.

    Produtos > > id

module_id

text

[pt] Identificador único do módulo.

    Hotmart Club: módulos > > module_id

name

text

[pt] Nome da página definida pelo produtor dentro do Club.

type

text

[pt] Mostra o tipo da página. Estes tipos podem ser.

page_order

text

[pt] Ordenação sequencial da página dentro do módulo.

total_comments

int

[pt] Ordenação sequencial da página dentro do módulo.

rates_average

float

[pt] Média de avaliações dos usuários na página.

published

boolean

[pt] Indica se a página está publicada para os usuários. O valor true significa que sim, false que não.

has_media

boolean

[pt] Indica se a página está publicada para os usuários. O valor true significa que sim, false que não.

page_id

text

[pt] Identificador único da página.

subdomain

text

[pt] Nome do subdomínio.

product_id

text

[pt] Nome do subdomínio.

    Produtos > > id

rates_rate

text

[pt] Nota atribuída à página em uma avaliação individual.

rates_total

text

[pt] Quantidade de usuários que atribuíram uma determinada nota à página.

page_id

text

[pt] Identificador único da página.

subdomain

text

[pt] Nome do subdomínio.

product_id

text

[pt] Nome do subdomínio.

    Produtos > > id

_dripping_configs_type

text

[pt] Identificador único da página.

_dripping_configs_liberation_date

timestamp

[pt] Data de liberação

_dripping_configs_id

text

[pt] Identificador da classe.

_dripping_configs_name

text

[pt] Nome da classe.

_dripping_configs_default_class

boolean

[pt] Indica se é a classe padrão (true) ou não (false).

id

text

[pt] Identificador único do módulo.

ucode

text

[pt] Um identificador único global (UUID) associado ao produto, usado para identificação em diferentes contextos ou integrações.

created_at

timestamp

[pt] Data e hora em que o produto foi criado na plataforma, representado como um timestamp em milissegundos desde o início da era Unix (01/01/1970).

name

text

[pt] Nome do produto conforme definido pelo usuário, neste caso, 'Palestra teste'.

status

text

[pt] Similar a situation, indica que o produto está em DRAFT (Rascunho) ou APPROVE_PRODUCT (Aprovado para publicação).

format

text

[pt] Formato do produto (ex ONLINE_COURSE, EBOOK, EVENT, ONLINE_EVENT)

is_subscription

boolean

[pt] Indica se o produto é uma assinatura

warranty_period

int

[pt] Garantia do produto

purchase_transaction

text

[pt] Código único de referência para uma transação.

    Histórico das vendas > > purchase_transaction

adoption_date

timestamp

[pt] Data de adoção da assinatura ou produto

billing_type

text

[pt] O tipo da cobrança indica se o subscriber_code trata-se de SUBSCRIPTION, SMART_INSTALLMENT ou SMART_RECOVERY.

date_next_charge

timestamp

[pt] Data da próxima cobrança

has_credit_card_change

boolean

[pt] Indica se houve mudança no cartão de crédito associado à assinatura.

has_unpaid_recurrency

text

[pt] Indica se há recorrências não pagas.

is_paid_anticipation

text

[pt] Indica se houve pagamento antecipado.

is_paid_negotiation

text

[pt] Indica se houve negociação de pagamento.

last_recurrency_number

float

[pt] Número sequencial da última recorrência.

last_recurrency_start_date

timestamp

[pt] Data de início da última recorrência

last_update

timestamp

[pt] Data da última atualização da assinatura ou compra

plan_name

text

[pt] Nome do plano de assinatura.

plan_offer_key

text

[pt] A chave de oferta é um identificador da assinatura. Isso pode mudar se o plano de assinatura mudar.

plan_recurrency_period

float

[pt] Período de recorrência do plano em dias.

plan_recurrency_type

text

[pt] Tipo de recorrência do plano, exemplo: MENSAL.

producer_name

text

[pt] Nome do produtor da assinatura ou produto.

product_id

text

[pt] Identificador único (ID) do produto vendido (número de 7 dígitos).

    Produtos > > id

product_name

text

[pt] Nome do produto vendido.

purchase_approved_date

timestamp

[pt] Data em que a compra foi aprovada

purchase_commission_conversion_rate

float

[pt] Taxa de conversão utilizada para calcular a comissão.

purchase_commission_currency

text

[pt] Moeda da comissão.

purchase_commission_original_paid_value

text

[pt] Valor da comissão que foi efetivamente pago.

purchase_commission_original_value

float

[pt] Valor original da comissão.

purchase_commission_producer_paid_value

text

[pt] Valor que o produtor recebeu efetivamente pela venda.

purchase_commission_producer_value

float

[pt] Valor que o produtor recebe pela venda.

purchase_installment_installment_number

float

[pt] Número de parcelas da compra.

purchase_installment_installment_type

text

[pt] Tipo de parcelamento, por exemplo, pagamento único.

purchase_order_date

timestamp

[pt] Data em que a ordem foi gerada

purchase_payment_credit_card_flag

text

[pt] Bandeira do cartão de crédito utilizado na compra.

purchase_payment_payment_type

text

[pt] Tipo de pagamento utilizado pela pessoa compradora para realizar a compra.

purchase_price_currency

text

[pt] Moeda utilizada na transação, por exemplo, BRL.

purchase_price_total_value

float

[pt] Valor total da compra.

purchase_price_value

float

[pt] Valor unitário da compra.

purchase_status

text

[pt] Descreve a situação de uma transação de compra.

recurrency_has_retry

boolean

[pt] Indica se houve tentativas de cobrança após falha.

recurrency_is_current_purchase

boolean

[pt] Indica se é a compra atual.

recurrency_number

float

[pt] Número sequencial da recorrência atual.

recurrency_payment_delays_days

float

[pt] Número de dias de atraso no pagamento da recorrência.

recurrency_start_datetime

timestamp

[pt] Data e hora de início da recorrência atual

recurrency_status

text

[pt] Descreve a situação atual do pagamento da recorrência de uma assinatura.

recurrency_transaction_sequence

float

[pt] Sequência da transação dentro da mesma recorrência.

recurrency_transaction_type

text

[pt] Tipo de transação, por exemplo, AUTOMÁTICA.

status

text

[pt] Status da assinatura ou tipo de cobrança.

subscriber_email

text

[pt] Email do assinante envolvido na transação.

subscriber_id

text

[pt] Identificador único do assinante.

subscriber_name

text

[pt] Nome do assinante envolvido na transação.

subscriber_phone

text

[pt] Número de telefone do assinante.

subscriber_phone_ddd

text

[pt] DDD do número de telefone do assinante.

subscriber_code

text

[pt] Identificador único do assinante

    Assinantes > > subscriber_code

subscription_id

text

[pt] Identificador único da assinatura.

trial_info_trial

boolean

[pt] Indica se a assinatura está em período de teste.

trial_info_trial_period

float

[pt] Duração do período de teste em dias.