Parâmetros do carrinho e dos itens
Ao enviar eventos, você pode especificar parâmetros que descrevem as propriedades dos itens ou do carrinho.
Propriedades do carrinho #
Parâmetros |
Tipo |
Descrição |
---|---|---|
cart_id |
string |
Identificador do carrinho. |
cart_items |
number |
Número de itens no carrinho (itens exclusivos). |
currency |
string |
Moeda utilizada para indicar o valor dos itens colocados no carrinho, impostos, descontos e despesas de envio. Se o parâmetro não for especificado, a moeda será exibida como "USD" no relatório. |
value |
number |
Custo de todos os itens adicionadas ao carrinho em dinheiro, incluindo impostos, descontos e entrega. Em outras palavras, quanto o comprador pagou pela compra. Indicado em dinheiro. |
profit |
number |
Lucro líquido do vendedor com a venda de todos os itens do carrinho. Indicado em dinheiro. A moeda é retirada do parâmetro "currency". |
transaction_fee |
number |
Taxa de transação (comissão do sistema de pagamento) pela compra de todos os itens adicionados ao carrinho de compras. Indicado em dinheiro. A moeda é retirada do parâmetro "currency". |
transaction_id |
string |
Identificador da transação para o pagamento dos itens colocados no carrinho. |
affiliation |
string |
Loja ou filial onde o pagamento foi feito. |
detail |
string |
Detalhes do erro de compra ou o motivo da devolução da compra. O campo também pode ser usado para uma compra bem-sucedida (Check-out success) para dar detalhes adicionais. |
tax_value |
number |
Valor do imposto em dinheiro para todos os itens adicionados ao carrinho. A moeda é retirada do parâmetro "currency". |
tax_name |
string |
Nome do imposto. |
tax_type |
string |
Tipo de imposto. |
discount_value |
number |
Valor do desconto em dinheiro para todos os itens adicionados ao carrinho. A moeda é retirada do parâmetro "currency". |
discount_name |
string |
Nome do desconto. |
discount_type |
string |
Tipo de desconto. |
shipping_value |
number |
Custo de envio de todos os itens adicionados ao carrinho em dinheiro. A moeda é retirada do parâmetro "currency". |
shipping_name |
string |
Nome do serviço de entrega. |
shipping_type |
string |
Tipo de entrega. |
checkout_step |
number |
Número da etapa em que o cliente está. Você mesmo numera as etapas dos eventos "Checkout Begin", "Checkout Progress" e "Checkout Success" |
checkout_option |
string |
Método de pagamento do carrinho. |
buyer |
string |
Nome ou identificador do comprador. Por exemplo, login no site. É necessário para gerar relatórios sobre os principais compradores. Esses relatórios são úteis se você fornecer uma plataforma para a venda de produtos a vários vendedores terceirizados. |
seller |
string |
Nome ou identificador do vendedor. Por exemplo, login no site. Necessário para gerar relatórios sobre os principais vendedores. Esses relatórios são úteis se você fornecer uma plataforma para a venda de produtos a vários vendedores terceirizados. |
Propriedades do item #
Parâmetros |
Tipo |
Descrição |
---|---|---|
id * |
string |
Identificador ou código do item (SKU, Stock Keeping Unit). |
name * |
string |
Nome do item. |
brand |
string |
Marca do item. |
category |
string |
Categoria do item. Por exemplo, "Roupas" ou "Telefones". |
variant |
string |
Tipo de item: cor, modelo, etc. |
quantity |
number |
Quantidade de itens. |
currency |
string |
Moeda em que são expressos o valor do item, o valor do imposto, os descontos e os portes de envio. Se o parâmetro não for especificado, a moeda será exibida como "USD" no relatório. |
price |
number |
Custo do item. |
value |
number |
Valor líquido do item em dinheiro, incluindo impostos, descontos e portes de envio: price + tax_value + shipping_value + transaction_fee - discount_value. Ou seja, quanto o comprador pagou pelo item. Indicado em dinheiro. |
profit |
number |
Lucro líquido do vendedor com a venda do item. Indicado em dinheiro. A moeda é retirada do parâmetro "currency". |
transaction_fee |
number |
Taxa de transação pela compra do item. Indicado em dinheiro. A moeda é retirada do parâmetro "currency". |
list_name |
string |
Nome da lista na qual o produto foi apresentado ao usuário. Por exemplo, uma lista de preços. |
list_position |
number |
Posição do produto na lista especificada em list_name. |
tax_value |
number |
Valor em dinheiro do imposto pago pelo item. A moeda é retirada do parâmetro "currency". |
tax_name |
string |
Nome do imposto. |
tax_type |
string |
Tipo de imposto. |
discount_value |
number |
Valor em dinheiro do desconto do item. A moeda é retirada do parâmetro "currency". |
discount_name |
string |
Nome do desconto. |
discount_type |
string |
Tipo de desconto. |
shipping_value |
number |
Portes de entrega do item em dinheiro. A moeda é retirada do parâmetro "currency". |
shipping_name |
string |
Nome do serviço de entrega. |
shipping_type |
string |
Tipo de entrega. |
* – parâmetros obrigatórios.