➜︎ Retour - Menu API, webhooks et mailhooks

La fiche client en JSON

Menu de la documentation

API

Démarrer Rechercher un client Lister les clients Créer un client Modifier un client La fiche client en JSON Les erreurs OpenAPI et Postman

Webhooks et mailhooks

Fonctionnement Vente : validation Article : stock mis à jour Les webhooks Client

Cette page décrit le JSON d'une fiche client, tel que l'API le renvoie. Réglage de l'API : Réglages → API & Make.

C'est la réponse de la recherche d'un client. Les clients de la liste et les webhooks Client (Les webhooks Client) ont à peu près les mêmes propriétés : les différences sont indiquées sur ces pages.

Un texte sans valeur est un texte vide (""). Les oui/non sont des booléens JSON.

Exemple#

{
  "code": "312",
  "nom": "DUPONT",
  "prenom": "MARTIN",
  "entreprise": "Dupont Services",
  "anniversaire": "1503",
  "adresse": {
    "adresse_remarques": "",
    "adresse_ligne1": "3 rue des Écoles",
    "adresse_ligne2": "",
    "adresse_cp": "29000",
    "adresse_ville": "QUIMPER"
  },
  "prive": false,
  "apparence": "",
  "statut": "",
  "type": "PROFESSIONNEL",
  "suivi": "Camille",
  "notes": {
    "descriptif": "",
    "note1": "",
    "note2": "",
    "note3": "",
    "note4": "",
    "note5": "",
    "note6": ""
  },
  "corbeille": false,
  "anonyme": false,
  "finances": {
    "tarif": "TARIF NORMAL",
    "detteMax": "0,00",
    "remiseAuto": "",
    "echeanceNbJours": 30,
    "compte": "41100312",
    "franchiseTVA": false,
    "facturation": "",
    "echeanceFindemois": false,
    "solde": "0,00"
  },
  "datePremiereVente": "2024-02-10",
  "dateDerniereVente": "2026-10-12",
  "dateDerniereModification": "2026-10-13 09:12:00",
  "dateDerniereModificationViaAPI": "",
  "uuid": "38D13BD6-4836-4115-B829-B55AC2537B09",
  "email": "achats@dupont-sarl.fr",
  "mobile": "0612345678",
  "tel": "",
  "idExterne": "CRM-4821",
  "eshop": {
    "idClientEshop": 0,
    "creeViaEshop": false
  },
  "id": 312,
  "geo": {
    "map_latitude": "",
    "map_longitude": "",
    "map_placeId": "",
    "map_googleFiche": "",
    "map_googleInfos": ""
  },
  "dateCreation": "2024-02-10 14:03:00",
  "facturation": {
    "facture_entetePerso": "",
    "facture_piedPerso": "",
    "numTVA": "FR55987654321",
    "facture_entetePersoSurFact": false,
    "facture_piedPersoSurFact": false
  },
  "livraison": {
    "livraison_coordonnees": "",
    "livraison_entetePersoSurBL": false,
    "livraison_piedPersoSurBL": false
  },
  "devis": {
    "devis_entetePersoSurDevis": false,
    "devis_piedPersoSurDevis": false
  },
  "famille": [
    {
      "prenom": "MARTIN",
      "anniversaire": "1503",
      "statut": "",
      "aspect": "",
      "id": 501
    }
  ],
  "liens": [
    {
      "lien_contenu": "achats@dupont-sarl.fr",
      "lien_pubAutorisee": true,
      "lien_remarques": "",
      "lien_type": "EMAIL",
      "lien_membreFamille": "MARTIN",
      "lien_id": 9001
    }
  ],
  "codesbarres": [
    {
      "codebarre_contenu": "80003128",
      "codebarre_type": "INTERNE EAN8",
      "codebarre_id": 77
    }
  ]
}

Les propriétés#

Propriété	Type	Explications
id	integer	L'identifiant du client dans Melkal.
code	string	Le numéro (code) du client.
uuid	string	L'identifiant unique du client.
idExterne	string	L'identifiant donné au client par une application extérieure, vide s'il n'y en a pas.
nom prenom	string	Le nom de famille et le prénom du membre principal de la fiche.
entreprise	string	Le nom de l'entreprise.
anniversaire	string	L'anniversaire, JJMM (quatre chiffres : 1503 pour le 15 mars). Vide s'il n'est pas renseigné.
email mobile tel	string	L'email, le mobile et le téléphone fixe principaux.
type	string	Le type de client (« PROFESSIONNEL »...).
suivi	string	Le vendeur qui suit ce client.
apparence statut	string	L'apparence et le statut du membre principal de la fiche.
prive	boolean	true si la fiche est privée.
corbeille	boolean	true si la fiche est dans la corbeille.
anonyme	boolean	true pour le client anonyme (les ventes sans fiche client).
datePremiereVente dateDerniereVente	string	La date de la première et de la dernière vente à ce client.
dateCreation	string	La date et l'heure de création de la fiche.
dateDerniereModification	string	La date et l'heure de la dernière modification de la fiche.
dateDerniereModificationViaAPI	string	La date et l'heure de la dernière modification faite par l'API. Vide si la fiche n'a jamais été modifiée par l'API.
adresse	object	adresse_remarques (indications), adresse_ligne1, adresse_ligne2, adresse_cp (code postal), adresse_ville.
notes	object	Le descriptif et les six notes note1 à note6. Les titres des notes sont ceux de votre magasin.
finances	object	Les réglages financiers : voir ci-dessous.
eshop	object	idClientEshop : l'identifiant du client sur votre site WooCommerce (0 sinon). creeViaEshop : true si la fiche a été créée par une commande du site.
geo	object	La position du client sur une carte : map_latitude, map_longitude, map_placeId, map_googleFiche, map_googleInfos.
facturation	object	numTVA : le numéro de TVA intracommunautaire. facture_entetePerso et facture_piedPerso : les textes personnalisés du haut et du bas de ses factures, avec facture_entetePersoSurFact et facture_piedPersoSurFact pour dire s'ils s'impriment.
livraison	object	livraison_coordonnees : l'adresse de livraison. livraison_entetePersoSurBL et livraison_piedPersoSurBL : les textes personnalisés s'impriment-ils sur les bons de livraison.
devis	object	devis_entetePersoSurDevis et devis_piedPersoSurDevis : les textes personnalisés s'impriment-ils sur les devis.
famille	array	Les membres de la fiche (le foyer) : prenom, anniversaire, statut, aspect et id.
liens	array	Tous les contacts du client : voir ci-dessous.
codesbarres	array	Les codes-barres du client : voir ci-dessous.

finances#

Propriété	Type	Explications
tarif	string	Le tarif du client.
detteMax	string	Le montant de dette maximal autorisé, en euros, sous forme de texte (le séparateur décimal est celui de votre Melkal).
remiseAuto	string	L'article de remise appliqué automatiquement à ce client.
echeanceNbJours	integer	Le délai de paiement, en jours.
echeanceFindemois	boolean	true si l'échéance est calculée en fin de mois.
compte	string	Le compte comptable du client.
franchiseTVA	boolean	true si le client est exonéré de TVA.
facturation	string	Le comportement de facturation du client.
solde	string	Le solde du compte du client, en euros, sous forme de texte.

liens : les contacts#

Propriété	Type	Explications
lien_id	integer	L'identifiant du contact.
lien_contenu	string	L'adresse email, le numéro ou l'identifiant.
lien_type	string	Le type : MOBILE, EMAIL, TEL, FACEBOOK, TWITTER (X), INSTAGRAM ou TIKTOK.
lien_pubAutorisee	boolean	true si le client accepte de recevoir de la publicité par ce contact (opt-in).
lien_remarques	string	Les remarques sur ce contact.
lien_membreFamille	string	Le prénom du membre de la fiche à qui appartient le contact.

codesbarres : les codes-barres#

Propriété	Type	Explications
codebarre_id	integer	L'identifiant du code-barre.
codebarre_contenu	string	Le code-barre.
codebarre_type	string	Le type : INTERNE EAN8 est la carte de Melkal (EAN 8 qui commence par 8). Les autres sont les cartes que vous avez définies (carte d'un partenaire, d'un gymnase...).

← PrécédentModifier un client Suivant →Les erreurs

Dernière mise à jour : 13 octobre 2026

Retour - Sommaire - Centre d'aide - Assistance