DocumentationAPI RESTAPI Catégories

API Catégories

Gérez votre arborescence de catégories produits via l'API REST avec des relations parent-enfant hiérarchiques.

2 min de lecture

Sur cette page

Arborescence des catégories

Les catégories dans Kataio sont organisées sous forme d'arborescence hiérarchique. Chaque catégorie peut avoir une catégorie parente, permettant des structures multi-niveaux comme « Vêtements > Homme > Chemises ». L'API retourne l'arbre complet ou des catégories individuelles avec leurs enfants.

Lister les catégories (arbre)

Récupérez l'arborescence complète des catégories, avec les enfants imbriqués à chaque niveau.

GET https://app.kataio.com/api/v1/categories?tree=true
Authorization: Bearer {accessToken}

Réponse (200)

{
  "data": [
    {
      "id": "cat_001",
      "name": "Vêtements",
      "slug": "vetements",
      "description": "Tous les vêtements",
      "parentId": null,
      "sortOrder": 0,
      "productCount": 12,
      "children": [
        {
          "id": "cat_002",
          "name": "Homme",
          "slug": "vetements-homme",
          "description": "Vêtements pour homme",
          "parentId": "cat_001",
          "sortOrder": 0,
          "productCount": 7,
          "children": [
            {
              "id": "cat_003",
              "name": "Chemises",
              "slug": "chemises-homme",
              "description": "Chemises pour homme",
              "parentId": "cat_002",
              "sortOrder": 0,
              "productCount": 4,
              "children": []
            }
          ]
        },
        {
          "id": "cat_004",
          "name": "Femme",
          "slug": "vetements-femme",
          "description": "Vêtements pour femme",
          "parentId": "cat_001",
          "sortOrder": 1,
          "productCount": 5,
          "children": []
        }
      ]
    }
  ]
}
Liste plate : Omettez le paramètre tree=true pour recevoir une liste paginée plate de toutes les catégories. C'est utile pour remplir des menus déroulants ou des champs d'autocomplétion.

Obtenir une catégorie

GET https://app.kataio.com/api/v1/categories/cat_003
Authorization: Bearer {accessToken}

Créer une catégorie

POST https://app.kataio.com/api/v1/categories
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "name": "Accessoires",
  "slug": "accessoires",
  "description": "Ceintures, chapeaux, écharpes et autres accessoires",
  "parentId": null,
  "sortOrder": 2
}

Champs

  • name (obligatoire) — Nom d'affichage de la catégorie.
  • slug (obligatoire) — Identifiant compatible URL. Doit être unique au sein du tenant.
  • description — Description optionnelle pour référence interne ou SEO.
  • parentId — ID de la catégorie parente. Définir à null pour les catégories racines.
  • sortOrder — Ordre de tri parmi les catégories sœurs (par défaut : 0). Les valeurs inférieures apparaissent en premier.

Mettre à jour une catégorie

PATCH https://app.kataio.com/api/v1/categories/cat_003
Authorization: Bearer {accessToken}
Content-Type: application/json

{
  "name": "Chemises & Polos",
  "sortOrder": 1
}

Supprimer une catégorie

DELETE https://app.kataio.com/api/v1/categories/cat_003
Authorization: Bearer {accessToken}
Effets en cascade : Supprimer une catégorie qui a des enfants réassignera ces enfants au parent de la catégorie supprimée. Les produits assignés à la catégorie supprimée deviendront non catégorisés. Vérifiez les assignations avant de supprimer.

Réordonner les catégories

Mettez à jour le champ sortOrder sur plusieurs catégories pour changer leur ordre d'affichage. Il est basé sur zéro et détermine l'ordre parmi les catégories sœurs partageant le même parent.