melkal
Manuel d'utilisation
 Sommaire - Centre d'aide - Assistance

➜︎ Retour - Menu API, webhooks et mailhooks

API : lister les clients

Menu de la documentation
Accueil API
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
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 liste des clients par l'API. Réglage de l'API : Réglages → API & Make.
Pour lire beaucoup de clients, l'API fonctionne en deux temps :
  1. GET /api/V1/clients_initial : vous envoyez vos filtres. Melkal prépare la liste, et vous donne un token, le nombre de clients et le nombre de pages.
  2. GET /api/V1/clients_token : vous demandez les pages une à une, avec le token.

Les clients listés sont ceux qui ne sont pas dans la corbeille et qui ne sont pas le client anonyme (et qui ont leur code-barre interne, ce qui est le cas de toutes les fiches normales). Ils sont triés par nom.

Étape 1 : clients_initial#

GET/api/V1/clients_initial
ParamètreTypeExplications
api_key string Obligatoire. Votre clé API.
nbParPage integer Obligatoire. Le nombre de clients par page, de 1 à 100. Sans ce paramètre, la requête est refusée.
dateCrea
filtreParDateCrea		 string
string		 Facultatif. Filtre sur la date de création de la fiche. dateCrea est une date AAAA-MM-JJ ou AAAA-MM-JJ HH:MM:SS. filtreParDateCrea vaut avantDateCrea (avant cette date), apresDateCrea (après) ou leDateCrea (ce jour-là).
dateModif
filtreParDateModif		 string
string		 Facultatif. Filtre sur la date de dernière modification. filtreParDateModif vaut avantDateModif, apresDateModif, leDateModif, ou xJoursModif : dans ce cas dateModif est un nombre de jours, et le filtre garde les fiches modifiées depuis ce nombre de jours (aujourd'hui exclu).
dateModifAPI
filtreParDateModifAPI		 string
string		 Facultatif. Filtre sur la date de dernière modification par l'API. filtreParDateModifAPI vaut avantDateModifAPI, apresDateModifAPI ou leDateModifAPI.
dateVt
filtreParDateVt		 string
string		 Facultatif. Filtre sur la date de dernière vente. filtreParDateVt vaut avantDateVt, apresDateVt, leDateVt, ou xJoursVt (dateVt est alors un nombre de jours).
filtreParJoursPrecedents
nbJoursPrecedents		 string
integer		 Facultatif. Les clients dont la date tombe dans les nbJoursPrecedents derniers jours. filtreParJoursPrecedents indique quelle date : nbJoursCrea (création), nbJoursModif (modification), nbJoursAPI (modification par l'API) ou nbJoursVt (dernière vente). Avec 0 jour : aujourd'hui seulement ; sinon de ce nombre de jours en arrière jusqu'à hier (aujourd'hui exclu).
uuid string Facultatif. Un ou plusieurs UUID séparés par des virgules (100 au maximum). Seuls les UUID valides (version 4) comptent.
codebarre string Facultatif. Un ou plusieurs codes-barres de 8 ou 13 chiffres, séparés par des virgules (100 au maximum).
Les filtres se cumulent : un client doit les respecter tous.

Exemple : les clients modifiés depuis 7 jours, 50 par page : 
curl -G "ADRESSE_API/api/V1/clients_initial" \
  --data-urlencode "api_key=VOTRE_CLE" \
  --data-urlencode "nbParPage=50" \
  --data-urlencode "filtreParDateModif=xJoursModif" \
  --data-urlencode "dateModif=7"
Réponse (code 200) : 
{
  "nbPages": 3,
  "token": "412_5811760352840",
  "nbClients": 138,
  "nbParPage": 50
}
PropriétéTypeExplications
token string À envoyer à clients_token. Il représente cette liste précise, avec ses filtres. Pour une nouvelle extraction, refaites l'étape 1 et utilisez le nouveau token.
nbClients integer Le nombre total de clients qui correspondent aux filtres.
nbParPage integer Le nombre de clients par page, tel que vous l'avez demandé.
nbPages integer Le nombre de pages à demander.
Si aucun client ne correspond, la réponse est une erreur 404 « aucun client trouvé ».

Étape 2 : clients_token#

GET/api/V1/clients_token
ParamètreTypeExplications
api_key string Obligatoire. Votre clé API.
token string Obligatoire. Le token reçu à l'étape 1.
page integer Obligatoire. Le numéro de la page, à partir de 1. 
curl -G "ADRESSE_API/api/V1/clients_token" \
  --data-urlencode "api_key=VOTRE_CLE" \
  --data-urlencode "token=412_5811760352840" \
  --data-urlencode "page=1"
Réponse (code 200) : la page demandée.
PropriétéTypeExplications
numPage integer Le numéro de la page renvoyée.
liste array Les clients de la page. Chacun a les propriétés décrites dans La fiche client en JSON, sauf famille, liens et codesbarres qui n'y sont pas, et avec en plus ean, facebook, x, insta et tiktok.
Une page au-delà de la dernière donne l'erreur 404 « aucun client trouvé » : c'est le signal de fin.

Dans la liste, la date d'anniversaire (anniversaire) est le jour puis le mois collés, sans zéro devant : le 5 mars donne « 53 ». La route de recherche renvoie au contraire quatre chiffres (« 0503 »). Si vous avez besoin de l'anniversaire, lisez-le avec la recherche d'un client.

Parcourir toute la liste#

  1. Appelez clients_initial avec vos filtres : notez le token et nbPages.
  2. Appelez clients_token pour page=1, puis 2, jusqu'à nbPages.
  3. Pour une nouvelle extraction (le lendemain par exemple), recommencez à l'étape 1 : n'utilisez pas un ancien token.

Pour ne recevoir que ce qui a changé depuis votre dernière extraction, filtrez sur la date de modification : filtreParDateModif=apresDateModif et dateModif avec la date de votre dernière extraction.

← PrécédentRechercher un client Suivant →Créer un client
Dernière mise à jour : 13 octobre 2026
Retour - Sommaire - Centre d'aide - Assistance