Classements

Renommer ou afficher une liste personnalisée

PATCH /v1/custom-lists/{list}
vpn_key Permission write_products Compte comme une écriture

Donne son nom à l'une des trois listes personnalisées, ou change son affichage dans les fiches produit, et la renvoie après modification.

C'est l'appel à faire pour mettre une liste en service : donnez-lui un libelle parlant (« Matière », « Saison ») et passez affiche à true, puis ajoutez ses valeurs par POST /v1/custom-lists/{list}/values. Avant de renommer une liste, lisez GET /v1/custom-lists : si elle porte déjà un nom choisi par le commerçant ou contient des valeurs, elle est utilisée, et la renommer changerait le sens de ce que portent ses produits.

La modification est partielle : seuls les champs envoyés changent. Il y a toujours exactement trois listes : on ne peut ni en créer ni en supprimer.

Paramètres

list Obligatoire Numéro de la liste personnalisée : 1, 2 ou 3 (voir GET /v1/custom-lists).
dry_run Facultatif true pour tout vérifier sans rien enregistrer : la réponse est celle que vous auriez obtenue, avec meta.dry_run à true. L'identifiant renvoyé n'est alors pas réservé.
Idempotency-Key Facultatif Identifiant unique de votre choix (8 à 100 caractères). Si vous renvoyez la même requête avec le même identifiant, elle n'est pas exécutée deux fois : vous recevez la réponse d'origine. Recommandé pour toute création.

Corps JSON à envoyer

Champ Type Description
libelle texte Nom de la liste, tel que le commerçant le verra dans ses fiches produit. De 1 à 50 caractères.
affiche booléen true pour que la liste apparaisse dans les fiches produit, false pour la masquer. Masquer une liste ne supprime ni ses valeurs ni ce que portent les produits.

Exemple d'appel

curl -X PATCH "https://api.wanapos.com/v1/custom-lists/1" \
  -H "Authorization: Bearer VOTRE_CLE" \
  -H "Content-Type: application/json" \
  -d '{"libelle":"Matière","affiche":true}'

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

La liste après modification.

Champ Type Description
data objet
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, à communiquer à l'assistance en cas de problème.
{
    "data": {
        "id_list": 1,
        "champ": "id_custom_list_1",
        "libelle": "Matière",
        "affiche": true,
        "nb_values": 0
    },
    "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 Données envoyées invalides. Code : validation_failed. Le champ details liste chaque erreur.
  • 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.
  • 503 Une autre écriture est en cours sur ce compte. Code : account_busy. Renvoyer la même requête après le délai de l'en-tête Retry-After.

Voir toutes les erreurs

Une question ? contact@wanapos.com