Checkout Events

Aperçu

L'événement Checkout représente le parcours du client lorsqu'il navigue dans le processus de paiement.

trackCheckoutStarted: (Order, Optional[Product], Optional[Strict])

Événement déclenché une fois que le processus de paiement commence pour le client, généralement sur la page vers laquelle le client accède après avoir appuyé sur le bouton de paiement.

Paramètres

Paramètre	Type de données	Description
`order` required	objet	La commande associée à ce paiement.
'produit' facultatif	array	Produits faisant partie de la 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.trackCheckoutStarted({
    "storeName": "Affirm Store",
    "coupon": "SUMMER2018",
    "currency": "USD",
    "discount": 0,
    "revenue": 2920,
    "shipping": 534,
    "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"
}]);

trackCheckoutStepViewed (Integer, Order, Optional[Strict])

Un événement s'est déclenché lorsque le client consulte une étape de paiement distincte qui fait partie du processus de paiement.

Paramètres

Paramètre	Type de données	Description
`step` required	integer	Un nombre incrémentiel représentant l'étape actuelle du processus de paiement.
`order` required	objet	La commande associée à ce paiement.
`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.trackCheckoutStepViewed(1, {
    "storeName": "Affirm Store",
    "coupon": "SUMMER2018",
    "currency": "USD",
    "discount": 0,
    "revenue": 2920,
    "shipping": 534,
    "tax": 285,
    "orderId": "T12345",
    "total": 3739
});

trackCheckoutStepCompleted (Integer, Order, Optional[Strict])

Un événement s'est déclenché lorsque le client effectue une étape de paiement distincte qui fait partie du processus de paiement.

Paramètres

Paramètre	Type de données	Description
`step` required	integer	Un nombre incrémentiel représentant l'étape actuelle du processus de paiement.
`order` required	objet	La commande associée à ce paiement.
`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.trackCheckoutStepCompleted(1, {
    "storeName": "Affirm Store",
    "coupon": "SUMMER2018",
    "currency": "USD",
    "discount": 0,
    "revenue": 2920,
    "shipping": 534,
    "shippingMethod": "Fedex",
    "tax": 285,
    "orderId": "T12345",
    "total": 3739
});

trackCheckoutPaymentOrdered (Integer, Order, Optional[Strict])

Un événement s'est déclenché lorsque le client effectue une étape de paiement distincte qui fait partie du processus de paiement.

Paramètres

Paramètre	Type de données	Description
`step` required	integer	Un nombre incrémentiel représentant l'étape actuelle du processus de paiement.
`order` required	objet	La commande associée à ce paiement.
`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.

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
storeName optionnel	string Maximum length: 500 Protocol parameter: `osn`	Nom du magasin responsable de cette transaction. (par ex., magasin Affirm).
checkoutId optional	string Maximum length: 500 Protocol parameter: `oci`	Identifiant unique représentant le passage à la caisse, s'il est conceptuellement distinct d'une commande. Sinon seul le `orderId` est nécessaire.
couponCode optionnel	string Maximum length: 500 Protocol parameter: `occ`	Le code promotionnel appliqué à la commande (par ex. SUMMER2018).
currency optionnel	string Maximum length: 500 Protocol parameter: `occ`	La devise locale pour toutes les valeurs de devise de transaction. La valeur doit être un sous-ensemble valide du code de devise ISO 4217.
discount optionnel	integer Protocol parameter: `od`	Remise totale associée à la transaction. La valeur doit être non négative et représentée en unités mineures, telles que des cents au lieu de dollars.
orderID optionnel	string Maximum length: 500 Protocol parameter: `ooi`	Identificateur unique représentant la commande/transaction.
paymentMethod optionnel	string Maximum length: 150 Protocol parameter: `opm`	Le mode de paiement choisi par le client pour la transaction (par ex., Visa).
revenue optionnel	integer Protocol parameter: `or`	Revenu associé à la transaction, hors frais d'expédition, taxe totale et remises. La valeur doit être non négative et représentée en cents au lieu de dollars.
Expédition optionnel	integer Protocol parameter: `os`	Les frais de livraison associés à la transaction.
shippingMethod optionnel	string Maximum length: 150 Protocol parameter: `osm`	Le mode de livraison choisi par le client pour la transaction (par ex., Fedex).
taxes optionnel	integer Protocol parameter: `otx`	La taxe totale associée à la transaction. La valeur doit être non négative et représentée en cents au lieu de dollars.
Total optionnel	integer Protocol parameter: `ot`	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).