Clients

Parcourir tout le fichier clients

GET /v1/customers/export
vpn_key Permission export_customers Compte comme une lecture

Renvoie les clients du compte page par page, par identifiant croissant, avec la même fiche complète que la lecture d'un client. Cette adresse demande la permission export_customers, distincte de read_customers : une clé de simple lecture ne peut pas parcourir tout le fichier.

Le parcours se fait par curseur. Appelez d'abord sans after. Tant que meta.has_more vaut true, rappelez avec after égal à meta.next_after. Quand has_more vaut false, le parcours est terminé. Ne construisez pas le curseur vous-même et n'utilisez pas de numéro de page.

Pour tenir un autre outil à jour sans tout relire, passez updated_since : seules les fiches créées ou modifiées depuis cette date reviennent. Notez l'heure de début de votre parcours et réutilisez-la comme updated_since la fois suivante. Un changement de points de fidélité seul ne compte pas comme une modification de la fiche. Les clients supprimés dans l'application ne sont jamais renvoyés ici : GET /v1/customers/deleted donne leurs identifiants.

Paramètres

limit Facultatif Nombre d'éléments par page, de 1 à 100. 50 par défaut.
after Facultatif Curseur de parcours : ne renvoie que les éléments dont l'identifiant est supérieur. Absent ou 0 pour la première page, puis la valeur next_after de la réponse précédente.
updated_since Facultatif Ne renvoie que les fiches créées ou modifiées depuis cette date. Formats acceptés : 2026-11-01 (minuit, heure de Paris) ou 2026-11-01T08:30:00+01:00. Sans fuseau, l'heure est celle de Paris. Pensez à encoder le + dans l'URL (%2B).

Exemple d'appel

curl "https://api.wanapos.com/v1/customers/export" \
  -H "Authorization: Bearer VOTRE_CLE"

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

Une page du fichier clients.

Champ Type Description
data liste d'objets Clients de la page, par identifiant croissant. Liste vide si aucun. Voir tous les champs
meta objet
meta.request_id texte Identifiant de l'appel.
meta.count entier Nombre d'éléments dans cette page.
meta.has_more booléen true s'il reste une page à lire.
meta.next_after entier Valeur à passer dans after pour la page suivante. 0 quand le parcours est terminé.
{
    "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,
        "has_more": false,
        "next_after": 0
    }
}

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