# Categories Get category list ## Documentation Get category list - Catalog: `Magento` - Schema: `Catalog` - Primary Keys: `id` Can retrieve data and change data using insert, update and delete. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `Categories`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `searchCriteria[currentPage]` | `` | ☐ | | Current page. | | `searchCriteria[filterGroups][0][filters][0][conditionType]` | `` | ☐ | | Condition type | | `searchCriteria[filterGroups][0][filters][0][field]` | `` | ☐ | | Field | | `searchCriteria[filterGroups][0][filters][0][value]` | `` | ☐ | | Value | | `searchCriteria[pageSize]` | `` | ☐ | | Page size. | | `searchCriteria[sortOrders][0][direction]` | `` | ☐ | | Sorting direction. | | `searchCriteria[sortOrders][0][field]` | `` | ☐ | | Sorting field. | ## Columns of Table Function The columns of the table function `Categories` are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `available_sort_by` | `varchar2` | | ☐ | Available sort by for category. The identifiers, separated by commas. | | `children` | `varchar2` | | ☐ | Children ids comma separated. | | `created_at` | `varchar2` | | ☐ | Category creation date and time. | | `extension_attributes` | `varchar2` | | ☐ | The JSON text of the nested object. | | `id` | `int64` | | ☐ | Category id. | | `include_in_menu` | `char` | | ☐ | Category is included in menu. | | `is_active` | `char` | | ☐ | Whether category is active | | `level` | `int64` | | ☐ | Category level | | `name` | `varchar2` | | ☐ | Category name | | `parent_id` | `int64` | | ☐ | Parent category ID | | `path` | `varchar2` | | ☐ | Category full path. | | `position` | `int64` | | ☐ | Category position | | `updated_at` | `varchar2` | | ☐ | Category last update date and time. |