Dieser Endpunkt berechnet, wie viele Punkte ein Einkauf einbringen würde, ohne Punkte zu vergeben. Verwenden Sie ihn für Hinweise wie „Sammeln Sie 120 Punkte mit dieser Bestellung“ auf einer Produktseite, im Warenkorb oder an der Kasse.

Die Berechnung nutzt die Einstellungen Ihrer Sammelaktion für Einkäufe (siehe Sammelaktionen), aktive Boost-Kampagnen und, wenn Sie einen Kunden mitsenden, dessen VIP-Stufe.

Endpunkt 

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

Dieser Endpunkt ist öffentlich, benötigt also keinen API-Schlüssel, und Sie können ihn aus Ihrem Shop aufrufen.

Query-Parameter

Parameter Erforderlich Hinweise
amount Ja Der Bestellwert in Cent. Zum Beispiel 4990 für 49.90.
currency Ja Die Währung von amount, als dreistelliger Code wie EUR oder USD. Ist es nicht die Währung Ihres Programms, wird der Betrag zuerst umgerechnet.
customerEmail Nein Senden Sie sie mit, um den Stufenfaktor des Kunden anzuwenden. Gibt es keinen Kunden mit dieser E-Mail-Adresse, antwortet die API mit 404.
sourceName Nein web (Standard) oder pos. Verwenden Sie pos für Verkäufe im Geschäft, damit Boosts, die auf einen Vertriebskanal beschränkt sind, richtig angewendet werden.
locationId Nein Die Shopify-Standort-ID, zusammen mit sourceName=pos für Boosts, die auf bestimmte Geschäfte beschränkt sind.

Antwort 

{
  "balance": 100,
  "tierBalance": 50
}
Feld Hinweise
balance Die Punkte, die der Kunde erhalten würde.
tierBalance Die Stufenpunkte, die der Kunde für seine VIP-Stufe erhalten würde.
appliedBoost Nur vorhanden, wenn für diesen Einkauf eine Boost-Kampagne gilt.

Gilt ein Boost, erklärt appliedBoost den Unterschied:

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

Das Ergebnis ist eine Schätzung für den aktuellen Zeitpunkt. Die Punkte, die der Kunde tatsächlich erhält, werden bei der Bestellung berechnet. Sie können daher abweichen, wenn sich Ihre Einstellungen oder Boosts zwischenzeitlich ändern.

Fehler

Code Status Bedeutung
PROGRAM_NOT_FOUND 404 Der Program-Slug oder die Program ID in der URL existiert nicht.
CUSTOMER_NOT_FOUND 404 Sie haben eine customerEmail gesendet, die zu keinem Kunden gehört.
Validierungsfehler 400 amount fehlt oder ist keine Zahl, oder sourceName ist weder web noch pos.