Fidélité : mettre à jour et créer des informations

Vous pouvez créer ou mettre à jour les informations de fidélité d'un client avec le point de terminaison dédié, qui accepte un tableau d'objets dans le corps de la requête.

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

Le client doit déjà exister dans l'API avant que vous puissiez lui ajouter des informations de fidélité.

Vous pouvez transmettre les informations du client et celles de fidélité dans la même requête API, à condition de respecter leur ordre : ajoutez d'abord les informations du client.

Le client doit déjà être créé avant d'ajouter ses informations de fidélité.

Voici un exemple de corps pour mettre à jour un client :

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

Propriétés de la charge utile ¶

loyaltyCustomerId ¶

Référence externe des informations de fidélité, utile lorsque vous devez les associer à une autre base de données. Cette propriété est obligatoire pour chaque requête.

Balance ¶

Le solde du client est l'une des propriétés les plus importantes. Notre API ne calcule pas sa valeur : elle remplace simplement le solde par la valeur fournie dans la requête. Ce champ est obligatoire, doit être au format numérique et doit toujours être supérieur à 0.

memberSince ¶

Date d'inscription du client à votre programme de fidélité. Ce champ obligatoire doit respecter le format de chaîne ISO.

tierStatus ¶

Selon votre programme de fidélité, les clients peuvent avoir un statut de niveau ou non. Vous pouvez indiquer ici le nom du niveau. Cette propriété facultative est une chaîne qui peut contenir la valeur souhaitée.

Récupérer le catalogue public de récompenses ¶

Utilisez ce point de terminaison pour récupérer le catalogue de récompenses du programme :

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

La réponse est un tableau de récompenses. Les champs du catalogue comprennent id, title, description, image, redeemCost, order, visibilityRules et redeemabilityRules. Ce point de terminaison renvoie les données du catalogue, et non la liste des récompenses qu'un client donné peut échanger actuellement.

Les champs type, currencyPerPoint, minPoints et maxPoints décrivent le type de récompense et ses limites de conversion. Dans l'interface d'administration, Points as cash correspond au type de récompense API dynamic. Conservez les noms et les valeurs des champs API lorsque vous construisez vos requêtes.