Order Events (Legacy)

Aperçu

The Order event represents the key events once the customer finishes the checkout process, completes the purchase, and the order confirmation page loads.

Affirm’s machine learning systems draw upon this transaction data to improve our marketing products offsite and onsite, providing better and more relevant converting financial offers to your customers over time.

trackOrderConfirmed (Order, Optional[Strict])

Un événement s'est déclenché lorsqu'un client effectue l'achat. Vous pouvez mesurer la vente d'un ou plusieurs produits par cet événement.

Paramètres

Paramètres	Type de données	Description
`order` required	objet	La commande confirmée.
`strict` optional	boolean	Drapeau True/False, afin de s'assurer que `currency`, `orderID`, `paymentMethod` et total sont envoyés dans le objet `Order`. Cette valeur doit être vraie pour pouvoir utiliser la nouvelle mise en œuvre des analyses améliorées.

Exemple

affirm.analytics.trackOrderConfirmed({
   "currency": "USD",
   "orderId": "AA-87654",
   "paymentMethod": "Affirm",
   "total": 23595
}, null, true);

trackOrderCancelled ([Order], Optional, [Product], Optional[Strict])

Un événement s'est déclenché lorsqu'un utilisateur annule une commande.

Paramètres

Paramètre	Type de données	Description
`order` required	objet	La commande annulée.
`product` optional	array	Produits annulés par cette commande.
`strict` optional	boolean	Drapeau True/False, afin de s'assurer que `currency`, `orderID`, `paymentMethod` et total sont envoyés dans le objet `Order`. Cette valeur doit être vraie pour pouvoir utiliser la nouvelle mise en œuvre des analyses améliorées.

Exemple

affirm.analytics.trackOrderCancelled({
    "storeName": "Affirm Store",
    "coupon": "SUMMER2018",
    "currency": "USD",
    "discount": 0,
    "paymentMethod": "Visa",
    "revenue": 2920,
    "shipping": 534,
    "shippingMethod": "Fedex",
    "tax": 285,
    "orderId": "T12345",
    "total": 3739
}, [{
    "brand": "Affirm",
    "category": "Apparel",
    "coupon": "SUMMER2018",
    "name": "Affirm T-Shirt",
    "price": 730,
    "productId": "SKU-1234",
    "quantity": 1,
    "variant": "Black"
}, {
    "brand": "Affirm",
    "category": "Apparel",
    "coupon": "SUMMER2018",
    "name": "Affirm Turtleneck Sweater",
    "price": 2190,
    "productId": "SKU-5678",
    "quantity": 1,
    "variant": "Black"
}]);

trackOrderRefunded (String, String, Integer, Optional, [Product])

Un événement est déclenché lorsqu'une commande est partiellement ou entièrement remboursée.

Paramètres

Paramètre	Type de données	Description
`orderId` required	string	Un identifiant unique représentant la transaction à rembourser totalement ou partiellement.
`amount` required	integer	Le montant à rembourser, partiellement ou entièrement.
`currency`	string	Code de devise ISO à trois lettres, en majuscules. Valeurs possibles : - USD - CAD
`product` optional	array	Un tableau d’objets représentant les produits de la commande en corrélation avec le montant du remboursement.

Exemple

affirm.analytics.trackOrderRefunded(
    "O12345", 3739, "USD",
    [{
        "brand": "Affirm",
        "category": "Apparel",
        "coupon": "SUMMER2018",
        "name": "Affirm T-Shirt",
        "price": 730,
        "productId": "SKU-1234",
        "quantity": 1,
        "variant": "Black"
    }, {
        "brand": "Affirm",
        "category": "Apparel",
        "coupon": "SUMMER2018",
        "name": "Affirm Turtleneck Sweater",
        "price": 2190,
        "productId": "SKU-5678",
        "quantity": 1,
        "variant": "Black"
    }]
);

trackOrderUpdated ([Order], Optional, [Product], Optional[Strict])

Un événement est déclenché lorsqu'un utilisateur met à jour une commande.

Paramètres

Paramètre	Type de données	Description
`order` required	objet	L'ordre mis à jour.
`product` optional	array	Produits mis à jour par cette commande.
`strict` optional	boolean	Drapeau True/False, afin de s'assurer que `currency`, `orderID`, `paymentMethod` et total sont envoyés dans le objet `Order`. Cette valeur doit être vraie pour pouvoir utiliser la nouvelle mise en œuvre des analyses améliorées.

Exemple

affirm.analytics.trackOrderUpdated({
    "storeName": "Affirm Store",
    "coupon": "SUMMER2018",
    "currency": "USD",
    "discount": 0,
    "paymentMethod": "Visa",
    "revenue": 2920,
    "shipping": 534,
    "shippingMethod": "Fedex",
    "tax": 285,
    "orderId": "T12345",
    "total": 3739
}, [{
    "brand": "Affirm",
    "category": "Apparel",
    "coupon": "SUMMER2018",
    "name": "Affirm T-Shirt",
    "price": 730,
    "productId": "SKU-1234",
    "quantity": 1,
    "variant": "Black"
}, {
    "brand": "Affirm",
    "category": "Apparel",
    "coupon": "SUMMER2018",
    "name": "Affirm Turtleneck Sweater",
    "price": 2190,
    "productId": "SKU-5678",
    "quantity": 1,
    "variant": "Black"
}]);

Objets

commande

Représente la transaction de paiement d'un seul client. Cela inclut les paramètres liés à la transaction une fois que le client a effectué son paiement.

Paramètre		Description
`order` required	string	Identifiant unique de la commande dans votre système
`currency` style="color:crimson">required	string	Code de devise ISO à trois lettres, en majuscules. Valeurs possibles : - USD - CAD
`paymentMethod` required	string	Description du mode de paiement utilisé (ex. « Visa », « Mastercard », « Carte cadeau »)
`total` required	integer	La valeur totale de la transaction, y compris les taxes et l'expédition. Si elle n'est pas envoyée, cette valeur sera automatiquement calculée à l'aide des champs de quantité et de prix de tous les produits du même hit. La valeur doit être non négative et représentée en cents au lieu de dollars.

Produit

Représente tout produit ou service proposé.

Paramètre		Description
marque optionnel	string Maximum length: 500 Protocol parameter: `prbr`	La marque du produit (par ex. Affirm).
Catégorie optionnel	string Maximum length: 500 Protocol parameter: `prca`	La catégorie à laquelle appartient le produit (ex. Vêtements).
coupon optionnel	string Maximum length: 500 Protocol parameter: `prcc`	Tout code promotionnel associé à l'instance particulière de ce produit.
name optionnel	string Maximum length: 500 Protocol parameter: `osn`	Le nom complet du produit (par ex. le t-shirt Affirm).
Prix optionnel	integer Protocol parameter: `prpr`	Le prix du produit. La valeur doit être non négative et représentée en cents au lieu de dollars.
productID optionnel	string Maximum length: 500 Protocol parameter: `prid`	Un identifiant unique représentant le produit, comme le SKU ou un identifiant de base de données interne utilisé par le vendeur.
quantity optionnel	integer Protocol parameter: `prqt`	La quantité du produit. La valeur doit être non négative.
variante optionnel	string Maximum length: 500 Protocol parameter: `prva`	La variante du produit (par ex. noir).
currency optionnel	string Protocol parameter: `prcu`	Un code de devise associé à ce produit (USD).