Evénement Transaction

Avant-propos

Cette documentation de marquage ne s’applique qu’à partir de la version 2.17.0 du Tracker.

Si vous ne voyez pas le menu « Ecommerce » dans Explorer, contactez-nous pour que nous activions la fonctionnalité pour vous.

Evénement Transaction

Le tracker met à disposition une instance ecommerce exposant différents objets et méthodes utiles pour la mesure de confirmation de transaction.

Confirmation de transaction

La mesure de la confirmation de transaction se fait par la création d’un objet TransactionConfirmation auquel peuvent être associés :

• un panier de type ECommerceCart,
• des données de livraison sous la forme d’un objet de type ECommerceShipping,
• des données de paiement sous la forme d’un objet de type ECommercePayment,
• des données de transaction sous la forme d’un objet de type ECommerceTransaction,
• une liste de produits products pouvant contenir un ou plusieurs produits de type ECommerceProduct.

Les propriétés d’un panier se déclarent sous la forme d’une collection de type Dictionary  avec différentes clés :

• « id » – String: Identifiant du panier.
• « currency » – String: Devise.
• « turnovertaxincluded » – Float: Montant total TTC du panier (frais de livraison inclus).
• « turnovertaxfree » – Float: Montant total HT du panier (frais de livraison inclus).
• « creation_utc » – Date: Date de creation du panier (timestamp UTC en secondes).
• « quantity » – Number: Nombre total de produits dans le panier.
• « nbdistinctproduct » – Number: Nombre de produits distincts dans le panier.

Les propriétés de la transaction se déclarent sous la forme d’une collection de type Dictionary  avec différentes clés :

• « id » – String : Identifiant de transaction (obligatoire).
• « status » – String : Statut de la transaction.
• « promocode » – Array : Tableau de codes promotionnels pouvant contenir un ou plusieurs codes. Un code promotionnel se déclare sous la forme d’un libellé.
• « firstpurchase » – Boolean : Première commande du client.

Les données de livraison se déclarent sous la forme d’une collection de type Dictionary  avec différentes clés :

• « delivery » – String : Nom du transporteur.
• « costtaxincluded » – Float : Montant des frais de livraison TTC.
• « costtaxfree » – Float : Montant des frais de livraison HT.

Le moyen de paiement se déclare dans une propriété :

• « mode » – String : Moyen de paiement.

Les propriétés d’un produit se déclarent sous la forme d’une collection de type Dictionary  avec différentes clés :

• « id » – String : Identifiant du produit (obligatoire).
• « variant » – String : Variante du produit (taille, couleur, etc.).
• « article » – String : Niveau de détail supplémentaire à la variante du produit.
• « placement » – String : Emplacement du produit.
• « promocode » – Array : Tableau de codes promotionnels pouvant contenir un ou plusieurs codes. Un code promotionnel se déclare sous la forme d’un libellé.
• « $ » – String : Nom du produit.
• « brand » – String : Marque du produit.
• « discount » – Boolean : Produit remisé.
• « pricetaxincluded » – Float : Prix TTC.
• « pricetaxfree » – Float : Prix HT.
• « stock » – Boolean : Produit en stock.
• « quantity » – Number : Nombre de produits dans le panier.
• « category1 » – String : Catégorie de niveau 1 du produit (jusqu’à 6 niveaux d’arborescence possibles ; de « category1 » à « category6 »).

Exemple

let tracker: Tracker = ATInternet.sharedInstance.defaultTracker
let tc: TransactionConfirmation = tracker.ecommerce.transactionConfirmations.add()
_ = tc.cart.setAll(obj:
    [
        "id": "34",
        "creation_utc": 1514973161, //UTC timestamp in seconds
        "turnovertaxfree": 447.76, //Shipping fees included + discount 8€44
        "turnovertaxincluded": 547.4, //Shipping fees included + discount 10€
        "nbdistinctproduct": 1,
        "quantity": 1,
        "currency": "EUR"
    ]
)
_ = tc.transaction.setAll(obj:
    [
        "id": "27",
        "status": "charged",
        "promocode": ["DQQYRZSJ", "UN1ENE27"],
        "firstpurchase": false
    ]
)
_ = tc.shipping.setAll(obj:
    [
        "costtaxfree": 7,
        "costtaxincluded": 8.4,
        "delivery": "My carrier"
    ]
)
_ = tc.payment.set(key: "mode", value: "Credit card")
_ = tc.products.append(ECommerceProduct(obj:
    [
        "id": "1",
        "variant": "1",
        "article": "21", 
        "placement": "homepage", 
        "promocode": ["AQQYRTGJ"],
        "$": "laptop_A56",
        "brand": "ACER",
        "discount": true,
        "pricetaxincluded": 549,
        "pricetaxfree": 456.2,
        "stock": true,
        "quantity": 1,
        "category1": "Computers_and_Networking",
        "category2": "Computers",
        "category3": "Laptops"
    ]
))
tracker.dispatch()

Tracker* tracker = [ATInternet sharedInstance].defaultTracker;
TransactionConfirmation *tc = [[tracker.ecommerce transactionConfirmations] add];
NSMutableArray *tcproducts = [tc.products mutableCopy];
(void)[tc.cart setAllWithObj:@{
    @"id": @"34",
    @"creation_utc": @1514973161, //UTC timestamp in seconds
    @"turnovertaxfree": @447.76, //Shipping fees included + discount 8€44
    @"turnovertaxincluded": @547.4, //Shipping fees included + discount 10€
    @"nbdistinctproduct": @1,
    @"quantity": @1,
    @"currency": @"EUR"
}];
(void)[tc.transaction setAllWithObj:@{
    @"id": @"27",
    @"status": @"charged",
    @"promocode": @[@"DQQYRZSJ", @"UN1ENE27"],
    @"firstpurchase": @false
}];
(void)[tc.shipping setAllWithObj:@{
    @"costtaxfree": @7,
    @"costtaxincluded": @8.4,
    @"delivery": @"My carrier"
}];
(void)[tc.payment setWithKey:@"mode" value: @"Credit card"];
[tcproducts addObject:[[ECommerceProduct alloc] initWithObj:@{
    @"id": @"1",
    @"variant": @"1",
    @"article": @"21",
    @"placement": @"homepage",
    @"promocode": @[@"AQQYRTGJ"],
    @"$": @"laptop_A56",
    @"brand": @"ACER",
    @"discount": @true,
    @"pricetaxincluded": @549,
    @"pricetaxfree":@ 456.2,
    @"stock": @true,
    @"quantity": @1,
    @"category1": @"Computers_and_Networking",
    @"category2": @"Computers",
    @"category3": @"Laptops"
}]];
[tc setProducts: tcproducts];
[tracker dispatch];

Confirmation de transaction côté serveur

Vous pouvez valider un événement de panier en attente de paiement en générant un appel HTTP GET côté serveur :

https://YOURSSLCOLLECTDOMAIN/hit.xiti?s=XXXXX&col=2&events=[{"name":"transaction.confirmation","data":{"cart_id":"XXXXX", "transaction_id":"XXXXX", "offsite_confirmation":true}]&rdt=off

Dans cet appel, vous devez remplacer les valeurs XXXXX par :

• le numéro de site concerné par la transaction :

  ?s=XXXXX

• l’identifiant du panier à valider :

  "cart_id":"XXXXX"

• l’identifiant de la transaction :

  "transaction_id":"XXXXX"