Se il tuo programma fedeltà gira in un altro sistema, puoi inviare a JeriCommerce il saldo e lo stato del livello di ogni cliente, così la loro carta fedeltà li mostra. Lo fai con lo stesso endpoint usato per i dati del cliente, con loyalty come funzionalità. Accetta come corpo della richiesta un array di massimo 250 oggetti.
POST https://api.jericommerce.com/v1/programs/{program_slug}/integrations/api
Questo endpoint fa parte della Custom API Integration. Richiede l'integrazione attiva in Settings > Integrations > API, con la funzionalità Loyalty attivata. Altrimenti risponde 403 con API_INTEGRATION_REQUIRED o API_LOYALTY_REQUIRED.
Per aggiungere punti a un programma fedeltà JeriCommerce invece di sostituire il saldo, usa Aumenta il saldo.
Prima di aggiungere i dati fedeltà, il cliente deve già esistere. Se il cliente non esiste, l'elemento fedeltà viene ignorato senza errore.
Puoi inviare i dati del cliente e quelli fedeltà nella stessa richiesta API, ma mantieni l'ordine e inserisci prima le informazioni del cliente.
Ecco un esempio di corpo per aggiornare un cliente:
[
{
"email": "{{customer_email}}",
"feature": "loyalty",
"payload": {
"loyaltyCustomerId": "{{customer_loyalty_id}}",
"balance": "{{balance_to_apply}}",
"memberSince": "{{customer_join_date}}",
"tierStatus": "{{customer_tier}}"
}
}
]
Proprietà del payload ¶
loyaltyCustomerId ¶
È il riferimento esterno di queste informazioni fedeltà, utile per associarle a un altro database. È obbligatorio per ogni richiesta. Viene salvato la prima volta e poi mantenuto.
Balance ¶
Il saldo del cliente è una delle proprietà principali. L'API non calcola il valore: sostituisce il saldo con quello fornito nella richiesta. È un campo obbligatorio. Invialo come numero uguale o maggiore di 0. I decimali vengono arrotondati all'intero più vicino.
memberSince ¶
È la data di iscrizione del cliente al programma fedeltà, in formato ISO 8601 (per esempio 2026-01-31).
È facoltativo. Se non lo invii, JeriCommerce mantiene la data attuale, oppure usa la data di oggi per un nuovo cliente.
tierStatus ¶
A seconda del programma fedeltà, potrebbe esserci uno stato basato sui livelli. In tal caso, puoi inserire qui il nome del livello. È una proprietà stringa facoltativa.
Risposta ¶
La risposta segue le stesse regole dell'endpoint cliente: 201 quando ogni elemento è stato salvato. Quando cambiano il saldo o il livello, il cliente riceve una notifica wallet se ha attivato quelle notifiche.
Il catalogo premi del programma ha un endpoint dedicato: Elenco premi.