Lister les listes personnalisées
GET
/v1/custom-lists
Permission read_products
Compte comme une lecture
Chaque compte dispose de trois listes personnalisées pour classer ses produits selon ses propres critères (une matière, une saison, un rayon). Cette adresse renvoie les trois, avec le nom que le commerçant leur a donné : appelez-la pour savoir ce que signifient id_custom_list_1, id_custom_list_2 et id_custom_list_3 dans un produit.
Les valeurs de chaque liste se lisent par GET /v1/custom-lists/{list}/values. Une liste dont affiche vaut false n'est pas utilisée par le commerçant. Le nom et l'affichage d'une liste se modifient par PATCH /v1/custom-lists/{list}.
Exemple d'appel
curl "https://api.wanapos.com/v1/custom-lists" \ -H "Authorization: Bearer VOTRE_CLE"
Réponse en cas de succès (statut 200)
Les trois listes personnalisées.
| Champ | Type | Description |
|---|---|---|
data |
liste | Les trois listes personnalisées, dans l'ordre. |
data[].id_list |
entier |
Numéro de la liste : 1, 2 ou 3. À utiliser dans l'adresse /v1/custom-lists/{list}/values. |
data[].champ |
texte |
Champ d'un produit qui porte une valeur de cette liste : id_custom_list_1, id_custom_list_2 ou id_custom_list_3. |
data[].libelle |
texte | Nom que le commerçant a donné à cette liste (exemples : « Matière », « Saison »). |
data[].affiche |
booléen |
true si le commerçant utilise cette liste dans ses fiches produit. |
data[].nb_values |
entier | Nombre de valeurs en service dans la liste. |
meta |
objet | |
meta.request_id |
texte | Identifiant de l'appel. |
meta.count |
entier | Nombre d'éléments renvoyés. |
{
"data": [
{
"id_list": 1,
"champ": "id_custom_list_1",
"libelle": "Matière",
"affiche": true,
"nb_values": 8
},
{
"id_list": 2,
"champ": "id_custom_list_2",
"libelle": "Customisé 2",
"affiche": false,
"nb_values": 0
},
{
"id_list": 3,
"champ": "id_custom_list_3",
"libelle": "Customisé 3",
"affiche": false,
"nb_values": 0
}
],
"meta": {
"request_id": "3f9a1c0b7d2e4a61",
"count": 3
}
}
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 champfieldnomme le paramètre. -
429
Quota dépassé. Codes :
rate_limited,daily_quota_exceeded,too_many_failed_attempts. L'en-têteRetry-Afterindique combien de secondes attendre.
Une question ? contact@wanapos.com
