Créer une collection
POST
/v1/collections
Permission write_products
Compte comme une écriture
Crée une collection et la renvoie.
Un nom déjà pris est refusé avec l'erreur duplicate_name, qui donne l'identifiant existant : réutilisez-le plutôt que de créer un doublon. La comparaison ne tient compte ni des majuscules, ni des accents, ni des espaces autour, et inclut les éléments archivés.
Paramètres
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 |
|---|---|---|
name |
texte |
Nom de la collection. De 3 à 50 caractères. Un nom déjà pris est refusé (duplicate_name), sans tenir compte des majuscules ni des accents. |
archived |
booléen |
À la modification seulement : true pour archiver, false pour remettre en service. |
Exemple d'appel
curl -X POST "https://api.wanapos.com/v1/collections" \
-H "Authorization: Bearer VOTRE_CLE" \
-H "Content-Type: application/json" \
-d '{"name":"Printemps 2027"}'
Réponse en cas de succès (statut 201)
La collection créée.
| Champ | Type | Description |
|---|---|---|
data |
objet | |
data.id |
entier |
Identifiant de la collection. C'est la valeur de collec.id dans un produit. |
data.name |
texte | Nom de la collection. |
data.archived |
booléen |
true si la collection est archivée. |
data.date_creation |
texte | Date de création. |
data.date_update |
texte | Date de la dernière modification. Chaîne vide si inconnue. |
meta |
objet | |
meta.request_id |
texte | Identifiant de l'appel, à communiquer à l'assistance en cas de problème. |
{
"data": {
"id": 3,
"name": "Printemps 2027",
"archived": false,
"date_creation": "2026-03-14T10:22:00+01:00",
"date_update": "2026-10-02T16:05:00+02:00"
},
"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. -
409
Ce nom est déjà porté par un autre élément du même classement. Code :
duplicate_name. Le message et l'indication donnent l'identifiant existant. Rien n'a été enregistré. -
422
Données envoyées invalides. Code :
validation_failed. Le champdetailsliste chaque erreur. -
429
Quota dépassé. Codes :
rate_limited,daily_quota_exceeded,too_many_failed_attempts. L'en-têteRetry-Afterindique 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êteRetry-After.
Une question ? contact@wanapos.com
