Типы событий

Вы можете отправлять в Finteza 8 типов событий E-Commerce:

Любые другие события не будут попадать в отчеты E-Commerce на стороне Finteza.

View Item #

Это событие просмотра товара. В нем указываются характеристики просматриваемого товара:

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
    }
  ]
});

В результате в Finteza будет создано 2 события "View Item" — для каждого из описанных товаров.

Add To Cart / Remove From Cart #

Это события добавления и удаления товаров из корзины. Здесь, помимо описания товара, следует передавать идентификатор корзины в параметре cart_id (идентификатор должен генерироваться вашим сайтом).

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
    }
  ]
});

В результате в Finteza будет создано 2 события "Add To Cart" — для каждого из описанных товаров. При этом в каждое событие будет добавлен указанный идентификатор корзины.

Для события удаления товара из корзины не передавайте параметры list_name и list_position. Они описывают список, из которого добавлены товары, и не имеют смысла для события удаления.

View Cart #

Это событие просмотра корзины. Здесь добавляется информация о стоимости корзины, а также дополнительные параметры, если они доступны: налоги, скидки, чистая прибыль. Дополнительные параметры можно указать также и для отдельных товаров.

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
    }
  ]
});

В результате в Finteza будет создано 3 события:

  • Событие "View Cart" для каждого из товаров. В них будет указан cart_id.
  • Cобытие "View Cart" для корзины. Если cart_id не указан, событие не cгенерируется.

Checkout Begin / Checkout Progress #

Это события начала и продолжения покупки — когда пользователь уже добавил товары в корзину и переходит к оформлению.

В дополнении к параметрам, используемым на этапе "View Cart", здесь можно передать информацию об этапе покупки. Также здесь можно скорректировать информацию о скидках и используемых купонах.

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"
    }
  ]
});

В результате в Finteza будет создано 3 события:

  • Событие "Checkout Begin" для каждого из товаров. В них будут указаны cart_id, checkout_step и checkout_option, взятые из описания корзины.
  • Событие "Checkout Begin" для корзины. Если cart_id не указан, событие не cгенерируется.

Checkout Success #

Это событие успешного завершение покупки. В дополнении к информации из предыдущего события можно указать идентификатор платежа (transaction_id) и данные о магазине (affiliate). Также здесь можно указать:

  • Имя покупателя (buyer) и продавца (seller). Отчеты по топовым покупателями и продавцам будут полезны, если вы предоставляете площадку для работы множеству сторонних продавцов.
  • Комиссию платежной системы для транзакции (trabsaction_fee).
  • Чистый доход от продажи за вычетом комиссий, налогов и сборов (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",
    }
  ]
});

В результате в Finteza будет создано 3 события:

  • Событие "Checkout Success" для каждого из товаров. В них будут указаны transaction_id, affiliation, cart_id, checkout_step, checkout_option, взятые из описания корзины.
  • Событие "Checkout Success" для корзины. Если cart_id не указан, событие не cгенерируется.

Checkout Failed #

Это событие неудачной попытки оплаты заказа. В отличие от предыдущего события здесь не указывается идентификатор транзакции transaction_id, но добавляется описание ошибки в параметре 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,
    }
  ]
});

В результате в Finteza будет создано 3 события:

  • Событие "Checkout Failed" для каждого из товаров. В них будут указаны detail, cart_id, checkout_step, checkout_option, взятые из описания корзины.
  • Событие "Checkout Failed" для корзины. Если cart_id не указан, событие не cгенерируется.

Refund #

Это событие возврата товаров. Здесь указывается идентификатор платежа transaction_id для установки связи с изначальным платежом и описание причины возврата в параметре 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,
    }
  ]
});

В результате в Finteza будет создано 3 события:

  • Событие "Refund" для каждого из товаров. В них будут указаны transaction_id, detail, cart_id, взятые из описания корзины.
  • Событие "Refund" для корзины. Если cart_id не указан, событие не cгенерируется.
← 
 →