Référentiels

Lire la définition des champs de la fiche client

GET /v1/customer-fields
vpn_key Toute clé valide Compte comme une lecture

Renvoie la liste des champs d'un client, avec le libellé que le commerçant voit dans ses écrans, et les valeurs acceptées pour la civilité. Toute clé valide peut l'appeler.

Appelez cette adresse avant de créer ou de modifier des clients. Chaque compte dispose de neuf champs personnalisés (libre_1 à libre_3, custom_io_1 à custom_io_3, custom_date_1 à custom_date_3) dont le sens est propre au commerçant : libelle dit ce qu'il y range. Un champ dont affiche vaut false n'est pas utilisé dans ses écrans : évitez de le remplir sans raison, même si l'API l'accepte.

champ reprend exactement le nom du champ dans un client, avec un point pour un champ de l'adresse (adresse.cp).

Exemple d'appel

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

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

La définition des champs de la fiche client.

Champ Type Description
data objet
data.civilites liste de texte Valeurs acceptées pour le champ civilite d'un client. La chaîne vide signifie « aucune civilité ».
data.champs liste Champs de la fiche client.
data.champs[].champ texte Nom du champ tel qu'il apparaît dans un client (exemples : nom, adresse.cp, libre_1).
data.champs[].libelle texte Libellé que le commerçant voit dans ses écrans. Pour un champ personnalisé, c'est le nom qu'il lui a donné.
data.champs[].type texte Nature de la valeur : texte, nombre, oui_non, date ou liste (valeur à choisir dans une liste fermée).
data.champs[].affiche booléen true si le commerçant utilise ce champ dans ses écrans. Un champ non affiché reste lisible et modifiable par l'API.
data.champs[].personnalise booléen true pour l'un des neuf champs personnalisés, dont le sens dépend du commerçant.
meta objet
meta.request_id texte Identifiant de l'appel, à communiquer à l'assistance en cas de problème.
{
    "data": {
        "civilites": [
            "",
            "M.",
            "Mme",
            "Mlle",
            "Sct"
        ],
        "champs": [
            {
                "champ": "nom",
                "libelle": "Nom",
                "type": "texte",
                "affiche": true,
                "personnalise": false
            },
            {
                "champ": "adresse.cp",
                "libelle": "CP",
                "type": "texte",
                "affiche": true,
                "personnalise": false
            },
            {
                "champ": "libre_1",
                "libelle": "Pointure",
                "type": "texte",
                "affiche": true,
                "personnalise": true
            },
            {
                "champ": "custom_date_1",
                "libelle": "Date d'anniversaire",
                "type": "date",
                "affiche": true,
                "personnalise": true
            }
        ]
    },
    "meta": {
        "request_id": "3f9a1c0b7d2e4a61"
    }
}

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