Questo endpoint calcola quanti punti farebbe guadagnare un acquisto, senza assegnare alcun punto. Usalo per mostrare messaggi come "Guadagna 120 punti con questo ordine" in una pagina prodotto, nel carrello o al checkout.

Il calcolo usa le impostazioni del modo per accumulare legato agli acquisti, le campagne boost attive e, se invii un cliente, il suo livello VIP.

Endpoint 

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

Questo endpoint è pubblico, quindi non richiede una chiave API e puoi chiamarlo dal tuo storefront.

Parametri della query

Parametro Obbligatorio Note
amount Sì L'importo dell'ordine in centesimi. Per esempio, 4990 per 49,90.
currency Sì La valuta di amount, come codice di tre lettere, per esempio EUR o USD. Se non è la valuta del programma, l'importo viene prima convertito.
customerEmail No Includila per applicare il fattore di livello del cliente. Se nessun cliente ha questa email, l'API risponde 404.
sourceName No web (predefinito) oppure pos. Usa pos per le vendite in negozio, così i boost limitati a un canale di vendita vengono applicati correttamente.
locationId No L'ID della sede Shopify, da usare con sourceName=pos per i boost limitati ad alcuni negozi.

Risposta 

{
  "balance": 100,
  "tierBalance": 50
}
Campo Note
balance I punti che il cliente guadagnerebbe.
tierBalance I punti livello che il cliente guadagnerebbe per il suo livello VIP.
appliedBoost Presente solo quando una campagna boost si applica a questo acquisto.

Quando si applica un boost, appliedBoost spiega la differenza:

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

Il risultato è una stima valida per il momento attuale. I punti che il cliente riceve davvero vengono calcolati quando l'ordine viene effettuato, quindi possono essere diversi se nel frattempo cambiano le tue impostazioni o i boost.

Errori

Codice Stato Significato
PROGRAM_NOT_FOUND 404 Lo slug o l'ID del programma nell'URL non esiste.
CUSTOMER_NOT_FOUND 404 Hai inviato un customerEmail che non appartiene a nessun cliente.
Errori di validazione 400 amount manca o non è un numero, oppure sourceName non è web o pos.