Puoi creare o aggiornare le informazioni fedeltà di un cliente tramite l'endpoint dedicato, che accetta un array di oggetti nel corpo della richiesta.

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

Prima di aggiungere i dati fedeltà, l'utente deve già esistere nell'API.

Puoi inviare i dati del cliente e quelli fedeltà nella stessa richiesta API, ma mantieni l'ordine e inserisci prima le informazioni del cliente.

Le informazioni fedeltà richiedono che il cliente sia già stato creato.

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.

Balance

Il saldo del cliente è una delle proprietà principali. L'API non calcola il valore: aggiorna il saldo con quello fornito nella richiesta. È un campo obbligatorio, deve essere numerico e sempre maggiore di 0.

memberSince

È la data di iscrizione del cliente al programma fedeltà. Il campo obbligatorio deve essere nel formato ISO string.

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.

Recupera il catalogo pubblico dei premi

Usa questo endpoint per recuperare il catalogo premi del programma:

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

La risposta è un array di premi. I campi del catalogo includono id, title, description, image, redeemCost, order, visibilityRules e redeemabilityRules. L'endpoint restituisce i dati del catalogo, non l'elenco specifico dei premi riscattabili da un cliente.

I campi type, currencyPerPoint, minPoints e maxPoints descrivono il tipo di premio e i limiti di conversione. Nel pannello di amministrazione, Points as cash corrisponde al tipo premio API dynamic; mantieni i nomi e i valori dei campi API quando crei le richieste.