# Événements e-commerce ## add\_payment\_info Cet événement indique qu’un utilisateur a soumis ses informations de paiement **Paramètres (requis et recommandés)**
NomTypeRequisValeur d’exempleDescription
payment_methodstringOuicardLa méthode de paiement choisie (voir la liste des valeurs possibles ci-dessous)
userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur et est obligatoire pour gérer les consentements. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

couponstringNoCHRISTMASCode promo utilisé pour un achat.
revenuenumberNo16.00

Revenu (prix de livraison et taxes exclus) après remise.
()revenue est généralement requis pour des rapports pertinents.

()currency est requis si vous définissez revenue.

currencystring (ISO 4217)NoEUR

Devise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.

(*) Si vous fournissez le paramètre revenue vous devez également fournir le paramètre currency afin que les métriques de revenue puissent être calculées correctement.

itemsArray<Items>NoLes articles de l’événement.
**Exemple** {% tabs %} {% tab title="JavaScript" %} ```javascript cact('trigger','add_payment_info', { payment_method: 'card', revenue: 16.00, currency: 'EUR', user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val event = TCAddPaymentInfoEvent("card") event.revenue = 16.00f event.currency = "EUR" serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ``` TCAddPaymentInfoEvent event = new TCAddPaymentInfoEvent("card"); event.revenue = 16.6f; event.currency = "EUR"; serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec TCAddPaymentInfoEvent *event = [[TCAddPaymentInfoEvent alloc] initWithId: @"ID"; event.revenue = [[NSDecimalNumber alloc] initWithFloat: 16.00f]; event.currency = @"EUR"; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let event = TCAddPaymentInfoEvent(payementMethod: "card") event?.revenue = 16.00 event?.currency = "EUR" serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart var event = TCAddPaymentInfoEvent(); event.paymentMethod = "card"; event.revenue = 16.00; event.currency = "EUR"; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "add_payment_info", "payment_method": "card", "revenue": 16.00, "value": 22.53, "currency": "EUR", "user": { "id": "12345", "email": "toto@domain.fr", "consent_categories": [ 1, 3 ] } } ``` {% endtab %} {% endtabs %} ## add\_shipping\_info Cet événement indique qu’un utilisateur a soumis ses informations de livraison. #### Paramètres
NomTypeRequisValeur d’exempleDescription
currencystring (ISO 4217)OuiEUR

Devise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.

(*) Si vous fournissez le paramètre revenue ou valuevous devez également fournir le paramètre currency afin que les métriques de revenue puissent être calculées correctement.

valuenumberOui22.53La valeur monétaire de l’événement (prix de livraison et taxes inclus) après remise
userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

couponstringNoCHRISTMASCode promo utilisé pour un achat.
shipping_tierstringNoGroundLe niveau de livraison (par ex. Next-day, Air`) sélectionné pour la livraison de l’article acheté.
itemsArray<Items>OuiLes articles de l’événement.
**Exemple** {% tabs %} {% tab title="JavaScript" %} \` \`\`javascript cact('trigger','add\_shipping\_info', { value: 8.00, currency: 'EUR', coupon: 'promo', shipping\_tier: 'ups', items: \[{ id: 'SKU\_12345', quantity: 1, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category\_1: 'clothes', category\_2: 't-shirts', category\_3: 'boy', brand: 'Lacoste', price: 9.99 } }], user: { id: '12356', email:'', consent\_categories: \[1,3] } }); ````
```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCAddShippingInfoEvent(items, 112.5f, "EUR") event.coupon = "promo" event.shippingTier = "ups" serverside.execute(event) ```` ```java TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCAddShippingInfoEvent event = new TCAddShippingInfoEvent(items, 112.5f, "EUR"); event.coupon = "promo"; event.shippingTier = "ups"; serverside.execute(event); ``` ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithString: @"1.5"]] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCAddShippingInfoEvent *event = [[TCAddShippingInfoEvent alloc] initWithItems: items withValue: [[NSDecimalNumber alloc] initWithString: @"12.2"] withCurrency: @"EUR"]; event.coupon = @"promo"; event.shippingTier = @"ups"; [TCS execute: event]; ``` ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCAddShippingInfoEvent(items: [item_1, item_2], withValue: 1, withCurrency: "EUR") event?.addAdditionalProperty("additionalKey", withBoolValue: true) event?.coupon = "promo" event?.shippingTier = "ups" serverside?.execute(event) ``` 
TCProduct tc_product = TCProduct();
		tc_product.ID = "product_1_ID";
		tc_product.name = "product_1_name";
		tc_product.price = 150;
		tc_product.addAdditionalProperty("key_additional_product", "val_additional_product");
TCItem tc_item_1 = TCItem();
		tc_item_1.ID = "item_1_id";
		tc_item_1.product = tc_product;
		tc_item_1.quantity = 1;
		tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product");
TCProduct tc_product_2 = TCProduct();
		tc_product_2.ID = "product_2_ID";
		tc_product_2.name = "product_2_name";
		tc_product_2.price = 150;
		tc_product_2.addAdditionalProperty("key_additional_product", "val_additional_product");
TCItem tc_item_2 = TCItem();
		tc_item_2.ID = "item_2_id";
		tc_item_2.quantity = 2;
		tc_item_2.product = tc_product;
		tc_item_2.addAdditionalProperty("key_additional_item", "val_additional_product");

var event = TCAddShippingInfoEvent();
    event.coupon = "promo";
    event.shippingTier = "ups";
    event.currency = "EUR";
    event.items = [tc_item_1, tc_item_2];
serverside.execute(event);
```json { "event_name": "add_shipping_info", "shipping_tier": "Ground", "revenue": 16.00, "value": 22.53, "currency": "EUR", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ], "price": 9.99 } }, { "id": "SKU_12346", "quantity": 1, "price": 9.99, "variant": "green", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12346", "name": "Heart tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "girl", "brand": "Jenyfion", "colors": [ "blue", "white" ], "price": 9.99 } } ], "user": { "id": "12345", "email": "toto@domain.fr", "consent_categories": [ 1, 3 ] } } ``` ## add\_to\_cart Cet événement indique qu’un article a été ajouté à un panier pour achat. **Paramètres (requis et recommandés)**
NomTypeRequisValeur d’exempleDescription
valuenumberOui*8.00

La valeur monétaire de l’événement.
()value est généralement requis pour des rapports pertinents.

()currency est requis si vous définissez value.

currencystring (ISO 4217)Oui*EUR

Devise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.

(*) Si vous fournissez le paramètre revenue vous devez également fournir le paramètre currency afin que les métriques de revenue puissent être calculées correctement.

userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

itemsArray<Items>OuiLes articles de l’événement.
**Exemple** {% tabs %} {% tab title="JavaScript" %} ```javascript cact('trigger','add_to_cart', { value: 8.00, currency: 'EUR', items: [{ id: 'SKU_12345', quantity: 1, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', price: 9.99 } }], user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCAddToCartEvent(22.53f, "EUR", items) serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCAddToCartEvent event = new TCAddToCartEvent(22.53f, "EUR", items); serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithFloat: 1.5f]] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCAddToCartEvent *event = [[TCAddToCartEvent alloc] initWithValue: [[NSDecimalNumber alloc] initWithString: @"12.2"] withCurrency: @"EUR" withItems: items]; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCAddToCartEvent(value: 1, withCurrency: "EUR", withItems: [item_1, item_2]) event?.addAdditionalProperty("additionalKey", withBoolValue: true) event?.currency = "EUR" serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 12.5; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCAddToCartEvent(); event.currency = "EUR"; event.items = [tc_item_1]; event.value = 12.5; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "add_to_cart", "value": 8.00, "currency": "EUR", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ] } } ] } ``` {% endtab %} {% endtabs %} ## add\_to\_wishlist Cet événement indique qu’un article a été ajouté à une liste de souhaits. Utilisez cet événement pour identifier les articles cadeaux populaires dans votre application. **Paramètres (requis et recommandés)**
NomTypeRequisValeur d’exempleDescription
valuenumberNo8.00

La valeur monétaire de l’événement.
()revenue est généralement requis pour des rapports pertinents.

()currency est requis si vous définissez revenue.

currencystring (ISO 4217)NoEUR

Devise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.

(*) Si vous fournissez le paramètre revenue vous devez également fournir le paramètre currency afin que les métriques de revenue puissent être calculées correctement.

userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

itemsArray<Items>OuiLes articles de l’événement.
**Exemple** {% tabs %} {% tab title="JavaScript" %} ```javascript cact('trigger','add_to_wishlist', { value: 8.00, currency: 'EUR', items: [{ id: 'SKU_12345', quantity: 1, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', price: 9.99 } }], user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCAddToWishlistEvent(items) event.value = 20.00f event.currency = "EUR" serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCAddToWishlistEvent event = new TCAddToWishlistEvent(items); event.value = 20.00f; event.currency = "EUR"; serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithFloat: 1.5f]] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCAddToWishlistEvent *event = [[TCAddToWishlistEvent alloc] initWithValue: [[NSDecimalNumber alloc] initWithString: @"12.2"] withCurrency: @"EUR" withItems: items]; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCAddToWishlistEvent(items: [item_1, item_2]) event?.currency = "EUR" serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 150; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCAddToWishlistEvent(); event.addAdditionalPropertyWithIntValue("key_additional_1", 12); event.addAdditionalPropertyWithListValue("key_additional_2", [12,12,12]); event.currency = "EUR"; event.items = [tc_item_1]; event.value = 12.5; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "add_to_wishlist", "value": 8.00, "currency": "EUR", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ] } } ] } ``` {% endtab %} {% endtabs %} ## begin\_checkout Cet événement indique qu’un utilisateur a commencé un checkout. **Paramètres (requis et recommandés)**
NomTypeRequisValeur d’exempleDescription
revenuenumberOui16.00La valeur monétaire de l’événement (prix de livraison et taxes exclus) après remise
valuenumberOui22.53La valeur monétaire de l’événement (prix de livraison et taxes inclus) après remise
currencystring (ISO 4217)OuiEUR

Devise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.

(*) Si vous fournissez le paramètre revenue vous devez également fournir le paramètre currency afin que les métriques de revenue puissent être calculées correctement.

couponstringNoCHRISTMASCode promo utilisé pour un achat.
idstringNo0_12345ID de transaction. Utilisé comme clé pour les mises à jour
userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

itemsArray<Items>OuiLes éléments de l'événement.
**Exemple** {% tabs %} {% tab title="JavaScript" %} ```javascript cact('trigger','begin_checkout', { id: 'O_12345', coupon: 'CHRISTMAS', revenue: 16.00, value: 20.33, currency: 'EUR', user: { id: '12356', email:'toto@domain.fr' }, items: [{ id: 'SKU_12345', quantity: 1, price: 9.99, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', colors: ['red'], price: 9.99 } }, { id: 'SKU_12346', quantity: 1, price: 9.99, variant: 'green', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12346', name: 'Heart tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'girl', brand: 'Jenyfion', colors: ['blue','white'], price: 9.99 } }] }) ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCBeginCheckoutEvent(1.0f, 2.0f, "EUR", items) event.coupon = "CHRISTMAS" serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCBeginCheckoutEvent event = new TCBeginCheckoutEvent(1.0f, 2.0f, "EUR", items); event.coupon = "CHRISTMAS"; serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithFloat: 1.5f]] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCBeginCheckoutEvent *event = [[TCBeginCheckoutEvent alloc] initWithRevenue: [[NSDecimalNumber alloc] initWithString: @"1.1"] withValue: [[NSDecimalNumber alloc] initWithString: @"12.2"] withCurrency: @"EUR" withItems: items]; event.coupon = @"CHRISTMAS"; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCBeginCheckoutEvent(revenue: 1, withValue: 3, withCurrency: "EUR", withItems: [item_1, item_2]) serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 10; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); TCProduct tc_product_2 = TCProduct(); tc_product_2.ID = "product_2_ID"; tc_product_2.name = "product_2_name"; tc_product_2.price = 5.10; tc_product_2.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_2 = TCItem(); tc_item_2.ID = "item_2_id"; tc_item_2.quantity = 2; tc_item_2.product = tc_product; tc_item_2.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCBeginCheckoutEvent(); event.coupon = "CHRISTMAS"; event.items = [tc_item_1, tc_item_2]; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "begin_checkout", "id": "O_12345", "coupon": "CHRISTMAS", "revenue": 16.00, "value": 22.53, "currency": "EUR", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ], "price": 9.99 } }, { "id": "SKU_12346", "quantity": 1, "price": 9.99, "variant": "green", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12346", "name": "Heart tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "girl", "brand": "Jenyfion", "colors": [ "blue", "white" ], "price": 9.99 } } ], "user": { "id": "12345", "email": "toto@domain.fr", "consent_categories": [ 1, 3 ] } } ``` {% endtab %} {% endtabs %} ## generate\_lead Enregistrez cet événement lorsqu’un lead a été généré afin de comprendre l’efficacité de vos campagnes de réengagement. **Paramètres (requis et recommandés)**
NomTypeRequisValeur d’exempleDescription
valuenumberNo*9.99

La valeur monétaire de l’événement.
()revenue est généralement requis pour des rapports pertinents.

()currency est requis si vous définissez revenue.

currencystring (ISO 4217)No*EUR

Devise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.

(*) Si vous fournissez le paramètre revenue vous devez également fournir le paramètre currency afin que les métriques de revenue puissent être calculées correctement.

idstringNoID du lead
userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

**Exemple** {% tabs %} {% tab title="Javascript" %} ```javascript cact('trigger','generate_lead', { currency: 'EUR', value: 9.99, id: 'L_12345', user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val event = TCGenerateLeadEvent(9.99f, "EUR") event.ID = "L_12345" serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCGenerateLeadEvent event = new TCGenerateLeadEvent(9.99f, "EUR"); event.ID = "L_12345"; serverside.execute(event); ``` {% endtab %} {% tab title="iOS" %} ```objectivec TCGenerateLeadEvent *event = [[TCGenerateLeadEvent alloc] initWithValue: [[NSDecimalNumber alloc] initWithString: @"12.2"] withCurrency: @"EUR"]; event.ID = @"2b758628-f81b-454f-8e3d-867e8bc98523"; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift" %} ```swift let event = TCGenerateLeadEvent(value: 1, withCurrency: "EUR") event?.ID = "2b758628-f81b-454f-8e3d-867e8bc98523"; serverside.execute(event) ``` {% endtab %} {% tab title="Flutter" %} ```dart var event = TCGenerateLeadEvent(); event.currency = "EUR"; event.value = 9.99; event.ID = "2b758628-f81b-454f-8e3d-867e8bc98523"; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "generate_lead", "method": "LinkedIn" } ``` {% endtab %} {% endtabs %} ## purchase Déclenchez cet événement lorsqu’un ou plusieurs articles sont achetés par un utilisateur. #### Paramètres **(requis et recommandé)**
NomTypeRequisExempleDescription
idstringOuiO_1245ID de transaction. Utilisé comme clé pour les mises à jour
userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

Toutes les propriétés que vous ajoutez ici seront utilisées comme conditions pour faire correspondre les utilisateurs dans notre base de données.

cosent_categories est automatiquement renseigné si vous utilisez Commanders Act CMP.

revenuenumberOui16.00La valeur monétaire de l’événement (prix de livraison et taxes exclus) après remise
valuenumberOui22.53La valeur monétaire de l’événement (prix de livraison et taxes inclus) après remise
shipping_amountnumberNo3.33Frais de livraison associés à une transaction.
tax_amountnumberNo3.20Taxe associée à une transaction.
currencystring (ISO 4217)OuiEURDevise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.
couponstringNoCHRISTMASCode promo utilisé pour un achat.
typestringOuiofflineType de conversion (online, offline, appel, etc.)
itemsArray<Items>OuiLes articles de l’événement.
payment_methodstringOuicardType de méthode de paiement (voir la liste des valeurs possibles ci-dessous)
statusstringOuiin_progressStatut de la conversion (voir la liste de valeurs possibles ci-dessous).
Les conversions avec le statut "pending" ne sont pas incluses dans la somme et les comptes par défaut agrégés sur la fonctionnalité d'attributs utilisateur enrichis
last_channelstringNodisplayLe dernier channel juste avant l'achat.
last_sourcestringNogoogle.comLa dernière source (referrer) juste avant l'achat.
**Ajouté automatiquement par l'API cact** | Nom | Type | Requis | Exemple | Description | | ----- | ----------- | ------ | ------- | ------------------------------------------------------------------------------------------------ | | `url` | string(url) | No | none |

URL du site web où vous pouvez acheter l'article

Équivalent à window\.location.href

| **Exemple** {% tabs %} {% tab title="Javascript" %} ```javascript cact('trigger','purchase', { id: 'O_12345', coupon: 'CHRISTMAS', revenue: 16.00, value: 20.33, shipping_amount: 3.33, tax_amount: 3.20, currency: 'EUR', user: { id: '12356', email:'toto@domain.fr' }, items: [{ id: 'SKU_12345', quantity: 1, price: 9.99, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', colors: ['red'], price: 9.99 } }, { id: 'SKU_12346', quantity: 1, price: 9.99, variant: 'green', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12346', name: 'Heart tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'girl', brand: 'Jenyfion', colors: ['blue','white'], price: 9.99 } }] }) ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCPurchaseEvent("O_12345", 16.0f, 22.53f, "EUR", "purchase", "CreditCard", "waiting", items) event.shippingAmount = 3.33f event.taxAmount = 3.20f serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCPurchaseEvent event = new TCPurchaseEvent("O_12345", 16.0f, 22.53f, "EUR", "purchase", "CreditCard", "waiting", items); event.shippingAmount = 3.33f; event.taxAmount = 3.20f; serverside.execute(event); ``` {% endtab %} {% tab title="iOS" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithString: @"1.5"]] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCPurchaseEvent *event = [[TCPurchaseEvent alloc] initWithId: @"ID" withRevenue: [[NSDecimalNumber alloc] initWithString: @"1.1"] withValue: [[NSDecimalNumber alloc] initWithString: @"12.2"] withCurrency: @"EUR" withType: @"purchase" withPaymentMethod: @"CreditCard" withStatus: @"waiting" withItems: items]; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCPurchaseEvent(id: "purchaseID", withRevenue: 16.21, withValue: 23.10, withCurrency: "EUR", withType: "purchase", withPaymentMethod: "CreditCard", withStatus: "waiting", withItems: [item_1, item_2]) serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 10; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); TCProduct tc_product_2 = TCProduct(); tc_product_2.ID = "product_2_ID"; tc_product_2.name = "product_2_name"; tc_product_2.price = 5.10; tc_product_2.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_2 = TCItem(); tc_item_2.ID = "item_2_id"; tc_item_2.quantity = 2; tc_item_2.product = tc_product; tc_item_2.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCPurchaseEvent(); event.shippingAmount = 3.33; event.taxAmount = 3.20; event.revenue = 2.5; event.value = 12.2; event.currency = "EUR"; event.type = "purchase"; event.paymentMethod = "CreditCard"; event.status = "waiting"; event.items = [tc_item_1, tc_item_2]; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "purchase", "id": "O_12345", "coupon": "CHRISTMAS", "revenue": 16.00, "value": 22.53, "shipping_amount": 3.33, "tax_amount": 3.20, "currency": "EUR", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ], "price": 9.99 } }, { "id": "SKU_12346", "quantity": 1, "price": 9.99, "variant": "green", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12346", "name": "Heart tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "girl", "brand": "Jenyfion", "colors": [ "blue", "white" ], "price": 9.99 } } ], "user": { "id": "12345", "email": "toto@domain.fr", "consent_categories": [ 1, 3 ] } } ``` {% endtab %} {% endtabs %} ## refund Déclenchez cet événement lorsqu'un achat a été remboursé #### Paramètres **(requis et recommandé)**
NomTypeRequisExempleDescription
idstringOuiO_1245ID de transaction. Utilisé comme clé pour les mises à jour
userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

Toutes les propriétés que vous ajoutez ici seront utilisées comme conditions pour faire correspondre les utilisateurs dans notre base de données.

cosent_categories est automatiquement renseigné si vous utilisez Commanders Act CMP.

revenuenumberOui16.00La valeur monétaire de l’événement (prix de livraison et taxes exclus) après remise
valuenumberOui22.53La valeur monétaire de l’événement (prix de livraison et taxes inclus) après remise
shipping_amountnumberNo3.33Frais de livraison associés à une transaction.
tax_amountnumberNo3.20Frais de livraison associés à une transaction.
currencystring (ISO 4217)OuiEURDevise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.
couponstringNoCHRISTMASCode promo utilisé pour un achat.
typestringOuiofflineType de conversion (online, offline, appel, etc.)
itemsArray<Items>No*(*) items est requis pour les remboursements partiels mais il peut être omis pour les remboursements complets.
**Ajouté automatiquement par l'API cact**
NomTypeRequisExempleDescription
urlstring(url)Nonone

URL du site web où vous pouvez acheter l'article

Équivalent à window.location.href

**Exemple** {% tabs %} {% tab title="Javascript" %} ```javascript cact('trigger','refund', { id: 'O_12345', coupon: 'CHRISTMAS', revenue: 16.00, value: 20.33, shipping_amount: 3.33, tax_amount: 3.20, currency: 'EUR', user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }) ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val event = TCRefundEvent("O_12345", 16.00f, 23.53f, "EUR", "offline") event.coupon = "CHRISTMAS" event.shippingAmount = 4.33f event.taxAmount = 3.20f serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCRefundEvent event = new TCRefundEvent("O_12345", 16.00f, 23.53f, "EUR", "offline"); event.coupon = "CHRISTMAS"; event.shippingAmount = 4.33f; event.taxAmount = 3.20f; serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithFloat: 1.5f]] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCRefundEvent *event = [[TCRefundEvent alloc] initWithID: @"2b758628-f81b-454f-8e3d-867e8bc98523" withRevenue: [[NSDecimalNumber alloc] initWithString: @"20.2"] withValue: [[NSDecimalNumber alloc] initWithString: @"26.2"] withCurrency: @"EUR" withType: @"offline" withItems: items]; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCRefundEvent(id: "purchaseID", withRevenue: 16.32, withValue: 23.1, withCurrency: "EUR", withType: "refund", withItems: [item_1, item_2]) event?.shippingAmount = 11 serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart var event = TCRefundEvent(); event.currency = "EUR"; event.value = 26.20; event.revenue = 20.20; event.coupon = "CHRISTMAS"; event.shippingAmount = 4.33; event.taxAmount = 3.20; event.type = "offline"; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "refund", "value": 8.00, "currency": "EUR", "revenue": 16.00, "shipping_amount": 3.33, "tax_amount": 3.20 } ``` {% endtab %} {% endtabs %} ## remove\_from\_cart Cet événement indique qu'un article a été retiré d'un panier. **Paramètres (requis et recommandés)**
NomTypeRequisValeur d’exempleDescription
valuenumberNo8.00

La valeur monétaire de l’événement.
()value est généralement requis pour des rapports pertinents.

()currency est requis si vous définissez value.

currencystring (ISO 4217)NoEUR

Devise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.

(*) Si vous fournissez le paramètre revenue vous devez également fournir le paramètre currency afin que les métriques de revenue puissent être calculées correctement.

userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

itemsArray<Items>OuiLes articles de l’événement.
**Exemple** {% tabs %} {% tab title="JavaScript" %} ```javascript cact('trigger','remove_from_cart', { value: 8.00, currency: 'EUR', items: [{ id: 'SKU_12345', quantity: 1, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', price: 9.99 } }], user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCRemoveFromCartEvent(items) serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCRemoveFromCartEvent event = new TCRemoveFromCartEvent(items); serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithFloat: 1.5f]] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCRemoveFromCartEvent *event = [[TCRemoveFromCartEvent alloc] initWithItems: items]; event.value = [[NSDecimalNumber alloc] initWithString: @"12.2"]; event.currency = @"EUR"; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCRemoveFromCartEvent(items: [item_1, item_2]) event?.value = 22.53 serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 10; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCRemoveFromCartEvent(); event.value = 15.1; event.currency = "EUR"; event.items = [tc_item_1]; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "remove_from_cart", "value": 8.00, "currency": "EUR", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ] } } ] } ``` {% endtab %} {% endtabs %} ## select\_item Cet événement indique qu'un article a été sélectionné dans une liste. #### Paramètres
NomTypeRequisValeur d’exempleDescription
item_list_namestringNoProduits associésLe nom de la liste dans laquelle l'article a été présenté à l'utilisateur.
itemsArray<Items>OuiLes articles pour l'événement. Le items tableau est censé avoir un seul élément, représentant l'article sélectionné.
**Exemple** {% tabs %} {% tab title="JavaScript" %} ```javascript cact('trigger','select_item', { item_list_name: 'Related products', items: [{ id: 'SKU_12345', quantity: 1, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', price: 9.99 } }], user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} 
val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1)
val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1)
val items = listOf<TCItem>(item1, item2)

val event = TCSelectItemEvent(items)
    event.itemListName = "Related products"
serverside.execute(event
{% endtab %} {% tab title="Java (Android)" %} ```java TCSelectContentEvent event = new TCSelectContentEvent(); event.contentType = "product"; serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice:[[NSDecimalNumber alloc] initWithFloat: 1.5f]] withQuantity: 1]]; TCSelectItemEvent *event = [[TCSelectItemEvent alloc] initWithItems: items]; event.itemListName = @"Related products"; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCSelectItemEvent(items: [item_1, item_2]) event.itemListName = "Related products"; serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 150; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCSelectItemEvent(); event.itemListName = "Related products"; event.items = [tc_item_1]; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "select_item", "item_list_name": "Related products", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ] } } ] } ``` {% endtab %} {% endtabs %} ## view\_cart Cet événement indique qu'un utilisateur a consulté son panier. **Paramètres (requis et recommandés)**
NomTypeRequisValeur d’exempleDescription
valuenumberNo8.00

La valeur monétaire de l’événement.
()value est généralement requis pour des rapports pertinents.

()currency est requis si vous définissez value.

currencystring (ISO 4217)NoEUR

Devise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.

(*) Si vous fournissez le paramètre revenue vous devez également fournir le paramètre currency afin que les métriques de revenue puissent être calculées correctement.

userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

itemsArray<Items>OuiLes articles de l’événement.
**Exemple** {% tabs %} {% tab title="JavaScript" %} ```javascript cact('trigger','view_cart', { value: 8.00, currency: 'EUR', items: [{ id: 'SKU_12345', quantity: 1, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', price: 9.99 } }], user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCViewCartEvent(items); event.value = 15.1f event.currency = "EUR" serverside.execute(event); ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCViewCartEvent event = new TCViewCartEvent(items); event.value = 15.1f; event.currency = "EUR"; serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithString: @"1.5"]] withQuantity: 1]]; TCViewCartEvent *event = [[TCViewCartEvent alloc] initWithItems: items]; event.value = [[NSDecimalNumber alloc] initWithString: @"12.2"]; event.currency = @"EUR"; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCViewCartEvent(items: [item_1, item_2]) event?.value = 22.53 serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 10; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); TCProduct tc_product_2 = TCProduct(); tc_product_2.ID = "product_2_ID"; tc_product_2.name = "product_2_name"; tc_product_2.price = 5.10; tc_product_2.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_2 = TCItem(); tc_item_2.ID = "item_2_id"; tc_item_2.quantity = 2; tc_item_2.product = tc_product; tc_item_2.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCViewCartEvent(); event.value = 15.1; event.currency = "EUR"; event.items = [tc_item_1, tc_item_2 serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "view_cart", "value": 8.00, "currency": "EUR", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ] } } ] } ``` {% endtab %} {% endtabs %} ## view\_item Cet événement indique qu'un contenu a été affiché à l'utilisateur. Utilisez cet événement pour gérer les articles les plus consultés. **Paramètres (requis et recommandés)**
NomTypeRequisValeur d’exempleDescription
revenuenumberOui*9.99

La valeur monétaire de l’événement.
()revenue est généralement requis pour des rapports pertinents.

()currency est requis si vous définissez revenue.

currencystring (ISO 4217)Yes*EURDevise de l’achat ou des articles associés à l’événement, au format ISO 4217 à 3 lettres.
userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

itemsArray<Items>OuiLes articles de l’événement.
**Exemple** {% tabs %} {% tab title="JavaScript" %} ```javascript cact('trigger','view_item', { value: 8.00, currency: 'EUR', items: [{ id: 'SKU_12345', quantity: 1, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', price: 9.99 } }], user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCViewItem(items) serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ```java TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCViewItem event = new TCViewItem(items); serverside.execute(event); ``` {% endtab %} {% tab title="Objective-C (iOS)" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: [[NSDecimalNumber alloc] initWithString: @"1.5"]] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCViewItem *event = [[TCViewItem alloc] initWithItems: items]; event.revenue = [[NSDecimalNumber alloc] initWithString: @"12.2"]; event.currency = @"EUR"; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift (iOS)" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCViewItem(items: [item_1, item_2]) event?.revenue = 12.2 serverside?.execute(event) ``` {% endtab %} {% tab title="Dart (Flutter)" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 150; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCViewItemEvent(); event.pageName = "event_page_name"; event.pageType = "event_page_type"; event.items = [tc_item_1]; event.addAdditionalPropertyWithIntValue("key_additional_1", 12); event.addAdditionalPropertyWithListValue("key_additional_2", [12,12,12]); event.addAdditionalPropertyWithMapValue("key_map", {'test': 12, "test2": "value"}); serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "view_item", "value": 8.00, "currency": "EUR", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ] } } ] } ``` {% endtab %} {% endtabs %} ## view\_item\_list Consignez cet événement lorsque l'utilisateur s'est vu présenter une liste d'articles d'une certaine catégorie. #### Paramètres
NomTypeRequisValeur d’exempleDescription
item_list_namestringNoProduits associésLe nom de la liste dans laquelle l'article a été présenté à l'utilisateur.
userObject<User>Oui

{
id: '12345',
email: 'toto@domain.fr',

consent_categories: [1,3]

}

consent_categories est la liste des consentements de l’utilisateur. Elle est automatiquement remplie à partir des sources web si vous utilisez Commanders Act CMP.

Vous devriez également ajouter toutes les propriétés de l’utilisateur dans cet objet user, en particulier la clé de rapprochement (id, email).

itemsArray<Items>OuiLes articles de l’événement.
**Exemple** {% tabs %} {% tab title="Javascript" %} ```kotlin cact('trigger','view_item_list', { item_list_name: 'Related products', items: [{ id: 'SKU_12345', quantity: 1, price: 9.99, variant: 'red', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12345', name: 'Trex tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'boy', brand: 'Lacoste', colors: ['red'], price: 9.99 } }, { id: 'SKU_12346', quantity: 1, price: 9.99, variant: 'green', coupon: 'CHRISTMAS', discount: 1.99, product:{ id: '12346', name: 'Heart tshirt', category_1: 'clothes', category_2: 't-shirts', category_3: 'girl', brand: 'Jenny', colors: ['blue','white'], price: 9.99 } }], user: { id: '12356', email:'toto@domain.fr', consent_categories: [1,3] } }); ``` {% endtab %} {% tab title="Kotlin (Android)" %} ```kotlin val item1 = TCItem("my_product1_id", TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1) val item2 = TCItem("my_product2_id", TCProduct("my_product_2_id", "my_product_2_name", 110f), 1) val items = listOf(item1, item2) val event = TCViewItemList(items) event.itemListName = "your products" serverside.execute(event) ``` {% endtab %} {% tab title="Java (Android)" %} ``` TCItem item1 = new TCItem("my_product1_id", new TCProduct("my_product_1_id", "my_product_1_name", 12.5f), 1); TCItem item2 = new TCItem("my_product2_id", new TCProduct("my_product_2_id", "my_product_2_name", 25.6f), 1); ArrayList items = new ArrayList<>(Arrays.asList(item1, item2)); TCViewItemListEvent event = new TCViewItemListEvent(items); event.itemListName = "your products"; serverside.execute(event); ``` {% endtab %} {% tab title="iOS" %} ```objectivec NSMutableArray *items = [[NSMutableArray alloc] init]; [items addObject: [[TCItem alloc] initWithItemId: @"iID1" withProduct: [[TCProduct alloc] initWithProductId: @"pID1" withName: @"pName1" withPrice: @1.5f] withQuantity: 1]]; [items addObject: [[TCItem alloc] initWithItemId: @"iID2" withProduct: [[TCProduct alloc] initWithProductId: @"pID2" withName: @"pName2" withPrice: [[NSDecimalNumber alloc] initWithFloat: 2.5f]] withQuantity: 2]]; TCViewItemListEvent *event = [[TCViewItemListEvent alloc] initWithItems: items]; event.itemListName = @"summer_collection"; [TCS execute: event]; ``` {% endtab %} {% tab title="Swift" %} ```swift let item_1:TCItem = TCItem(itemId: "my_item1.id", with: TCProduct(productId: "my_product1.id", withName: "my_product1.name", withPrice: 12.5), withQuantity: 1) let item_2:TCItem = TCItem(itemId: "my_item2.id", with: TCProduct(productId: "my_product2.id", withName: "my_product2.name", withPrice: 22.5), withQuantity: 1) let event = TCViewItemListEvent(items: [item_1, item_2]) event?.itemListName = "summer_collection" serverside?.execute(event) ``` {% endtab %} {% tab title="Flutter" %} ```dart TCProduct tc_product = TCProduct(); tc_product.ID = "product_1_ID"; tc_product.name = "product_1_name"; tc_product.price = 150; tc_product.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_1 = TCItem(); tc_item_1.ID = "item_1_id"; tc_item_1.product = tc_product; tc_item_1.quantity = 1; tc_item_1.addAdditionalProperty("key_additional_item", "val_additional_product"); TCProduct tc_product_2 = TCProduct(); tc_product_2.ID = "product_2_ID"; tc_product_2.name = "product_2_name"; tc_product_2.price = 150; tc_product_2.addAdditionalProperty("key_additional_product", "val_additional_product"); TCItem tc_item_2 = TCItem(); tc_item_2.ID = "item_2_id"; tc_item_2.quantity = 2; tc_item_2.product = tc_product; tc_item_2.addAdditionalProperty("key_additional_item", "val_additional_product"); var event = TCViewItemListEvent(); event.pageName = "event_page_name"; event.pageType = "event_page_type"; event.items = [tc_item_1, tc_item_2]; event.addAdditionalPropertyWithIntValue("key_additional_1", 12); event.addAdditionalPropertyWithListValue("key_additional_2", [12,12,12]); event.addAdditionalPropertyWithMapValue("key_map", {'test': 12, "test2": "value"}); event.itemListName = "itemListName"; serverside.execute(event); ``` {% endtab %} {% tab title="json" %} ```json { "event_name": "view_item_list", "item_list_name": "Related products", "items": [ { "id": "SKU_12345", "quantity": 1, "price": 9.99, "variant": "red", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12345", "name": "Trex tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "boy", "brand": "Lacoste", "colors": [ "red" ], "price": 9.99 } }, { "id": "SKU_12346", "quantity": 1, "price": 9.99, "variant": "green", "coupon": "CHRISTMAS", "discount": 1.99, "product": { "id": "12346", "name": "Heart tshirt", "category_1": "clothes", "category_2": "t-shirts", "category_3": "girl", "brand": "Jenyfion", "colors": [ "blue", "white" ], "price": 9.99 } } ], "user": { "id": "12345", "email": "toto@domain.fr", "consent_categories": [ 1, 3 ] } } ``` {% endtab %} {% endtabs %} ## - SCHÉMAS COMMUNS - ### Items #### Paramètres **(requis et recommandé)** | Nom | Type | Requis | Valeur d’exemple | Description | | --------------- | ----------------------------- | -------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | `string` | **Oui** | SKU\_12345 |

L'ID d'un article.

Si vous n'avez pas d'ID d'article, vous pouvez utiliser l'ID produit comme valeur. Ce champ est utilisé comme clé pour les mises à jour (ex : refund)

| | `product` | [`Object`](#product) | **Oui** | | Les détails du produit | | `variant` | `string` | No | red | La variante de l'article. | | `list_position` | `number` | No | 1 | La position de l'article dans une liste ou une collection. | | `discount` | `number` | No | 2.00 | Valeur monétaire de la remise associée à un achat | | `quantity` | `number` | **Oui** | 2 | La quantité de l'article. | | `affiliation` | `string` | **No**\* | DOWNLOAD | Requis pour la plupart des destinations d'affiliation. | | `coupon` | `string` | No | CHRISTMAS | Le code promo associé à un article. | ### Product **Paramètres (requis et recommandés)** | Nom | Type | Requis | Valeur d’exemple | Description | | ------------ | ------------------- | --------- | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | `string` | **Oui**\* | 12345 |

L'ID du produit (ex : dans la base de données de votre catalogue produits)
L' item.id et product.id n'ont pas besoin d'être différents. S'ils sont différents, en général le product.id est un identifiant de base de données, comme 9714107479 and the item.id est un identifiant public comme SKU-12345.

(\*) Si vous avez importé le catalogue de vos produits dans la plateforme, le product.id correspond à l'ID produit unique du catalogue et peut être utilisé avec la fonctionnalité d'expansion d'ID.

| | `name` | `string` | **Oui** | Trex | Nom du produit | | `price` | `number` | **Oui** | 14.99 | Le prix du produit | | `currency` | `string (ISO 4217)` | No | EUR |

Devise du price, au format ISO 4217 à 3 lettres.

Si défini, le niveau d'événement currency est ignoré.

Les devises multiples par événement ne sont pas prises en charge. Chaque article doit utiliser la même devise.

| | `category_1` | `string` | No | T-Shirts | Catégorie de produit (selon le contexte). `item_category2` à `item_category5` peuvent également être utilisés si le produit possède de nombreuses catégories. | | `brand` | `string` | No | Lacoste | Marque du produit | | `colors` | `Array[string]` | No | \[blue, white] | La/les couleur(s) du produit | | `size` | `string` | No | 128 | Taille de l'article | ### User Lorsque vous envoyez un événement, il doit contenir suffisamment d'informations pour identifier quel utilisateur l'a généré. Nous pouvons relier les événements entre eux à l'aide des cookies. Mais les partenaires de destination ont besoin d'identifiants précis pour agir. `id` et `email` sont généralement les paramètres les plus utiles. Cependant, certains partenaires de destination utilisent aussi `firstname`, `lastname`, `birthdate`, `city`, ... Vous n'aurez pas toujours tous ces paramètres. Mais il est recommandé de les envoyer dès que possible pendant la navigation de l'utilisateur. #### Paramètres **(requis et recommandé)**
NomTypeRequisValeur d’exempleDescription
idstringNo*845454

Identifiant principal de l'utilisateur (ex. ID CRM)

(*) requis pour de nombreuses destinations et pour le traitement interne.

emailstringYes*john.doe@example.com

Email (valeur en clair)

(*) requis pour de nombreuses destinations et pour le traitement interne. Non requis si email_sha256 est fourni

email_md5stringNo*8eb1b52... (size 32)Email, haché avec l' algorithme MD5. Non requis si email est fourni (voir ci-dessous)
email_sha256stringNo*836f82d... (size 64)Email, haché avec l' algorithme SHA-256. Non requis si email est fourni (voir ci-dessous)
phonestringNo*+33612345678Numéro de téléphone, E.164 format
(*) requis pour certaines destinations.
firstnamestringNoJohnPrénom
lastnamestringNoDoeNom de famille
genderstringNom

Genre

  • f pour Femme
  • m pour Homme
birthdatestringNo1970-01-01Date de naissance, YYYY-MM-DD format
citystringNoBostonVille
statestringNoMassachusettsÉtat
zipcodestringNo02108Code postal
countrystringNoUSACode pays, ISO 3166-1 2 lettres ou 3 lettres formats
consent_categoriesArrayOui[1,2,3]Catégories de consentement de l'utilisateur.
Nécessaire pour accorder le partage de données avec les partenaires de destination. Il est automatiquement renseigné à partir des sources web si vous utilisez Commanders Act CMP.
**À propos du hachage** Dans certains cas, vous ne pourrez pas envoyer un paramètre **en clair** . Il est soit indisponible, soit restreint. Il peut donc être possible d'envoyer les **hachées** valeurs. Nous acceptons actuellement 2 algorithmes : [`md5`](https://en.wikipedia.org/wiki/MD5) et [`sha256`](https://en.wikipedia.org/wiki/SHA-2). Chaque `user.` peut être envoyé au format haché avec le suffixe d'algorithme : `_md5` ou `_sha256` *(underscore suivi du nom de l'algorithme en minuscules)* Exemple : ``` { user: { email_md5: '8eb1b522f60d11fa897de1dc6351b7e8', // md5('john.doe@example.com') email_sha256: '836f82db99121b3481011f16b49dfa5fbc714a0d1b1b9f784a1ebbbf5b39577f', // sha256('john.doe@example.com') phone_md5: '60dd761f55cb17f0532c9fb1679e8ddd', // md5('+33612345678') phone_sha256: '42d573cfc315801d4cd8eddd5416b416a0bf298b9b9e12d6b07442c91db42bd8', // sha256('+33612345678') } } ``` > :information\_source: we only support hex (base16) encoding\ > \&#xNAN;*(i.e.: **hachées** values are carried by strings with \[0-9a-f] characters)*\ > Other encodings are not supported yet No need to send both **en clair** et **hachées** values : * if you send **en clair** value, the **hachées** values aren't necessary\ \&#xNAN;*We can generate **hachées** values on server side using **en clair** value* * if you don't send **en clair** value, then you should fill as much **hachées** values as possible\ \&#xNAN;*Partners require different hash algorithms and without **en clair** value, we can't generate any hash. That's why we need the exact **hachées** value* ## - ENUMERATED VALUE - ### Payment methods Enumerated Values for payment methods : | Property | Value | | --------------- | -------------------------------- | | payment\_method | by\_invoice | | payment\_method | by\_bank\_transfer\_in\_advance | | payment\_method | card | | payment\_method | paiement\_à\_l'avance | | payment\_method | paiement\_à\_la\_livraison | | payment\_method | coupon | | payment\_method | prélèvement\_automatique | | payment\_method | système\_de\_paiement\_en\_ligne | | payment\_method | autre | ### Statut d'achat Valeurs énumérées pour le statut d'achat :
PropertyValue
statusannulé
statuslivré
statusin_progress
statuspartiellement_livré
statuspartiellement_retourné
statuspartiellement_expédié
statusen_attente_d'expédition
statusretourné
statusexpédié
statusen_attente
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://doc.commandersact.com/fr/developers/tracking-and-integrations/tracking/events-reference/e-commerce-events.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.