Référence

Clients

Fichier clients du compte.

Adresses

Le client

Tous les champs renvoyés, identiques d'une adresse à l'autre.

Champ Type Description
id entier Identifiant du client.
civilite texte Civilité en clair (exemple : Mme). Chaîne vide si non renseignée.
nom texte Nom.
prenom texte Prénom.
nom_2 texte Nom secondaire, facultatif. Chaîne vide si non renseigné.
email texte Adresse mail. Chaîne vide si non renseignée. Elle n'est pas unique : plusieurs clients peuvent porter la même.
tel texte Téléphone fixe.
mobile texte Téléphone mobile.
bc_ext texte Code-barres associé au client (carte de fidélité par exemple).
remise_pc entier Remise permanente accordée au client, en pourcentage.
notes texte Notes libres saisies par le commerçant.
libre_1 texte Champ personnalisé texte n° 1. Son libellé est dans champs_personnalises.
libre_2 texte Champ personnalisé texte n° 2.
libre_3 texte Champ personnalisé texte n° 3.
custom_io_1 booléen Champ personnalisé oui/non n° 1.
custom_io_2 booléen Champ personnalisé oui/non n° 2.
custom_io_3 booléen Champ personnalisé oui/non n° 3.
custom_date_1 texte Champ personnalisé date n° 1 (AAAA-MM-JJ). Chaîne vide si non renseignée.
custom_date_2 texte Champ personnalisé date n° 2.
custom_date_3 texte Champ personnalisé date n° 3.
news_sms booléen Le client accepte de recevoir des SMS. À respecter avant tout envoi.
news_email booléen Le client accepte de recevoir des mails. À respecter avant tout envoi.
fidelite_active booléen Le client participe au programme de fidélité.
actif booléen Toujours true : un client supprimé n'est jamais renvoyé par l'API.
id_shop_origin entier Identifiant du magasin dans lequel le client a été créé (voir shops dans GET /v1/me). 0 si aucun.
date_creation texte Date de création de la fiche (ISO 8601).
date_update texte Date de dernière modification de la fiche (ISO 8601).
adresse objet Adresse postale du client.
adresse.ligne1 texte Adresse.
adresse.ligne2 texte Complément d'adresse.
adresse.cp texte Code postal.
adresse.ville texte Ville.
adresse.id_pays entier Identifiant interne du pays. 0 si non renseigné.
adresse.pays_code texte Code du pays sur deux lettres, ISO 3166-1 (exemple : FR). Chaîne vide si non renseigné.
adresse.pays texte Nom du pays.
adresse.tva_intra texte Numéro de TVA intracommunautaire.
adresse.archived booléen L'adresse est archivée.
fidelite objet Fidélité et cumuls d'achats du client. Des zéros si le client n'a encore rien acheté.
fidelite.points_actuels entier Points disponibles aujourd'hui.
fidelite.points_cumules entier Total des points gagnés depuis l'origine.
fidelite.nb_fois_pts_utilises entier Nombre de fois où des points ont été utilisés.
fidelite.last_pts_acquis entier Points gagnés lors du dernier achat.
fidelite.total_ca nombre Montant total des achats du client, dans la devise du compte.
fidelite.total_qt entier Nombre total d'articles achetés.
fidelite.total_pa entier Nombre total de passages en caisse.
champs_personnalises liste Les neuf champs personnalisés du client, avec le libellé que le commerçant leur a donné. Mêmes valeurs que libre_N, custom_io_N et custom_date_N, présentées de façon lisible.
champs_personnalises[].cle texte Nom du champ dans l'objet client (exemple : libre_1).
champs_personnalises[].libelle texte Libellé choisi par le commerçant.
champs_personnalises[].type texte Nature du champ.
champs_personnalises[].affiche booléen Le commerçant affiche ce champ dans son application.
champs_personnalises[].valeur Valeur du champ : texte, booléen ou date (AAAA-MM-JJ) selon type.

Une question ? contact@wanapos.com