➜︎ Retour - Menu API, webhooks et mailhooks
API : rechercher un client
Menu de la documentation
Votre adresse API et votre clé
Renseignez-les une fois : tous les exemples de ces pages les utilisent, et les boutons « Copier » copient la requête prête à l'emploi. Ils ne quittent pas votre navigateur. La clé n'est gardée que le temps de cette session, sauf si vous cochez cette case : . Dans ce cas, la clé sera aussi conservée dans ce navigateur web. Votre adresse et votre clé sont dans Réglages → API & Make.
Cette page décrit la recherche d'un client par l'API. Réglage de l'API : Réglages → API & Make.
GET/api/V1/client
Cette route retrouve un seul client selon le critère fourni, et renvoie sa fiche. Si plusieurs fiches correspondent, c'est la première qui est renvoyée.
Pour obtenir plusieurs clients, voir Lister les clients.
Les paramètres#
| Paramètre | Type | Explications |
|---|---|---|
| api_key | string | Obligatoire. Votre clé API. |
| rechercheType | string | Obligatoire. Le critère de recherche : une des valeurs du tableau ci-dessous. |
| recherche | string | Obligatoire. La valeur à chercher, selon le critère. |
Les critères de recherche#
| rechercheType | La valeur cherchée |
|---|---|
| code | Le numéro du client dans Melkal (le « code » de sa fiche). |
| id | L'identifiant numérique du client dans Melkal (propriété id de la fiche). |
| uuid | L'UUID du client (propriété uuid). |
| idExterne | L'identifiant que votre application a donné au client (propriété idExterne). |
| barcode | Un code-barre du client (interne ou externe). |
| lienSocial | Un contact du client : adresse email, numéro de mobile ou de téléphone, identifiant Facebook, X, Instagram ou TikTok, tels qu'ils sont enregistrés dans Melkal. |
Exemple#
Rechercher un client par son adresse email :curl -G "ADRESSE_API/api/V1/client" \ --data-urlencode "api_key=VOTRE_CLE" \ --data-urlencode "rechercheType=lienSocial" \ --data-urlencode "recherche=achats@dupont-sarl.fr"
La réponse#
Code 200 : la fiche du client, en JSON. Toutes les propriétés sont décrites dans La fiche client en JSON.Code 404 : aucun client ne correspond.
{
"error": {
"code": "error-404",
"message": "Message de Melkal: aucun client trouvé.",
"status": 404
}
}
Les autres erreurs (type de recherche inconnu, valeur vide...) sont dans Les erreurs de l'API.
Dernière mise à jour : 13 octobre 2026