Get a list of categories as a hierarchic tree

GET 
/api/categories/tree

Get a list of categories as a hierarchic tree

Request

Query Parameters

type string

type of the category

Responses

200

Successful response

application/json

Schema

Schema

• Array [
id int64
name objectrequired

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

code string

Code of the category

level integer

Level of the category

description object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

active boolean

Active status of the category (true or false)

slug object

Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists

fr string

Version française de cet attribut

nl string

Nederlandse versie van deze veld

en string

English version of this attribute

de string

Deutsche Version dieses Attributs

type stringrequired

Type of the category (e.g. product, service, etc..)

_lft integer

Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

_rgt integer

Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)

parent_id integer

Parent category id

created_at string

Date of creation of the category

updated_at string

Date of last update of the category

children object[]
Array [
id int64
name objectrequired
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
code string
Code of the category
level integer
Level of the category
description object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
active boolean
Active status of the category (true or false)
slug object
Object of translatable strings (please ensure that you manage correctly the type of the value). Keys are the language code (e.g. fr, nl, en, de). More infos on taxonomy here : https://bdl217-docs.collegedesproducteurs.be/docs/intro#taxonomy-lists
fr string
Version française de cet attribut
nl string
Nederlandse versie van deze veld
en string
English version of this attribute
de string
Deutsche Version dieses Attributs
type stringrequired
Type of the category (e.g. product, service, etc..)
_lft integer
Left value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
_rgt integer
Right value of the category (used to order category using the nested set model : https://en.wikipedia.org/wiki/Nested_set_model)
parent_id integer
Parent category id
created_at string
Date of creation of the category
updated_at string
Date of last update of the category
]
• ]

Example (from schema)

[
  {
    "id": 0,
    "name": {
      "fr": "string",
      "nl": "string",
      "en": "string",
      "de": "string"
    },
    "code": "string",
    "level": 0,
    "description": {
      "fr": "string",
      "nl": "string",
      "en": "string",
      "de": "string"
    },
    "active": true,
    "slug": {
      "fr": "string",
      "nl": "string",
      "en": "string",
      "de": "string"
    },
    "type": "string",
    "_lft": 0,
    "_rgt": 0,
    "parent_id": 0,
    "created_at": "string",
    "updated_at": "string",
    "children": [
      {
        "id": 0,
        "name": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "code": "string",
        "level": 0,
        "description": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "active": true,
        "slug": {
          "fr": "string",
          "nl": "string",
          "en": "string",
          "de": "string"
        },
        "type": "string",
        "_lft": 0,
        "_rgt": 0,
        "parent_id": 0,
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  }
]

Loading...