Tipos de eventos

Você pode enviar ao Finteza 8 tipos de eventos E-Commerce:

View Item – ver mercadoria
Add To Cart и Remove From Cart – adicionar e remover itens do carrinho
View Cart – ver carrinho de compras
Checkout Begin и Checkout Progress – início e continuação da compra
Checkout Success – compra bem-sucedida
Checkout Failed – falha ao concluir a compra
Refund – devolução do item

Outros eventos não serão incluídos nos relatórios E-Commerce do lado do Finteza.

View Item #

Este é um evento de visualização de item. Indica as características do item visualizado:

fz('ecommerce', {
  "event": "View Item",
  "items": [
    {
      "id": "P12345",
      "name": "USB Charger",
      "brand": "ChargeIt",
      "category": "Accessories",
      "variant": "Black",
      "quantity": 2,
      "currency": "USD",
      "price": 2.00,
      "list_name": "Search Results",
      "list_position": 1
    },
    {
      "id": "P67890",
      "name": "Flame challenge TShirt",
      "brand": "MyBrand",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "quantity": 1,
      "currency": "USD",
      "price": 3.00,
      "list_name": "Search Results",
      "list_position": 2
    }
  ]
});

Como resultado, no Finteza serão criados 2 eventos "View Item"- para cada um dos produtos descritos.

Add To Cart / Remove From Cart #

Estes são eventos para adicionar e remover itens do carrinho de compras. Aqui, além da descrição do item, é necessário passar o identificador do carrinho ao parâmetro cart_id (o identificador deve ser gerado pelo seu site).

fz('ecommerce', {
  "event": "Add To Cart",
  "cart_id": "C89367",
  "items": [
    {
      "id": "P12345",
      "name": "USB Charger",
      "brand": "ChargeIt",
      "category": "Accessories",
      "variant": "Black",
      "quantity": 2,
      "currency": "USD",
      "price": 2.00,
      "list_name": "Search Results",
      "list_position": 1
    },
    {
      "id": "P67890",
      "name": "Finteza TShirt",
      "brand": "Finteza",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "quantity": 1,
      "currency": "USD",
      "price": 3.00,
      "list_name": "Search Results",
      "list_position": 2
    }
  ]
});

Como resultado no Finteza serão criados 2 eventos "Add To Cart" – para cada um dos itens descritos. Além disso, a cada evento será adicionado o identificador de carrinho especificado.

Para o evento de remoção de um item do carrinho de compras, não passe parâmetros list_name e list_position. Eles descrevem a lista da qual os produtos são adicionados e não fazem sentido para um evento de remoção.

View Cart #

Este é um evento de visualização de carrinho. Aqui você pode adicionar informações sobre o valor do carrinho, bem como parâmetros adicionais, se disponíveis: impostos, descontos, lucro líquido. Parâmetros adicionais também podem ser especificados para itens individuais.

fz('ecommerce', {
  "event": "View Cart",
  "cart_id": "C89367",
  "cart_items": 2,
  "currency": "USD",
  "value": 7.07,
  "tax_value": 0.7,
  "tax_name": "Tax",
  "tax_type": "Tax type",
  "discount_value": 1,
  "discount_name": "Black Friday",
  "discount type": "B112029",
  "discount type": "B112029"
  "items": [
    {
      "id": "P12345",
      "name": "USB Charger",
      "brand": "ChargeIt",
      "category": "Accessories",
      "variant": "Black",
      "quantity": 2,
      "currency": "USD"
      "price": 2.00,
      "value": 4.24
    },
    {
      "id": "P67890",
      "name": "Finteza TShirt",
      "brand": "Finteza",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "quantity": 1,
      "currency": "USD"
      "price": 3.00,
      "value": 2.83
    }
  ]
});

Como resultado, no Finteza serão criados 3 eventos:

Evento "View Cart" para cada um dos itens. Neles será especificado cart_id.
evento "View Cart" para o carrinho de compras. Se cart_id não far especificado, o evento não será gerado.

Checkout Begin / Checkout Progress #

Estes são os eventos do início e da continuação da compra - quando o usuário já adicionou os produtos ao carrinho e finaliza a compra.

Além dos parâmetros utilizados na etapa "View Cart", aqui podem ser passadas informações sobre a etapa de compra. Aqui você também pode corrigir informações sobre descontos e cupons usados.

fz('ecommerce', {
  "event": "Checkout Begin",
  "cart_id": "C89367",
  "cart_items": 2,
  "currency": "USD",
  "value": 7.07,
  "tax_value": 0.7,
  "tax_name": "Tax",
  "tax_type": "Tax type",
  "discount_value": 1,
  "discount_name": "Black Friday",
  "discount type": "B112029",
  "shipping_value": 0.3,
  "shipping_name": "Shipping",
  "shipping_type": "Shipping Type",
  "checkout_step": 1,
  "checkout_option" : "Shipping"
  "items": [
    {
      "id": "P12345",
      "name": "USB Chargers",
      "brand": "ChargeIt",
      "category": "Accessories",
      "variant": "Black",
      "quantity": 2,
      "currency": "USD"
      "price": 2.00,
      "value": 4.24,
      "tax_value": 0.4,
      "tax_name": "Tax",
      "tax_type": "Tax type",
      "shipping_value": 0.2,
      "shipping_name": "Shipping",
      "shipping_type": "Standard Post"
    },
    {
      "id": "P67890",
      "name": "Finteza TShirt",
      "brand": "Finteza",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "quantity": 1,
      "currency": "USD"
      "price": 3.00,
      "value": 2.83,
      "tax_value": 0.3,
      "tax_name": "Tax",
      "tax_type": "Tax type",
      "discount_value": 0.6,
      "discount_name": "Black Friday",
      "discount type": "B112029"
    }
  ]
});

Como resultado, no Finteza serão criados 3 eventos:

Evento "Checkout Begin" para cada um dos itens. Neles serão especificados cart_id, checkout_step e checkout_option, tirados das descrições do carrinho.
Evento "Checkout Begin" para o carrinho. Se cart_id não far especificado, o evento não será gerado.

Checkout Success #

Este evento é a conclusão bem-sucedida da compra. Além das informações do evento anterior, você pode especificar o identificador do pagamento (transaction_id) e os dados sobre a loja (affiliate). Aqui você também pode especificar:

Nome do comprador (buyer) e do vendedor (seller). Os relatórios dos principais vendedores e compradores são úteis se você fornecer uma plataforma com a qual muitos vendedores terceirizados possam trabalhar.
Comissão do sistema de pagamento para a transação (trabsaction_fee).
Renda líquida vinda de vendas, menos comissões, impostos e taxas (profit).

fz('ecommerce', {
  "event": "Checkout Success",
  "transaction_id": "CH38027",
  "affiliation": "Online store",
  "buyer": "john_smith",
  "seller": "Europe Shop",
  "cart_id": "C89367",
  "cart_items": 2,
  "currency": "USD",
  "value": 7.07,
  "profit": 2,
  "transaction_fee": 0.07,
  "tax_value": 0.7,
  "tax_name": "Tax",
  "tax_type": "VAT",
  "discount_value": 1,
  "discount_name": "Black Friday",
  "discount type": "B112029",
  "shipping_value": 0.3,
  "shipping_name": "Shipping",
  "shipping_type": "Standard Post",
  "checkout_step": 1,
  "checkout_option" : "Shipping",
  "items": [
    {
      "id": "P12345",
      "name": "USB Charger",
      "brand": "ChargeIt",
      "category": "Accessories",
      "variant": "Black",
      "quantity": 2,
      "currency": "USD"
      "price": 2.00,
      "value": 4.24,
      "profit": 1.6,
      "transaction_fee": 0.04,
      "tax_value": 0.4,
      "tax_name": "Tax",
      "tax_type": "VAT",
      "discount_value": 0.4,
      "discount_name": "Black Friday",
      "discount type": "B112029",
      "shipping_value": 0.2,
      "shipping_name": "Shipping",
      "shipping_type": "Standard Post",
    },
    {
      "id": "P67890",
      "name": "Finteza TShirt",
      "brand": "Finteza",
      "category": "T-Shirts",
      "variant": "Red",
      "quantity": 1,
      "currency": "USD"
      "price": 3.00,
      "value": 2.83,
      "profit": 0.4,
      "transaction_fee": 0.03,
      "tax_value": 0.3,
      "tax_name": "Tax",
      "tax_type": "VAT",
      "discount_value": 0.6,
      "discount_name": "Black Friday",
      "discount type": "B112029"
      "shipping_value": 0.1,
      "shipping_name": "Shipping",
      "shipping_type": "Standard Post",
    }
  ]
});

Como resultado, no Finteza serão criados 3 eventos:

Evento "Checkout Success" para cada um dos itens. Neles são especificadostransaction_id, affiliation, cart_id, checkout_step, checkout_option, retirados da descrição do carrinho.
Evento "Checkout Success" para o carrinho. Se cart_id não far especificado, o evento não será gerado.

Checkout Failed #

Este é um evento de tentativa malsucedida de pagar um pedido. Ao contrário do evento anterior, o identificador da transação transaction_id não é especificado, mas a descrição do erro é adicionada ao parâmetro detail.

fz('ecommerce', {
  "event": "Checkout Failed",
  "detail": "WebMoney Payment Error",
  "cart_id": "C89367",
  "cart_items": 2,
  "currency": "USD",
  "value": 7.07,
  "checkout_step": 1,
  "checkout_option" : "Shipping",
  "items": [
    {
      "id": "P12345",
      "name": "USB Charger",
      "brand": "ChargeIt",
      "category": "Accessories",
      "variant": "Black",
      "quantity": 2,
      "currency": "USD"
      "price": 2.00,
      "value": 4.24,
    },
    {
      "id": "P67890",
      "name": "Finteza TShirt",
      "brand": "Finteza",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "quantity": 1,
      "currency": "USD"
      "price": 3.00,
      "value": 2.83,
    }
  ]
});

Como resultado, no Finteza serão criados 3 eventos:

Evento "Checkout Failed" para cada um dos itens. Neles serão especificados detail, cart_id, checkout_step, checkout_option, retirados da descrição do carrinho.
Evento "Checkout Failed" para o carrinho. Se cart_id não far especificado, o evento não será gerado.

Refund #

Este é um evento de devolução de produto. Aqui é especificado o identificador do pagamento transaction_id para estabelecer uma conexão com o pagamento inicial e uma descrição do motivo da devolução no parâmetro detail.

fz('ecommerce', {
  "event": "Refund",
  "transaction_id": "P7788112313",
  "detail": "Broken",
  "cart_id": "C89367",
  "cart_items": 2,
  "currency": "USD",
  "value": 7.07,
  "items": [
    {
      "id": "P12345",
      "name": "USB Charger",
      "brand": "ChargeIt",
      "category": "Accessories",
      "variant": "Black",
      "quantity": 2,
      "currency": "USD"
      "price": 2.00,
      "value": 4.24,
    },
    {
      "id": "P67890",
      "name": "Finteza TShirt",
      "brand": "Finteza",
      "category": "Apparel/T-Shirts",
      "variant": "Red",
      "quantity": 1,
      "currency": "USD"
      "price": 3.00,
      "value": 2.83,
    }
  ]
});

Como resultado, no Finteza serão criados 3 eventos:

Evento "Refund" para cada um dos itens. Neles serão especificados transaction_id, detail, cart_id, retirados da descrição do carrinho.
Evento "Refund" para o carrinho. Se cart_id não far especificado, o evento não será gerado.