Ce point de terminaison calcule combien de points un achat rapporterait, sans donner aucun point. Utilisez-le pour afficher des messages comme « Gagnez 120 points avec cette commande » sur une page produit, dans le panier ou au moment du paiement.

Le calcul utilise les réglages de votre moyen de gagner lié aux achats, les campagnes de boost actives et, si vous envoyez un client, son niveau VIP.

Point de terminaison 

GET https://api.jericommerce.com/v1/programs/{program_slug}/balance-preview?amount=4990&currency=EUR

Ce point de terminaison est public : il n’a pas besoin de clé API et vous pouvez l’appeler depuis votre boutique en ligne.

Paramètres de requête

Paramètre Obligatoire Notes
amount Oui Le montant de la commande en centimes. Par exemple, 4990 pour 49,90.
currency Oui La devise de amount, sous forme de code à trois lettres comme EUR ou USD. Si ce n’est pas la devise de votre programme, le montant est d’abord converti.
customerEmail Non Ajoutez-le pour appliquer le facteur de niveau du client. Si aucun client n’a cette adresse e-mail, l’API répond 404.
sourceName Non web (par défaut) ou pos. Utilisez pos pour les ventes en magasin, afin que les boosts limités à un canal de vente soient appliqués correctement.
locationId Non L’identifiant d’emplacement Shopify, utilisé avec sourceName=pos pour les boosts limités à certains magasins.

Réponse 

{
  "balance": 100,
  "tierBalance": 50
}
Champ Notes
balance Les points que le client gagnerait.
tierBalance Les points de niveau que le client gagnerait pour son niveau VIP.
appliedBoost Présent uniquement lorsqu’une campagne de boost s’applique à cet achat.

Lorsqu’un boost s’applique, appliedBoost explique la différence :

{
  "balance": 200,
  "tierBalance": 50,
  "appliedBoost": {
    "id": "3c2b1a0f-...",
    "name": "Double points weekend",
    "pointsMultiplier": 2,
    "tierMultiplier": 1,
    "unboostedBalance": 100,
    "boostedBalance": 200,
    "unboostedTierBalance": 50,
    "boostedTierBalance": 50
  }
}

Le résultat est une estimation à l’instant présent. Les points que le client reçoit réellement sont calculés lors de la commande : ils peuvent donc différer si vos réglages ou vos boosts changent entre-temps.

Erreurs

Code Statut Signification
PROGRAM_NOT_FOUND 404 Le slug ou l’identifiant du programme dans l’URL n’existe pas.
CUSTOMER_NOT_FOUND 404 Vous avez envoyé un customerEmail qui n’appartient à aucun client.
Erreurs de validation 400 amount est absent ou n’est pas un nombre, ou sourceName n’est ni web ni pos.