L’objet Lead représente un devis d’assurance pour un client et un produit à assurer. Chaque lead contient des informations sur le produit à assurer, le statut de la demande, et d’autres données importantes sur les offres et la commande.

Cet object est particulièrement utile lorsque vous souhaitez proposer des offres d'assurance en post-achat.

ENDPOINTS

POST /api/v2/store/{store_id}/leads (BULK): Crée plusieurs leads en une seule requête. Cet endpoint permet de créer un lead et de récupérer le lien de souscription d'un contrat d'assurance.

L'objet Lead

Attributs

id (string) : identifiant unique du lead
status (string) : statut actuel du lead (par exemple, "active", "expired", etc.)
purchase_date (string) : date d'achat de la commande.
expiration_date (string) : date d'expiration du lead.
category_id (string) : Le nom de la catégorie de produit d'assurance.
subscription_link (string) : Le lien de souscription hébergé par Estaly pour permettre au client de souscrire.
signature_link (string) : Lien public permettant d’accéder à la page de signature du contrat lorsque l’encaissement est réalisé par le marchand (charged_by = "merchant").
charged_by (enum: "merchant" | "estaly") : Indique l’entité responsable de l’encaissement du paiement lié au contrat d’assurance. Par défaut "estaly".
customer (object) : objet contenant les informations sur le client ayant souscrit le contrat d'assurance, avec les attributs suivants :
- email (string) : adresse e-mail du client
- first_name (string) : prénom du client
- last_name (string) : nom de famille du client
- birth_date (string) : date de naissance du client
- phone (string) : numéro de téléphone du client
- address (object) : objet contenant les informations sur l'adresse du client, avec les attributs suivants :
  - city (string) : ville de l'adresse
  - country (string) : pays de l'adresse
  - zip_code (string) : code postal de l'adresse
  - address1 (string) : première ligne de l'adresse
  - address2 (string) : deuxième ligne de l'adresse (optionnel)
variant (object) : object content les informations sur le produit à assurer, avec les attributs suivants :
- title (string) : Le titre du variant.
- price (float) : Le prix du variant.
- currency_code (string) : Le code de devise du variant.
- reference_id (string) : L'identifiant de référence du variant.
offers (array of object) : liste des offres d'assurance pour le produit à assurer, avec les attributs suivants :
- title (string) : Le titre de l'offre.
- term_length (string) : La durée de l'offre.
- price (integer) : Le prix de l'offre en centimes d'euro.
- currency_code (string) : Le code de devise de l'offre.
- price_band_min (integer) : Le prix minimum du produit pour lequel l'offre s'applique.
- price_band_max (integer) : Le prix maximum du produit pour lequel l'offre s'applique.
- billing (string) : monthly ou annually
seller (object, optionnal) : Identifie le vendeur en magasin à l'origine du devis.
- first_name (string) : Prénom du vendeur
- last_name (string) : Nom du vendeur

Exemple de l'objet Lead

 {
   "id": "Eq0srKK7JV5lSHq9_vBgfA",
   "status": "active",
   "purchase_date": "12/01/2022",
   "subscription_link": "https://customer.estaly.co/subscription/Eq0srKK7JV5lSHq9_vBgfA",
   "expiration_date": "11/02/2022",
   "category_id": "smartphone",
   "customer": {
     "email": "[email protected]",
     "first_name": "John",
     "last_name": "Doe",
     "birth_date": "16/05/1985",
     "phone": "+33611223344",
     "address": {
       "city": "Paris",
       "country": "France",
       "zip_code": "75001",
       "address1": "1 Rue des Champs Elysées",
       "address2": ""
     }
   },
   "variant": {
     "title": "Iphone 15 - Blanc 512g",
     "price": 2290.0,
     "currency_code": "EUR",
     "reference_id": "9845645"
   },
   "offers": [
     {
       "title": "Assurance smartphone Casse/Vol - 2 ans",
       "term_length": "1 an",
       "price": 3.99,
       "currency_code": "EUR",
       "price_band_min": 0,
       "price_band_max": 500,
       "billing": "monthly"
     },
     {
       "title": "Assurance smartphone Casse/Vol - 1 an",
       "term_length": "1 an",
       "price": 29.99,
       "currency_code": "EUR",
       "price_band_min": 0,
       "price_band_max": 500,
       "billing": "annually"
     },
     {
       "title": "Assurance smartphone Casse/Vol - 2 ans",
       "term_length": "2 ans",
       "price": 49.99,
       "currency_code": "EUR",
       "price_band_min": 0,
       "price_band_max": 500,
       "billing": "annually"
     }
   ]
}