Ce fichier permet de notifier Estaly de la souscription de plusieurs contrats (équivalent au POST /api/v2/organization/plans BULK).
Nom de fichier
plans_YYYYMMDD.csv (ex : plans_20250131.csv)
Modes d’utilisation**
Deux modes sont possibles pour notifier Estaly des adhésions et annulations :
Mode séparé
Par défaut, les adhésions et annulations sont transmises dans deux fichiers distincts :
- plans_YYYYMMDD.csv pour les adhésions
- cancellations_YYYYMMDD.csv pour les annulations
Mode unifié
Il est également possible de transmettre les adhésions et les annulations dans un seul fichier plans_YYYYMMDD.csv.
Dans ce cas, le fichier doit contenir une colonne supplémentaire event_type, permettant d’indiquer le type d’événement transmis.
Valeurs possibles
- subscription : Création / souscription d’un contrat
- cancellation : Annulation / résiliation d’un contrat existant
Si la colonne event_type est absente, les lignes du fichier sont considérées comme des souscriptions (subscription) afin de conserver la compatibilité avec le format existant.
Structure
CSV plat avec entête.
| Colonne | Occurence | Type | Contraintes | Description |
|---|---|---|---|---|
| order_reference_id | 1..1 | string | non vide | Référence de la commande associée au contrat d'assurance |
| offer_line_reference_id | 1..1 | string | non vide | Référence de la ligne de commande du contrat d'assurance vendu. |
| offer_reference_id | 1..1 | string | non vide | Référence / SKU de l'offre d'assurance |
| variant_title | 1..1 | string | non vide | Nom du produit (variant) assuré. |
| variant_reference_id | 1..1 | string | non vide | Référence unique du produit (variant) assuré (ex: 10491) |
| variant_line_reference_id | 1..1 | string | non vide | Référence ligne de commande du produit (variant) assuré. |
| variant_price | 1..1 | décimal | non vide | Prix du produit (variant) assuré unitaire (ex: 799.99) |
| variant_quantity | 1..1 | integer | non vide, ≥ 1 | Quantité du produit (variant) assuré |
| variant_currency_code | 0..1 | string | optionnelle | Devise, par défaut : EUR |
| variant_product_type | 0..1 | string | optionnelle | Catégorie du produit (variant) assuré |
| variant_image_url | 0..1 | string | optionnelle | Url de l'image du produit (variant) assuré |
| variant_tags | 0..n | string | optionnelle, séparé par | | Liste de tags libres associés au produit (variant) assuré |
| customer_first_name | 1..1 | string | non vide | Prénom du client assuré |
| customer_last_name | 1..1 | string | non vide | Nom du client assuré |
| customer_email | 1..1 | string | non vide | Email du client assuré |
| customer_phone | 1..1 | string | non vide, format E.164 recommandé | Téléphone du client assuré |
| customer_address1 | 1..1 | string | non vide | Adresse ligne 1 du client assuré |
| customer_city | 1..1 | string | non vide | Ville |
| customer_country | 1..1 | string | non vide, ISO 3166-1 alpha-2 recommandé | Pays |
| customer_zip_code | 1..1 | string | non vide | Code postale |
| customer_birth_date | 0..1 | string | optionnelle, format YYYY-MM-DD | Date de naissance du client assuré |
| customer_birth_city | 0..1 | string | optionnelle | Ville de naissance du client assuré |
| customer_birth_country | 0..1 | string | optionnelle | Pays de naissance du client assuré |
| purchase_date | 1..1 | date string | non vide, format YYYY-MM-DD | Date d'achat du contrat |
| store_external_id | 1..1 | string | non vide | Identifiant unique du point de vente |
| seller_first_name | 0..1 | string | optionnelle | Prénom du vendeur réalisant la vente du contrat |
| seller_last_name | 0..1 | string | optionnelle | Nom du vendeur réalisant la vente du contrat |
| event_type | 0..1 | string | optionnelle, subscription ou cancellation. Par défaut : subscription | Type d’événement transmis dans la ligne |
| cancellation_date | 0..1 | date string | optionnelle, obligatoire si event_type = cancellation, format YYYY-MM-DD | Date d’annulation du contrat |
Cancellation
Lorsque event_type = cancellation, seuls les champs nécessaires à l’identification du contrat et à son annulation sont obligatoires :
| Colonne | Occurence | Type | Contraintes | Description |
|---|---|---|---|---|
| order_reference_id | 1..1 | string | non vide | Référence de la commande associée au contrat d'assurance |
| offer_line_reference_id | 1..1 | string | non vide | Référence de la ligne de commande du contrat d'assurance vendu. |
| offer_reference_id | 1..1 | string | non vide | Référence / SKU de l'offre d'assurance |
| store_external_id | 1..1 | string | non vide | Identifiant unique du point de vente |
| cancellation_date | 1..1 | string | non vide, format YYYY-MM-DD | Date d’annulation du contrat |
| event_type | 0..1 | string | non vide, cancellation | Type d’événement transmis dans la ligne |
Les autres colonnes peuvent être laissées vides et seront ignorées pour les lignes d’annulation.