Última modificação: julho 6, 2023

Lista de Campos do Hotmart

NOME DO CAMPO NOME NA INTERFACE TIPO DESCRIÇÃO
Sales Comissions Date (Experimental) - string -
Account Name - string -
Subscriptions Price - string -
Subscriptions Accession Date - string Mostra a data de início da assinatura. Se nenhum valor for informado, a data atual menos 30 dias será considerada. A data deve estar em milissegundos, de 1970-01-01 00:00:00 UTC.
Subscriptions End Accession Date - string Data em que o assinante solicitou o cancelamento da assinatura. A data deve estar em milissegundos, de 1970-01-01 00:00:00 UTC.
Subscriptions Request Date - string Assinaturas canceladas a partir desta data. Se nenhum valor for informado, a data atual menos 30 dias será considerada. A data deve estar em milissegundos, de 1970-01-01 00:00:00 UTC.
Subscriptions Plan - string Mostra o nome do plano em que o assinante se inscreveu. Esse atributo pode receber vários valores, apenas pelo usuário repetindo sua chave na solicitação com valores diferentes.
Subscriptions Product ID - string Mostra o ID (um número de 7 dígitos) do seu produto de assinatura.
Subscriptions Product Name - string Nome do módulo escolhido pelo produtor no clube.
Subscriptions Product UCode - string -
Subscriptions Currency Code - string -
Subscriptions Subscriber Name - string -
Subscriptions Subscriber Email - string Mostra o email de um assinante.
Subscriptions Subscriber UCode - string -
Subscriptions Subscriber Code - string Mostra o código exclusivo de um assinante, que pode nem ser a mesma pessoa que fez a compra de assinatura.
Subscriptions ID - string Identificador exclusivo do plano de assinatura.
Subscriptions Status - string Mostra o status do momento em que essa assinatura é encontrada. Esses status podem ser: ativo, inativo, atrasado, cancelado_by_customer, cancelled_by_seller, cancelled_by_admin, iniciado ou vencido.
Subscriptions Trial - string Mostra se a assinatura que você vai buscar tem um período de teste ou não. Algumas assinaturas podem ter um período de teste no início.
Subscriptions Purchases Price - string Mostra os dados de preço.
Subscriptions Purchases Recurrency Number - string Mostra o número de recorrência correspondente.
Subscriptions Purchases Approved Date - string Mostra o dia em que o pedido foi aprovado.
Subscriptions Purchases Payment Engine - string Mostra a plataforma de pagamento. Por exemplo, se foi feito usando o Hotpay ou o Hotpay International.
Subscriptions Purchases Payment Method - string Método de pagamento da compra. The possible values ​​for this field are: BACS_DIRECT_DEBIT, BALOTO, BANK_DEBIT, BILLET, CREDIT_CARD_AMERICAN_EXPRESS, CREDIT_CARD_AURA, CREDIT_CARD_DINERS, CREDIT_CARD_DISCOVER, CREDIT_CARD_ELO, CREDIT_CARD_HIPERCARD, CREDIT_CARD_MASTERCARD, CREDIT_CARD_VISA, CUPON_DE_PAGO, DIRECT_BANK_TRANSFER_ADYEN_SOFORT, FINANCED_BILLET, FINANCED_INSTALLMENT_ADYEN_ONEY, FINANCED_INSTALLMENT_ADYEN_ONEY_10X, FINANCED_INSTALLMENT_ADYEN_ONEY_12X, FINANCED_INSTALLMENT_ADYEN_ONEY_3X, FINANCED_INSTALLMENT_ADYEN_ONEY_4X, FINANCED_INSTALLMENT_ADYEN_ONEY_6X, Google_Pay, Hotmart, Hybrid, In_App_Purchase, Multibanco, Oxxo, Pago_efectivo, Paypal, Picpay, Pix, Samsung_pay, Sepa_direct_debit, Bank_transfer_bb, Bank_transfer_bradesco, Bank_Transfer,
Subscriptions Purchases Payment Type - string Tipo de pagamento usado pelo comprador para fazer a compra. Os valores possíveis para este campo são: Billet, Cash_Payment, Credit_Card, Direct_Bank_Transfer, Direct_debit, Financiado_billet, Financiado_installment, Google_Pay, Hotcard, Hybrid, Manual_transfer, PayPal, PayPal_international.
Subscriptions Purchases Currency Code - string -
Subscriptions Purchases Subscription - string Mostra se a compra se referir a um produto de assinatura.
Subscriptions Purchases Status - string Mostra o status do momento em que essa assinatura é encontrada. Esses status podem ser: ativo, inativo, atrasado, cancelado_by_customer, cancelled_by_seller, cancelled_by_admin, iniciado ou vencido.
Subscriptions Purchases Transaction - string Identificador de referência exclusivo para uma transação, por exemplo, HP17715690036014. Uma transação acontece quando um pedido é feito. Um pedido pode ser um bilhete gerado, uma compra aprovada, uma recorrência de compra e muito mais.
Subscriptions Purchases Under Warranty - string Mostra se a transação estiver dentro do período de garantia.
Sales History Hotmart Fee Total - string Informações sobre taxas cobradas por Hotmart.
Sales History Hotmart Fee Fixed - string Taxa fixa cobrada pela Hotmart em todas as transações.
Sales History Hotmat Fee Base - string Valor base usado para cálculo da taxa Hotmart.
Sales History Installments Number - string Número total de parcelas, no caso de uma compra parcelada em BRL, MXN ou COP.
Sales History Price - string Mostra os dados de preço.
Sales History Recurrency Number - string Mostra o número de recorrência correspondente.
Sales History Approved Date - string Mostra o dia em que o pedido foi aprovado.
Sales History Order Date - string Aqui, o filtro será aplicado para assinaturas com a data da tentativa do próximo pagamento até esta data. Se nenhum valor for informado, a data atual será considerada. A data deve estar em milissegundos, de 1970-01-01 00:00:00 UTC.
Sales History Warranty Expire Date - string Assinaturas canceladas até esta data. Se nenhum valor for informado, a data atual será considerada. A data deve estar em milissegundos, de 1970-01-01 00:00:00 UTC.
Sales History Product ID - string Identificador único (ID) do produto vendido (número de 7 dígitos).
Sales History Product Name - string Nome do produto.
Sales History Buyer Email - string Endereço de e -mail do comprador. Você pode usar essas informações para pesquisar compras específicas.
Sales History Buyer Name - string Nome do comprador.
Sales History Buyer UCode - string ID exclusiva do comprador.
Sales History Producer Name - string Retorna informações sobre o Criador.
Sales History Producer UCode - string ID exclusiva do comprador.
Sales History Hotmart Fee Currency Code - string Moeda referente aos valores das tarifas, no padrão internacional de três letras. Por exemplo: BRL, USD, EUR, MXN e mais.
Sales History Subscription - string -
Sales History Currency Code - string Moeda da taxa, no padrão internacional de três letras. Por exemplo: BRL, USD, EUR, MXN, etc.
Sales History Payment Method - string Informação de pagamento.
Sales History Payment Type - string Tipo de pagamento usado pelo comprador para fazer a compra. Os valores possíveis para este campo são: Billet, Cash_Payment, Credit_Card, Direct_Bank_Transfer, Direct_debit, Financiado_billet, Financiado_installment, Google_Pay, Hotcard, Hybrid, Manual_transfer, PayPal, PayPal_international.
Sales History Tracking Source SCK - string -
Sales History Tracking Source - string Código SRC usado no link na página de pagamento do produto para rastrear a origem.
Sales History External Code - string -
Sales History Offer Payment Mode - string -
Sales History Offer Code - string Código da oferta do produto vendido.
Sales History Transaction Status - string Mostra o status de compra. Os valores possíveis para este campo são: APPROVED, BLOCKED, CANCELLED, CHARGEBACK, COMPLETE, EXPIRED, NO_FUNDS, OVERDUE, PARTIALLY_REFUNDED, PRE_ORDER, PRINTED_BILLET, PROCESSING_TRANSACTION, PROTESTED, REFUNDED, STARTED, UNDER_ANALISYS ou WAITING_PAYMENT. A descrição de cada status pode ser encontrado na página de suporte da Hotmart.
Sales History Transaction - string Identificador de referência exclusivo para uma transação, por exemplo, HP17715690036014. Uma transação acontece quando um pedido é feito. Um pedido pode ser um bilhete gerado, uma compra aprovada, uma recorrência de compra e muito mais.
Sales Participants Product ID - string Mostra o ID (um número de 7 dígitos) do seu produto de assinatura.
Sales Participants Product Name - string Informação do produto.
Sales Participants Transaction - string Código único de referência para um transação, por exemplo HP17715690036014. Uma transação acontece quando um pedido é efetuado. Um pedido pode ser um boleto gerado, uma compra aprovada, uma recorrência de compra e mais.
Sales Participants Role - string Exibe o papel do aluno. Essas funções podem ser: aluno, free_student, proprietário, administrador, content_editor ou moderador.
Sales Participants Address - string -
Sales Participants City - string -
Sales Participants Address Complement - string -
Sales Participants Country - string -
Sales Participants Neighborhood - string -
Sales Participants Address Number - string -
Sales Participants State - string -
Sales Participants ZIP Code - string -
Sales Participants Cellphone - string -
Sales Participants Documents Type - string -
Sales Participants Documents Value - number -
Sales Participants Email - string -
Sales Participants Locale - string Idioma em que o usuário fez a compra ou o idioma usado para importar o usuário.
Sales Participants Name - string Nome da afiliada responsável pela venda (quando a venda é feita por um afiliado do seu produto).
Sales Participants Phone - string -
Sales Participants Trade Name - string -
Sales Participants UCode - string -
Sales Comissions Value - number -
Sales Comissions Exchange Rate Currency Payout - string -
Sales Comissions Transaction - string -
Sales Comissions Product Name - string -
Sales Comissions Product ID - string -
Sales Comissions Currency Value - number -
Sales Comissions User UCode - string -
Sales Comissions User Name - string -
Sales Comissions Source - string Como o usuário da conta recebeu comissão para a venda. Os possíveis valores para este campo são: produtor, coprodutor, afiliado.
Sales Prices Base Value - number -
Sales Prices Coupon Value - number -
Sales Prices Fee Value - number -
Sales Prices Real Conversion Rate - string -
Sales Prices Total Value - number -
Sales Prices VAT Value - number -
Sales Prices Base Currency Code - string Moeda referente aos valores no padrão internacional de três letras. Por exemplo: BRL, USD, EUR, MXN e mais.
Sales Prices Coupon Code - string -
Sales Prices Fee Currency Code - string Moeda referente aos valores no padrão internacional de três letras. Por exemplo: BRL, USD, EUR, MXN e mais.
Sales Prices Product ID - string -
Sales Prices Product Name - string -
Sales Prices Total Currency Code - string Moeda referente aos valores no padrão internacional de três letras. Por exemplo: BRL, USD, EUR, MXN e mais.
Sales Prices Transaction - string -
Sales Prices VAT Currency Code - string Moeda referente aos valores no padrão internacional de três letras. Por exemplo: BRL, USD, EUR, MXN e mais.
Sales Prices Transaction Status - string Mostra o status de compra. Os valores possíveis para este campo são: APPROVED, BLOCKED, CANCELLED, CHARGEBACK, COMPLETE, EXPIRED, NO_FUNDS, OVERDUE, PARTIALLY_REFUNDED, PRE_ORDER, PRINTED_BILLET, PROCESSING_TRANSACTION, PROTESTED, REFUNDED, STARTED, UNDER_ANALISYS ou WAITING_PAYMENT. A descrição de cada status pode ser encontrado na página de suporte da Hotmart.
Modules Sequence - string Ordem seqüencial na qual o módulo será exibido para os alunos.
Modules Total Pages - string Indica o número total de páginas relacionadas ao módulo.
Modules Classes - string Uma matriz contendo objetos com os detalhes de cada venda.
Modules Is Extra - string Parâmetro para indicar se os módulos extras devem ser retornados. O valor true significa que os módulos extras serão retornados, false significa que apenas os módulos principais serão retornados. Se o parâmetro não for fornecido, o valor padrão será falso.
Modules Is Extra Paid - string Indica se o módulo extra é um módulo pago ou um módulo gratuito. O valor verdadeiro significa que é pago, falso que é gratuito.
Modules Is Public - string Indica se o módulo é gratuito. Módulos gratuitos são disponibilizados para pessoas que ainda não compraram seu curso. O valor verdadeiro significa que é gratuito, falso significa não gratuito.
Modules ID - string ID exclusiva relacionada ao módulo.
Modules Name - string -
Modules Pages Days of Duration - string Duração da página em dias. Indica quantos dias a página estará disponível para os alunos.
Modules Pages Liberation Days - string -
Modules Pages Order - string Ordem seqüencial da página no módulo.
Modules Pages Average Rate - string Classificação média dos usuários na página.
Modules Pages Rate - string Classificações médias detalhadas.
Modules Pages Total Rate - string -
Modules Pages Total Comments - string Comentários totais na página.
Modules Pages Liberation Date - string -
Modules Pages Has Duration - string Indica se a página tem uma duração definida. O valor verdadeiro significa sim, e falso significa não.
Modules Pages Has Media - string Indicador se a página tem mídia relacionada. Quando é verdade, a página possui mídia relacionada e, se for falsa, a página não possui nenhum conteúdo de mídia relacionado.
Modules Pages Is Published - string Indica se a página é publicada para os usuários. O valor verdadeiro significa sim, false significa não.
Modules Pages Liberation Type - string Exibe o tipo de liberação da página, se houver. Esses tipos podem ser: by_days ou by_date. As páginas já disponíveis para os alunos não terão esse campo.
Modules Pages Name - string -
Modules Pages ID - string ID de página exclusiva.
Modules Pages Type - string Exibe o tipo de página. Esses tipos podem ser: conteúdo, anúncio, teste ou webinar.
Students Access Count - string Número de acessos à área de membros.
Students Progress Completed - string -
Students Progress Percentage - string -
Students Progress Total - string Exibe o resumo do progresso do aluno.
Students First Access - string Data de início do período do filtro. A data deve estar em milissegundos, a partir de 1970-01-01 00:00:00 UTC.
Students Last Access - string Data final do período do filtro. A data deve estar em milissegundos, a partir de 1970-01-01 00:00:00 UTC.
Students Purchase Date - string Data de compra.
Students Class ID - string Id da classe à qual o aluno está vinculado.
Students Email - string E -mail do aluno.
Students Engagement - string Engajamento dos alunos no curso. O engajamento é uma métrica que mede o quão bem seus usuários estão interagindo com o seu produto. Cada usuário tem seus próprios pontos que determinam se o envolvimento deles é: nenhum, baixo, médio, alto ou muito.
Students Is Deletable - string Indica se o aluno pode ser bloqueado ou não. O valor verdadeiro significa sim, false significa não.
Students Locale - string -
Students Name - string Nome do módulo escolhido pelo produtor no clube.
Students Pluss Access - string Exibe se o aluno tem acesso Plus. Esses tipos podem ser: sem_plus_access, titular, dependente, holder_with_dependents ou holder_without_dependents.
Students Role - string -
Students Status - string Mostra o status do momento em que essa assinatura é encontrada. Esses status podem ser: ativo, inativo, atrasado, cancelado_by_customer, cancelled_by_seller, cancelled_by_admin, iniciado ou vencido.
Students Type - string Exibe o tipo de página. Esses tipos podem ser: conteúdo, anúncio, teste ou webinar.
Students ID - string ID exclusiva do aluno no clube.
Students Lessons Completed Date - string -
Students Lessons Is Completed - string -
Students Lessons Is Module Extra - string -
Students Lessons Module Name - string -
Students Lessons Page ID - string -
Students Lessons Page Name - string -