# Estrutura dos dados

Nesta página estão todos os dados que enviamos nos payloads. Nas subpaginas no menu lateral, há a separação entre "seções" do payload para simplificar.

As informações são as mesmas, porém nas seções específicas há mais detalhamento.

{% hint style="info" %}
Os order bumps são enviados junto com o checkout principal (Entrada, Upsell ou Downsell). Fica dentro do objeto `data.offer.order_bumps`
{% endhint %}

### Tabela completa dos dados enviados

<table data-full-width="true"><thead><tr><th>Nome</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>event</td><td>string</td><td>Nome do evento</td></tr><tr><td>data.offer.id</td><td>UUID</td><td>Id da oferta criada na Assiny</td></tr><tr><td>data.offer.name</td><td>string</td><td>Nome da oferta criada na Assiny</td></tr><tr><td>data.offer.type</td><td>string</td><td>Tipo da oferta na Assiny (ENTRY, UPSELL, DOWNSELL)</td></tr><tr><td>data.offer.recurrence</td><td>string</td><td>Recorrencia em caso de oferta do tipo assinatura. Caso não seja uma assinatura, retornará "null"</td></tr><tr><td>data.offer.amount</td><td>integer</td><td>Valor da oferta configurado na Assiny</td></tr><tr><td>data.offer.amount_client</td><td>integer</td><td>É o valor que foi para o produtor/vendedor</td></tr><tr><td>data.offer.amount_assiny</td><td>integer</td><td>Valor da taxa da Assiny</td></tr><tr><td>data.offer.amount_with_tax</td><td>integer</td><td>Valor da oferta com juros</td></tr><tr><td>data.offer.product.id</td><td>string</td><td>Id do produto na Assiny</td></tr><tr><td>data.offer.product.name</td><td>string</td><td>Nome do produto na Assiny</td></tr><tr><td>data.offer.product.producer_name</td><td>string</td><td>Nome do produtor cadastrado no produto na Assiny</td></tr><tr><td>data.offer.order_bumps</td><td>array</td><td>Conjunto de produtos de orderbumps desta transação. Possui os mesmos campos do "offer"</td></tr><tr><td>data.transaction.id</td><td>UUID</td><td>Id da transação na Assiny</td></tr><tr><td>data.transaction.project.name</td><td>string</td><td>Nome do seu projeto na Assiny em que aconteceu a transação em questão</td></tr><tr><td>data.transaction.project.id</td><td>UUID</td><td>Id do seu projeto na Assiny em que aconteceu a transação em questão</td></tr><tr><td>data.transaction.project.organization.id</td><td>UUID</td><td>Id da sua organização na Assiny que é dona do projeto em questão</td></tr><tr><td>data.transaction.project.organization.name</td><td>string</td><td>Nome da sua organização na Assiny que é dona do projeto em questão</td></tr><tr><td>data.transaction.amount</td><td>integer</td><td>Soma dos amounts de todos os produtos na transação (produto principal + orderbumps)</td></tr><tr><td>data.transaction.fee_amount</td><td>integer</td><td>Valor da taxa da Assiny cobrada na transação</td></tr><tr><td>data.transaction.net_amount</td><td>integer</td><td>Valor líquido da transação</td></tr><tr><td>data.transaction.commissions</td><td>Array</td><td>Produtores que receberam valores da transação. Quando há uma co-produção, há mais de um item.</td></tr><tr><td>data.transaction.installments</td><td>integer</td><td>Número de parcelas da transação. Em casos à vista o valor vem 1</td></tr><tr><td>data.transaction.currency</td><td>string</td><td>Moeda em que a transação foi feita. Segue o padrão ISO 4217.</td></tr><tr><td>data.transaction.cycle</td><td>integer</td><td>Qual o ciclo da assinatura a transação se refere. Quando não for assinatura retorna 1</td></tr><tr><td>data.transaction.created_at</td><td>string</td><td>Data de criação da transação</td></tr><tr><td>data.transaction.updated_at</td><td>string</td><td>Data da última atualização da transação.</td></tr><tr><td>data.transaction.status</td><td>string</td><td>Status da transação.</td></tr><tr><td>data.transaction.payment_type</td><td>string</td><td>Tipo de pagamento na transação. Ex.: PIX, CREDIT_CARD, BANK_SLIP</td></tr><tr><td>data.transaction.smart_installments</td><td>Object</td><td>Informações relativa ao parcelamento inteligente. Caso null, não se aplica.</td></tr><tr><td>data.transaction.additional_data.PIX</td><td>string</td><td>Código copia cola para pagamento do PIX</td></tr><tr><td>data.transaction.additional_data.BANK_SLIP.url</td><td>string</td><td>Link de download do PDF do boleto</td></tr><tr><td>data.transaction.additional_data.BANK_SLIP.barcode</td><td>string</td><td>Código de barras do boleto</td></tr><tr><td>data.client.id</td><td>UUID</td><td>Id do cliente na Assiny</td></tr><tr><td>data.client.full_name</td><td>string</td><td>Nome completo do cliente</td></tr><tr><td>data.client.first_name</td><td>string</td><td>Primeiro nome do cliente</td></tr><tr><td>data.client.last_name</td><td>string</td><td>Último nome do cliente</td></tr><tr><td>data.client.email</td><td>string</td><td>Email do cliente usado na compra</td></tr><tr><td>data.client.phone</td><td>string</td><td>Numero de telefone do cliente usado na compra</td></tr><tr><td>data.client.document</td><td>string</td><td>Documento do cliente (CPF por padrão no Brasil)</td></tr><tr><td>data.client.address.street</td><td>string</td><td>Rua do endereço que o cliente adicionou no checkout. </td></tr><tr><td>data.client.address.number</td><td>string</td><td>Numero do endereço do cliente</td></tr><tr><td>data.client.address.complement</td><td>string</td><td>Complemento do endereço. Ex.: Apartamento 1002</td></tr><tr><td>data.client.address.neighborhood</td><td>string</td><td>Bairro do endereço do cliente</td></tr><tr><td>data.client.address.city</td><td>string</td><td>Cidade do endereço do cliente</td></tr><tr><td>data.client.address.state</td><td>string</td><td>Estado do endereço do cliente</td></tr><tr><td>data.client.address.country</td><td>string</td><td>País do endereço do cliente</td></tr><tr><td>data.client.address.zipcode</td><td>string</td><td>Código do endereço do cliente. No Brasil é o CEP.</td></tr><tr><td>data.metadata.utm_campaign</td><td>string</td><td>UTM Campaign adicionado na URL nas campanhas publicitárias.</td></tr><tr><td>data.metadata.utm_content</td><td>string</td><td>UTM Content adicionado na URL nas campanhas publicitárias.</td></tr><tr><td>data.metadata.utm_medium</td><td>string</td><td>UTM Medium adicionado na URL nas campanhas publicitárias.</td></tr><tr><td>data.metadata.utm_source</td><td>string</td><td>UTM Source adicionado na URL nas campanhas publicitárias.</td></tr><tr><td>data.metadata.utm_term</td><td>string</td><td>UTM Term adicionado na URL nas campanhas publicitárias.</td></tr><tr><td>data.metadata.ip</td><td>string</td><td>IP do usuário que gerou o evento</td></tr><tr><td>data.metadata.user_agent</td><td>string</td><td>Informações sobre o sistema operacional e navegador do usuário que gerou o evento</td></tr><tr><td>data.metadata.url_parameters.fbclid</td><td>string</td><td>Id do usuário na integração de pixel da Meta</td></tr><tr><td>data.metadata.url_parameters.fbp</td><td>string</td><td>Informações referentes ao pixel da Meta configurado no funil</td></tr><tr><td>data.metadata.url_parameters.nodeId</td><td>string</td><td>Id do nó do funil configurado na Assiny. É o identificador de qual "bloco" de oferta do funil esse evento aconteceu.</td></tr><tr><td>data.metadata.url_parameters.referrer</td><td>string</td><td>Parâmetro de URL para traquear indicações.</td></tr><tr><td>data.metadata.url_parameters.saveCard</td><td>bool</td><td>Caso o cliente tenha escolhido salvar as informações de pagamento via cartão, este campo vem como "true". Caso contrário, "false".</td></tr><tr><td>data.metadata.funnel_id</td><td>UUID</td><td>Id do funil na Assiny</td></tr><tr><td>data.metadata.short_funnel_id</td><td>string</td><td>Identificador curto do funil. Usado principalmente para as URLs do checkout</td></tr><tr><td>data.metadata.event_source_url</td><td>string</td><td>URL do checkout em que aconteceu o evento</td></tr></tbody></table>

{% hint style="warning" %}
O data.client.address só virá caso a oferta possuir o formulário de endereço ativo nas configurações. Caso contrário o endereço não é obrigatório para o cliente na compra.
{% endhint %}