Sie können Treueinformationen eines Kunden über den dafür vorgesehenen Endpunkt erstellen oder aktualisieren. Als Anfrage-Body wird ein Array von Objekten übergeben.

// API POST
https://api.jericommerce.com/v1/programs/{{program_id}}/integrations/api

Der Kunde muss bereits über die API angelegt worden sein, bevor Sie Treueinformationen hinzufügen.

Sie können Kunden- und Treueinformationen in derselben API-Anfrage senden. Achten Sie darauf, zuerst die Kundeninformationen anzugeben.

Der Kunde muss bereits angelegt sein, bevor Treueinformationen hinzugefügt werden.

Beispiel für den Body zum Aktualisieren eines Kunden:

[
  {
    "email": "{{customer_email}}",
    "feature": "loyalty",
    "payload": {
      "loyaltyCustomerId": "{{customer_loyalty_id}}",
      "balance": "{{balance_to_apply}}",
      "memberSince": "{{customer_join_date}}",
      "tierStatus": "{{customer_tier}}"
    }
  }
]

Payload-Eigenschaften

loyaltyCustomerId

Dies ist die externe Kennung dieser Treueinformationen. Sie ist hilfreich, wenn Sie die Daten mit einer anderen Datenbank verknüpfen müssen. Sie ist bei jeder Anfrage erforderlich.

Balance

Der Kundenpunktestand ist eine der wichtigsten Eigenschaften. Die API berechnet keinen Wert, sondern aktualisiert den Punktestand mit dem in der Anfrage übergebenen Wert. Das Feld ist erforderlich, muss eine Zahl enthalten und stets größer als 0 sein.

memberSince

Das Datum, an dem sich der Kunde für Ihr Treueprogramm registriert hat. Das erforderliche Feld muss im ISO-String-Format übermittelt werden. Es ist bei jeder Anfrage erforderlich.

tierStatus

Je nach Treueprogramm können Stufen vorhanden sein oder nicht. Hier können Sie den Stufennamen eintragen. Diese optionale Eigenschaft ist ein String und kann den gewünschten Wert enthalten.

Öffentlichen Prämienkatalog abrufen

Verwenden Sie diesen Endpunkt, um den Prämienkatalog des Programms abzurufen:

GET https://api.jericommerce.com/v1/programs/{{program_id}}/coupons/rewards-public

Die Antwort ist ein Array mit Prämien. Die Katalogfelder umfassen id, title, description, image, redeemCost, order, visibilityRules und redeemabilityRules. Der Endpunkt gibt Katalogdaten zurück und keine kundenbezogene Liste der Prämien, die der Kunde gerade einlösen kann.

Die Felder type, currencyPerPoint, minPoints und maxPoints beschreiben den Prämientyp und die Umrechnungsgrenzen. Points as cash im Adminbereich entspricht dem API-Prämientyp dynamic. Verwenden Sie beim Erstellen von Anfragen die API-Feldnamen und -Werte unverändert.