Unsere API bietet einen eigenen Endpunkt, über den Sie Kunden- und Treuedaten erstellen und bearbeiten können. Dieser Endpunkt unterstützt mehrere Aktualisierungen mit einem API-Aufruf.
Kunden werden anhand ihrer E-Mail-Adresse identifiziert. Das Feld feature gibt an, welcher Teil der Kundeninformationen aktualisiert werden soll.
Bevor Sie starten ¶
Dieser Endpunkt ist Teil der Custom-API-Integration. Er funktioniert nur, wenn die Integration in JeriCommerce unter Settings > Integrations > API aktiv ist und die Funktion Customer eingeschaltet ist. Andernfalls antwortet er mit 403 und API_INTEGRATION_REQUIRED oder API_USERS_REQUIRED.
Dieser Endpunkt wird über den Header api-key geschützt. Lesen Sie die Anleitung zur Authentifizierung.
Kunden erstellen und aktualisieren ¶
POST https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api
Ersetzen Sie {program_slug} durch den tatsächlichen Program-Slug. Sie finden ihn in JeriCommerce unter Settings > Technical > Program Information.
Der Anfrage-Body ist ein Array von Objekten, sodass Sie mit einem einzigen API-Aufruf bis zu 250 Kunden senden können.
Jedes Objekt enthält die E-Mail-Adresse des Kunden, den Funktionsnamen, der für Kundendaten immer users lautet, und den Payload mit den hinzuzufügenden oder zu aktualisierenden Informationen. Gibt es noch keinen Kunden mit dieser E-Mail-Adresse, legt JeriCommerce einen an.
Die JSON-Struktur sieht so aus:
[
{
"email": "string",
"feature": "users",
"payload": {
"externalCustomerId": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"emailVerified": boolean,
"email": "string"
}
}
]
Im Folgenden werden die Payload-Felder einzeln erklärt.
email ¶
Senden Sie dieses Feld nur, wenn sich die E-Mail-Adresse des Kunden ändern soll. Verwenden Sie die aktuelle E-Mail-Adresse als email des Objekts und die neue im Payload.
Nach der Änderung muss die nächste API-Anfrage die neue E-Mail-Adresse als Kennung verwenden.
externalCustomerId ¶
Dies ist die Kennung des Kunden außerhalb von JeriCommerce, normalerweise die ID aus einer externen Datenbank. Sie ist bei jeder Aktualisierung oder Erstellung erforderlich.
firstName ¶
Der Vorname des Kunden wird auf der Treuekarte als Teil seines Namens angezeigt. Der Wert darf null sein.
lastName ¶
Der Nachname des Kunden wird auf der Treuekarte als Teil seines Namens angezeigt. Der Wert darf null sein.
phone ¶
Telefonnummer des Kunden. Standardmäßig ist der Wert null. Wenn Sie keine Daten senden, bleibt das Feld unverändert.
emailVerified ¶
Gibt an, ob die E-Mail-Adresse des Kunden bestätigt wurde. Standardmäßig ist der Wert false. Um den Wert zu aktualisieren, senden Sie den passenden Wert. Wenn keine Änderung erforderlich ist, können Sie das Feld weglassen.
Response ¶
Die Einträge werden der Reihe nach verarbeitet, während die Anfrage offen ist. Eine Antwort 201 mit leerem Body bedeutet, dass alle Einträge gespeichert wurden.
Schlägt ein Eintrag fehl, bricht die Anfrage dort ab und gibt den Fehler zurück. Die Einträge davor sind bereits gespeichert, die Einträge danach werden nicht verarbeitet. Korrigieren Sie den fehlerhaften Eintrag und senden Sie die übrigen erneut.
Kunden löschen ¶
Verwenden Sie zum Löschen eines Kunden denselben API-Endpunkt mit der HTTP-Methode DELETE und der E-Mail-Adresse des Kunden im Query-Parameter email. Kunden werden einzeln gelöscht.
DELETE https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api?email={customerEmail}
Damit wird der gesamte Kunde aus JeriCommerce gelöscht, einschließlich seiner Treueinformationen. Das lässt sich nicht rückgängig machen. Bei erfolgreicher Anfrage erhalten Sie eine 200-Antwort. Gibt es keinen Kunden mit dieser E-Mail-Adresse, erhalten Sie 404 mit CUSTOMER_NOT_FOUND.
Fehler ¶
| Code | Status | Bedeutung |
|---|---|---|
API_INTEGRATION_REQUIRED |
403 |
Die API-Integration ist für dieses Programm nicht aktiv. |
API_USERS_REQUIRED |
403 |
Die Funktion Customer ist in der API-Integration ausgeschaltet. |
FEATURE_NOT_ENABLED |
400 |
Der Wert von feature ist weder users noch loyalty. |
MAX_OBJECTS_PER_REQUEST_EXCEEDED |
400 |
Das Array enthält mehr als 250 Einträge. |
CUSTOMER_NOT_FOUND |
404 |
Nur bei DELETE. Es gibt keinen Kunden mit dieser E-Mail-Adresse. |