Product categories / List
List all product categories as a tree (global).
Route: /api/sys/v{version:apiVersion}/product_categories
Method: GET
Authorisation: ONLY ADMIN
Response object
Response status: 200 (OK)
Response type: DTO_product_category_UI[]
Wrapper: DTO_response_wrap_get_many
Other response statuses: 400 (BadRequest), 403 (Forbidden)
Response body example
DTO_standard_filter
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| channel | String | Channel | |
| sort_by_key | String | Sort by key | |
| brand_ids | Int32[] | Brand ids | |
| response_field_keys | String[] | Only return the fields specified | |
| filters | String[] | Each string needs to be structured: filters=field_key:operator:value1|value2|value3 Only used to store filters for passing along as querystring | |
| include_aggregations | Boolean | Include aggregations | |
| include_imported | Boolean | Include imported | |
| search | String | Search | |
| sort_order | ENUM sort_order | Sort order | |
| take | Int32 | Take | |
| page | Int32 | Page |
DTO_product_category_UI
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| id | Int32 | Id | |
| name | String | Name | |
| description | String | Description | |
| parent_id | Int32 (nullable) | Parent id | |
| name_path | String[] | Name path | |
| children | DTO_product_category_UI[] | Children | |
| created_by | DTO_reference_user | Created by | |
| last_updated_by | DTO_reference_user | Last updated by | |
| created | DateTime | Created | |
| last_updated | DateTime | Last updated |
DTO_product_category_UI
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| id | Int32 | Id | |
| name | String | Name | |
| description | String | Description | |
| parent_id | Int32 (nullable) | Parent id | |
| name_path | String[] | Name path | |
| children | DTO_product_category_UI[] | Children | |
| created_by | DTO_reference_user | Created by | |
| last_updated_by | DTO_reference_user | Last updated by | |
| created | DateTime | Created | |
| last_updated | DateTime | Last updated |
DTO_reference_user
| Name | Type | ReadOnly | Description |
|---|---|---|---|
| profile_pic | String | ReadOnly | Profile pic |
| String | ReadOnly | ||
| role_enum_id | tenant_user_role (nullable) | Role enum id | |
| id | Int32 | Id | |
| label | Object | ReadOnly | Label |
ENUM sort_order
| Value | Name | Description |
|---|---|---|
| 0 | ASC | ASC |
| 1 | DESC | DESC |
