Clients

Rechercher des clients par adresse mail

GET /v1/customers
vpn_key Permission read_customers Compte comme une lecture

Renvoie les clients du compte qui portent exactement cette adresse mail, sans tenir compte des majuscules ni des espaces autour.

La réponse est toujours une liste : dans Wanapos, une adresse mail n'est pas unique, plusieurs fiches clients peuvent la porter. Une liste vide signifie qu'aucun client ne correspond, ce n'est pas une erreur. Si plusieurs clients reviennent, ne choisissez pas au hasard : départagez-les avec leurs autres champs, ou demandez à l'utilisateur.

La liste est limitée à 50 clients. Si meta.truncated vaut true, plus de 50 fiches portent cette adresse mail (cas très rare) et la liste est incomplète : il n'existe pas de page suivante pour cette recherche. Pour obtenir toutes les fiches, parcourez le fichier avec GET /v1/customers/export et gardez celles dont le champ email correspond.

Les clients supprimés dans l'application ne sont jamais renvoyés. Le paramètre email est obligatoire. Pour parcourir tout le fichier clients, utilisez GET /v1/customers/export.

Paramètres

email Obligatoire Adresse mail complète à rechercher (50 caractères au maximum). Pensez à l'encoder dans l'URL.

Exemple d'appel

curl "https://api.wanapos.com/v1/customers?email=claire.martin%40exemple.com" \
  -H "Authorization: Bearer VOTRE_CLE"

Réponse en cas de succès (statut 200)

Liste des clients portant cette adresse mail.

Champ Type Description
data liste d'objets Clients correspondants, du plus ancien au plus récent. Liste vide si aucun. Voir tous les champs
meta objet
meta.request_id texte Identifiant de l'appel.
meta.count entier Nombre de clients renvoyés.
meta.truncated booléen true si la liste a été coupée à 50 clients : elle est alors incomplète, voir la description de l'adresse.
{
    "data": [
        {
            "id": 1842,
            "civilite": "Mme",
            "nom": "Martin",
            "prenom": "Claire",
            "nom_2": "",
            "email": "claire.martin@exemple.com",
            "tel": "",
            "mobile": "0600000000",
            "bc_ext": "",
            "remise_pc": 0,
            "notes": "",
            "libre_1": "",
            "libre_2": "",
            "libre_3": "",
            "custom_io_1": false,
            "custom_io_2": false,
            "custom_io_3": false,
            "custom_date_1": "",
            "custom_date_2": "",
            "custom_date_3": "",
            "news_sms": false,
            "news_email": true,
            "fidelite_active": true,
            "actif": true,
            "id_shop_origin": 1,
            "date_creation": "2026-03-14T10:22:00+01:00",
            "date_update": "2026-10-02T16:05:00+02:00",
            "adresse": {
                "ligne1": "12 rue des Lilas",
                "ligne2": "",
                "cp": "69003",
                "ville": "Lyon",
                "id_pays": 63,
                "pays_code": "FR",
                "pays": "France",
                "tva_intra": "",
                "archived": false
            },
            "fidelite": {
                "points_actuels": 120,
                "points_cumules": 340,
                "nb_fois_pts_utilises": 2,
                "last_pts_acquis": 15,
                "total_ca": 412.5,
                "total_qt": 17,
                "total_pa": 9
            },
            "champs_personnalises": [
                {
                    "cle": "libre_1",
                    "libelle": "Customisé 1",
                    "type": "texte",
                    "affiche": false,
                    "valeur": ""
                },
                {
                    "cle": "libre_2",
                    "libelle": "Customisé 2",
                    "type": "texte",
                    "affiche": false,
                    "valeur": ""
                },
                {
                    "cle": "libre_3",
                    "libelle": "Customisé 3",
                    "type": "texte",
                    "affiche": false,
                    "valeur": ""
                },
                {
                    "cle": "custom_io_1",
                    "libelle": "Customisé 1",
                    "type": "oui_non",
                    "affiche": false,
                    "valeur": false
                },
                {
                    "cle": "custom_io_2",
                    "libelle": "Customisé 2",
                    "type": "oui_non",
                    "affiche": false,
                    "valeur": false
                },
                {
                    "cle": "custom_io_3",
                    "libelle": "Customisé 3",
                    "type": "oui_non",
                    "affiche": false,
                    "valeur": false
                },
                {
                    "cle": "custom_date_1",
                    "libelle": "Customisé 1",
                    "type": "date",
                    "affiche": false,
                    "valeur": ""
                },
                {
                    "cle": "custom_date_2",
                    "libelle": "Customisé 2",
                    "type": "date",
                    "affiche": false,
                    "valeur": ""
                },
                {
                    "cle": "custom_date_3",
                    "libelle": "Customisé 3",
                    "type": "date",
                    "affiche": false,
                    "valeur": ""
                }
            ]
        }
    ],
    "meta": {
        "request_id": "3f9a1c0b7d2e4a61",
        "count": 1,
        "truncated": false
    }
}

Erreurs possibles

  • 401 Clé absente, inconnue ou révoquée. Codes : missing_key, invalid_key.
  • 403 Appel refusé pour ce compte ou cette clé. Codes : api_not_activated, account_not_eligible, access_blocked, missing_scope.
  • 422 Un paramètre est absent, inconnu ou invalide. Code : invalid_parameter. Le champ field nomme le paramètre.
  • 429 Quota dépassé. Codes : rate_limited, daily_quota_exceeded, too_many_failed_attempts. L'en-tête Retry-After indique combien de secondes attendre.

Voir toutes les erreurs

Une question ? contact@wanapos.com