L'objet Plan représente un contrat d'assurance souscrit par un client. Il contient des informations sur le contrat, telles que l'identifiant unique, la référence de commande, la référence de l'offre, le statut, la date d'achat, la durée, le prix etc... Il contient également des informations sur le client, telles que son adresse e-mail, son prénom, son nom, sa date de naissance, son numéro de téléphone et son adresse postale.

ENDPOINTS

GET /api/v2/organization/plans : Liste les contrats de l’organisation. Cet endpoint permet de récupérer la liste des contrats, avec prise en charge de la pagination
(page, per_page) et la possibilité de filtrer les résultats par email client.
POST /api/v2/organization/plans (BULK) : Crée plusieurs contrats en une seule requête. Cet endpoint permet de notifier Estaly de la souscription d'un ou plusieurs contrats d'assurance.
POST /api/v2/organization/plans/cancel (BULK) : Annule plusieurs contrats en une seule requête.

L'objet Plan

Attributs

id (string) : identifiant unique du contrat d'assurance (numéro de contrat)
order_reference_id (string) : référence de la commande associée au contrat d'assurance
offer_line_reference_id (string) : référence de la ligne de commande du contrat d'assurance
offer_reference_id (string) : référence / SKU de l'offre d'assurance
status (string) : statut actuel du contrat d'assurance (par exemple, "active", "cancelled", etc.)
purchase_date (string) : date d'achat du contrat d'assurance
title (string) : titre du contrat d'assurance
term_length (integer) : durée du contrat d'assurance en mois
price (float) : prix du contrat d'assurance
currency_code (string) : code de devise du contrat d'assurance (par exemple, "EUR")
store_external_id (string) : identifiant unique du point de vente dans le système du partenaire / marchand
store_id (string) : identifiant interne Estaly du point de vente
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
- birth_city (string) : Ville de naissance du client
- birth_country (string) : Pays 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 :
  - address1 (string) : première ligne de l'adresse
  - city (string) : ville de l'adresse
  - country (string) : pays de l'adresse
  - zip_code (string) : code postal de l'adresse
variant (object) : objet contenant les informations sur le produit (variant) assuré avec les attributs suivants :
- title (string) : Nom du produit (variant)
- reference_id (string): Référence unique du produit (variant) assuré
- line_reference_id (string) : Référence ligne de commande du produit (variant) assuré.
- price (number, float) : Prix du produit (variant) assuré
- currency_code (string) : Devise
- quantity (number) : Quantité du produit (variant) assuré
- product_type (string) : Catégorie du produit
- tags (array of strings) : Liste de tags libres associés au produit
- image_url (string) : Image du produit

Exemple de l'objet Plan

{
  "id": "CO12BIPASOFF",
  "order_reference_id": "51965",
  "offer_reference_id": "98498",
  "status": "active",
  "purchase_date": "2022-01-12",
  "title": "Assurance smartphone Casse et Vol - 1 an",
  "term_length": 12,
  "price": 149.00,
  "currency_code": "EUR",
  "store_id": 24,
  "store_external_id": "ENT234",
  "customer": {
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "birth_date": "16/05/1985",
    "birth_city": "Paris",
    "birth_country": "France",
    "phone": "+33611223344",
    "address": {
      "city": "Paris",
      "country": "France",
      "zip_code": "75001",
      "address1": "1 Rue des Champs Elysées",
      "address2": ""
    }
  },
  "variant": {
    "title": "Canapé d'angle convertible gauche RICKY tissu gris foncé et gris clair",
    "reference_id": "297013823901293932",
    "price": 799.99,
    "currency_code": "EUR",
    "product_type": "Canapé",
    "tags": ["Canapé d'angle"],
    "image_url": "https://wwww......",
  }
}

Dans cet exemple, le contrat d'assurance souscrit a pour numéro de contrat "CO12BIPASOFF".

Il a été souscrit le 12 janvier 2022, est toujours actif et coûte 149 € pour une durée de 12 mois.