Category Tree

This page describes the request data identifiers and response structure required to build a category tree (hierarchy) view.

Data Identifier

{
  "dataID": "GET_CATEGORY_TREE",
  "parent_seq": 1
}
KeyDescription
dataIDData identifier GET_CATEGORY_TREE
parent_seqReturn the subtree starting at this category. Empty = the whole tree.

HTML

<div class="card shadow-sm">
  <div class="card-header"><strong>Category tree</strong></div>
  <ul class="list-group list-group-flush">
    <li class="list-group-item" v-for="node in output.category_tree">
      <strong>{{ node.name }}</strong>
      <span class="badge bg-light text-dark ms-2">{{ node.code }}</span>
      <ul class="list-group list-group-flush mt-2">
        <li class="list-group-item ps-4" v-for="child in node.children">
          {{ child.name }} <span class="badge bg-light text-dark ms-2">{{ child.code }}</span>
        </li>
      </ul>
    </li>
  </ul>
</div>

Response Result

{
  "category_tree": [
    {
      "seq": 1,
      "parent_seq": null,
      "code": "APPAREL",
      "name": "Apparel",
      "depth": 0,
      "sort_order": 1,
      "status": "ACTIVE",
      "extra_data": null,
      "created_by": 3,
      "updated_by": 3,
      "create_date": "2026-10-04 11:57:33",
      "modify_date": null,
      "delete_flg": "N",
      "children": [
        {
          "seq": 2,
          "parent_seq": 1,
          "code": "TSHIRTS",
          "name": "T-Shirts",
          "depth": 1,
          "sort_order": 1,
          "status": "ACTIVE",
          "extra_data": null,
          "created_by": 3,
          "updated_by": 3,
          "create_date": "2026-10-04 11:57:33",
          "modify_date": null,
          "delete_flg": "N",
          "children": []
        },
        {
          "seq": 3,
          "parent_seq": 1,
          "code": "HOODIES",
          "name": "Hoodies",
          "depth": 1,
          "sort_order": 2,
          "status": "ACTIVE",
          "extra_data": null,
          "created_by": 3,
          "updated_by": 3,
          "create_date": "2026-10-04 11:57:33",
          "modify_date": null,
          "delete_flg": "N",
          "children": []
        }
      ]
    }
  ],
  "category_flat": [
    {
      "seq": 1,
      "parent_seq": null,
      "code": "APPAREL",
      "name": "Apparel",
      "depth": 0,
      "sort_order": 1,
      "status": "ACTIVE",
      "extra_data": null,
      "created_by": 3,
      "updated_by": 3,
      "create_date": "2026-10-04 11:57:33",
      "modify_date": null,
      "delete_flg": "N"
    },
    {
      "seq": 2,
      "parent_seq": 1,
      "code": "TSHIRTS",
      "name": "T-Shirts",
      "depth": 1,
      "sort_order": 1,
      "status": "ACTIVE",
      "extra_data": null,
      "created_by": 3,
      "updated_by": 3,
      "create_date": "2026-10-04 11:57:33",
      "modify_date": null,
      "delete_flg": "N"
    },
    {
      "seq": 3,
      "parent_seq": 1,
      "code": "HOODIES",
      "name": "Hoodies",
      "depth": 1,
      "sort_order": 2,
      "status": "ACTIVE",
      "extra_data": null,
      "created_by": 3,
      "updated_by": 3,
      "create_date": "2026-10-04 11:57:33",
      "modify_date": null,
      "delete_flg": "N"
    }
  ]
}
KeyDescription
category_treeTree array. With parent_seq, that category is the single root.
category_tree[n].seqCategory number
category_tree[n].parent_seqParent number. null for a root
category_tree[n].codeCategory code
category_tree[n].nameCategory name
category_tree[n].depthDepth. 0 for a root
category_tree[n].sort_orderOrder among siblings
category_tree[n].statusACTIVE / INACTIVE
category_tree[n].childrenChild categories (same shape, recursive)
category_flatThe same categories flattened depth-first (no children)
  • Screen example: render category_tree recursively for a mega menu or site map. For a single-level select box, use category_flat and indent by depth.
  • The tree includes every non-deleted category regardless of status. On a storefront, show only status ACTIVE.
  • Error codes — errors also come back as HTTP 200. Check result:false, then error_code (string) and error_message.
  • This read API needs no sign-in. An unknown parent_seq returns empty arrays.

Example

Category tree
  • Apparel APPAREL
    • T-Shirts TSHIRTS
    • Hoodies HOODIES
<script setup>
const requestData = {"dataID": "GET_CATEGORY_TREE", "parent_seq": 1};
const { output } = await useNuxtApp().$connector(requestData);
</script>

<template>
  <div class="card shadow-sm">
    <div class="card-header"><strong>Category tree</strong></div>
    <ul class="list-group list-group-flush">
      <li class="list-group-item" v-for="node in output.category_tree" :key="node.seq">
        <i class="fas fa-folder text-warning me-2"></i><strong>{{ node.name }}</strong>
        <span class="badge bg-light text-dark ms-2">{{ node.code }}</span>
        <ul class="list-group list-group-flush mt-2">
          <li class="list-group-item ps-4" v-for="child in node.children" :key="child.seq">
            <i class="fas fa-tag text-secondary me-2"></i>{{ child.name }}
            <span class="badge bg-light text-dark ms-2">{{ child.code }}</span>
          </li>
        </ul>
      </li>
    </ul>
  </div>
</template>
<?php
$requestData = ['dataID' => 'GET_CATEGORY_TREE', 'parent_seq' => 1];
$output = $connector->request($requestData);

function renderTree($nodes) {
    echo '<ul class="list-group list-group-flush">';
    foreach ($nodes as $node) {
        echo '<li class="list-group-item"><strong>' . htmlspecialchars($node['name']) . '</strong>';
        echo ' <span class="badge bg-light text-dark">' . htmlspecialchars($node['code']) . '</span>';
        if (!empty($node['children'])) {
            renderTree($node['children']);   // recurse into subtree
        }
        echo '</li>';
    }
    echo '</ul>';
}
renderTree($output['category_tree']);