# SalesChannelCategoryTree ## Retrieve a category tree object > Returns category tree object with given ID related with the sales channel with given channel\_id ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"category_root":{"name":"category_root","in":"query","description":"Root category node ID","schema":{"type":"integer"}}},"schemas":{"CategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNode"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/{id}/":{"get":{"summary":"Retrieve a category tree object","description":"Returns category tree object with given ID related with the sales channel with given channel_id","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/category_root"}],"responses":{"200":{"description":"Category tree object retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryTree"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Update a Category Tree > Updates a category tree with ID for given sales channel\_id with full data ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"CategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNode"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/{id}/":{"put":{"summary":"Update a Category Tree","description":"Updates a category tree with ID for given sales channel_id with full data ","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryTree"}}},"required":true},"responses":{"200":{"description":"Category tree updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryTree"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Delete a category tree > Delete a Category Tree with ID related with the sales channel with channel\_id ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"responses":{"204":{"description":"No content"},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/{id}/":{"delete":{"summary":"Delete a category tree","description":"Delete a Category Tree with ID related with the sales channel with channel_id","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"responses":{"204":{"$ref":"#/components/responses/204"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Partially update a Category Tree > Updates a category tree with ID for given sales channel\_id with partial data ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}}},"schemas":{"CategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNode"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/{id}/":{"patch":{"summary":"Partially update a Category Tree","description":"Updates a category tree with ID for given sales channel_id with partial data","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryTree"}}},"required":false},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryTree"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Retrieve a category tree object with detailed information > Returns category tree object with given ID related with the sales channel with given channel\_id with detailed information ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"category_root":{"name":"category_root","in":"query","description":"Root category node ID","schema":{"type":"integer"}}},"schemas":{"CategoryTreeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNodeDetailed"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CategoryNodeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"object","$ref":"#/components/schemas/SortOptionDetailed"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}},"SortOptionDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"$ref":"#/components/schemas/SortingAlgorithm"}},"static_sorting_algorithm":{"$ref":"#/components/schemas/SortingAlgorithm"}},"allOf":[{"$ref":"#/components/schemas/StarterModel"}]},"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/{id}/detailed/":{"get":{"summary":"Retrieve a category tree object with detailed information","description":"Returns category tree object with given ID related with the sales channel with given channel_id with detailed information","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/category_root"}],"responses":{"200":{"description":"Category tree object retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryTreeDetailed"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## List Category Trees for the channel > Returns a list of all category trees for the sales channel ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"category_root":{"name":"category_root","in":"query","description":"Root category node ID","schema":{"type":"integer"}}},"schemas":{"CategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNode"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/":{"get":{"summary":"List Category Trees for the channel","description":"Returns a list of all category trees for the sales channel","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/category_root"}],"responses":{"200":{"description":"List of category trees for the channel","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryTree"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## Create a sales channel category tree > Create a new sales channel category tree for the channel with channel\_id. ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}}},"schemas":{"SalesChannelCategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/CategoryTree"}]},"CategoryTree":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNode"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}},"responses":{"400":{"description":"Required field(s) are missing, data is invalid, or the action is not allowed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","properties":{"field":{"oneOf":[{"type":"array","description":"Indicates that no value was provided for the {field} field in the request.","items":{"type":"string"}},{"type":"array","description":"Indicates usage of a non-existent object for {field} in the request.","items":{"type":"string"}}]},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"non_field_errors":{"description":"Indicates invalid data or action usage in the request.","type":"array","items":{"type":"string"}},"code":{"type":"string","description":"Represents the server-side error code."}}},{"type":"object","properties":{"detail":{"description":"Provides a detailed message for the given error.","type":"string"},"code":{"type":"string","description":"Represents the server-side error code."}}}]}}}},"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/":{"post":{"summary":"Create a sales channel category tree","description":"Create a new sales channel category tree for the channel with channel_id.","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelCategoryTree"}}},"required":true},"responses":{"201":{"description":"Sales channel category tree created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SalesChannelCategoryTree"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"406":{"$ref":"#/components/responses/406"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## List Category Trees for the channel with detailed information > Returns a list of all category trees for the sales channel with detailed information ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"category_root":{"name":"category_root","in":"query","description":"Root category node ID","schema":{"type":"integer"}}},"schemas":{"CategoryTreeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Tree ID"},"name":{"type":"string","maxLength":255},"category_root":{"$ref":"#/components/schemas/CategoryNodeDetailed"}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CategoryNodeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"object","$ref":"#/components/schemas/SortOptionDetailed"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}},"SortOptionDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"$ref":"#/components/schemas/SortingAlgorithm"}},"static_sorting_algorithm":{"$ref":"#/components/schemas/SortingAlgorithm"}},"allOf":[{"$ref":"#/components/schemas/StarterModel"}]},"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/detailed/":{"get":{"summary":"List Category Trees for the channel with detailed information","description":"Returns a list of all category trees for the sales channel with detailed information","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/category_root"}],"responses":{"200":{"description":"List of category trees for the channel with detailed information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryTreeDetailed"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## List category tree children objects for a specific channel. > List category tree children objects of category tree with ID for sales channel with channel\_id. ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"id":{"name":"id","in":"query","required":false,"description":"Filters by id","schema":{"type":"integer"}},"pk":{"name":"pk","in":"query","required":false,"description":"Filters by primary key","schema":{"type":"integer"}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"name__exact":{"name":"name__exact","in":"query","required":false,"description":"Filters by exact name","schema":{"type":"string"}},"path":{"name":"path","in":"query","description":"Filter by path","schema":{"type":"string"}},"path__exact":{"name":"path__exact","in":"query","description":"Filter by exact path","schema":{"type":"string"}},"path__startswith":{"name":"path__startswith","in":"query","description":"Filter by path start with the given string","schema":{"type":"string"}}},"schemas":{"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"403":{"description":"Forbidden"},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/{id}/children/":{"get":{"summary":"List category tree children objects for a specific channel.","description":"List category tree children objects of category tree with ID for sales channel with channel_id.","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/pk"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/name__exact"},{"$ref":"#/components/parameters/path"},{"$ref":"#/components/parameters/path__exact"},{"$ref":"#/components/parameters/path__startswith"}],"responses":{"200":{"description":"A list of category tree children node objects for given channel.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}}}},"401":{"$ref":"#/components/responses/401"},"403":{"$ref":"#/components/responses/403"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## List children nodes of root node of category tree. > List all children node of root node for category tree with given ID related with sales channel with channel\_id. ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"id":{"name":"id","in":"query","required":false,"description":"Filters by id","schema":{"type":"integer"}},"pk":{"name":"pk","in":"query","required":false,"description":"Filters by primary key","schema":{"type":"integer"}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"name__exact":{"name":"name__exact","in":"query","required":false,"description":"Filters by exact name","schema":{"type":"string"}},"path":{"name":"path","in":"query","description":"Filter by path","schema":{"type":"string"}},"path__exact":{"name":"path__exact","in":"query","description":"Filter by exact path","schema":{"type":"string"}},"path__startswith":{"name":"path__startswith","in":"query","description":"Filter by path start with the given string","schema":{"type":"string"}}},"schemas":{"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/{id}/tree/":{"get":{"summary":"List children nodes of root node of category tree.","description":"List all children node of root node for category tree with given ID related with sales channel with channel_id.","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/pk"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/name__exact"},{"$ref":"#/components/parameters/path"},{"$ref":"#/components/parameters/path__exact"},{"$ref":"#/components/parameters/path__startswith"}],"responses":{"200":{"description":"A list of category tree children node objects for given channel.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` ## List children nodes of root node of category tree with detailed information. > List all children node of root node for category tree with given ID related with sales channel with channel\_id with detailed information. ```json {"openapi":"3.0.3","info":{"title":"Omnitron API","version":"1.0.0"},"security":[{"Token":[]}],"components":{"securitySchemes":{"Token":{"type":"apiKey","in":"header","name":"Authorization"}},"parameters":{"channel_path":{"name":"channel_id","in":"path","description":"The channel ID of the resource.","required":true,"schema":{"type":"integer"}},"id_path":{"name":"id","in":"path","description":"Unique identifier of the resource","required":true,"schema":{"type":"integer"}},"limit":{"name":"limit","in":"query","required":false,"description":"Indicates the number of rows on the current page.","schema":{"type":"integer","minimum":1,"default":10}},"page":{"name":"page","in":"query","required":false,"description":"Specifies the page number of the current dataset","schema":{"type":"integer","minimum":1,"default":1}},"id":{"name":"id","in":"query","required":false,"description":"Filters by id","schema":{"type":"integer"}},"pk":{"name":"pk","in":"query","required":false,"description":"Filters by primary key","schema":{"type":"integer"}},"name":{"name":"name","in":"query","description":"Filter by name.","schema":{"type":"string"}},"name__exact":{"name":"name__exact","in":"query","required":false,"description":"Filters by exact name","schema":{"type":"string"}},"path":{"name":"path","in":"query","description":"Filter by path","schema":{"type":"string"}},"path__exact":{"name":"path__exact","in":"query","description":"Filter by exact path","schema":{"type":"string"}},"path__startswith":{"name":"path__startswith","in":"query","description":"Filter by path start with the given string","schema":{"type":"string"}}},"schemas":{"CategoryNodeDetailed":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"object","$ref":"#/components/schemas/SortOptionDetailed"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"},"children":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNode"}}},"required":["pk","order","name","created_date","modified_date"]},"UUIDStarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."},"uuid":{"type":"string","format":"uuid","description":"Unique UUID identifier","readOnly":true}}},"Entity":{"type":"object","properties":{"attributes":{"type":"object","description":"A JSON object to store various attributes of the entity."},"attributes_kwargs":{"type":"object","description":"A JSON object to store additional attribute keyword arguments."},"localized_attributes":{"type":"object","description":"A JSON object to store localized attributes."},"localized_attributes_kwargs":{"type":"object","description":"A JSON object to store localized attributes keyword arguments."}}},"MP_Node":{"type":"object","properties":{"path":{"type":"string","description":"The path of the node in the tree."},"depth":{"type":"integer","description":"The depth of the node in the tree."},"numchild":{"type":"integer","description":"The number of children the node has."}}},"SortOptionDetailed":{"type":"object","properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sort option object ID."},"channel":{"type":"integer","description":"Related channel object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"value":{"type":"string","maxLength":64,"description":"The value of the sort option."},"uid":{"type":"string","maxLength":32,"description":"Unique identifier for the sort option."},"disable_score":{"type":"boolean","description":"Flag to disable scoring for this sort option.","default":false},"label":{"type":"string","maxLength":255,"description":"The label of the sort option."},"order":{"type":"integer","nullable":true,"description":"Order of the sort option in the list."},"is_default":{"type":"boolean","description":"Indicates whether this is the default sort option.","default":false},"is_visible":{"type":"boolean","description":"Indicates whether this sort option is visible.","default":true},"sorting_algorithms":{"type":"array","description":"List of sorting algorithms related to this sort option.","items":{"$ref":"#/components/schemas/SortingAlgorithm"}},"static_sorting_algorithm":{"$ref":"#/components/schemas/SortingAlgorithm"}},"allOf":[{"$ref":"#/components/schemas/StarterModel"}]},"SortingAlgorithm":{"type":"object","allOf":[{"$ref":"#/components/schemas/StarterModel"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Sorting algorithm object ID."},"catalog":{"type":"integer","description":"Related catalog object ID."},"code":{"type":"string","maxLength":64,"description":"The code of the sorting algorithm."},"name":{"type":"string","maxLength":255,"description":"The name of the sorting algorithm."},"sorting_type":{"type":"string","description":"The type of sorting algorithm.","enum":["static","dynamic","external"]},"ruleset":{"type":"object","description":"A JSON object containing the ruleset for the sorting algorithm."},"config":{"type":"object","description":"A JSON object containing the configuration for the sorting algorithm."},"is_visible":{"type":"boolean","description":"Indicates whether this sorting algorithm is visible.","default":true}}},"StarterModel":{"type":"object","properties":{"created_date":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the object was created."},"modified_date":{"type":"string","format":"date-time","description":"The date and time when the object was last modified."}}},"CategoryNode":{"type":"object","allOf":[{"$ref":"#/components/schemas/UUIDStarterModel"},{"$ref":"#/components/schemas/Entity"},{"$ref":"#/components/schemas/MP_Node"}],"properties":{"pk":{"type":"integer","format":"int64","readOnly":true,"description":"Category Node ID"},"order":{"type":"integer","description":"Order of the category node"},"name":{"type":"string","maxLength":64,"description":"Name of the category node."},"remote_attributes":{"type":"object","description":"Remote attributes of the category node","nullable":true},"sort_option":{"type":"integer","description":"Related sort option object ID"},"marketplace_attribute_set":{"type":"integer","description":"Related marketplace attribute set object ID"}},"required":["pk","order","name","created_date","modified_date"]}},"responses":{"401":{"description":"Unauthorized Access","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Contains a detailed description of the error."},"code":{"type":"string","description":"Represents the server-side error code."}}}}}},"404":{"description":"The given resource or object was not found or does not exist.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"description":"Contains a detailed description of the error.","type":"string"}}}}}},"406":{"description":"A custom 406 error occurs due to different validation failures in viewset or service level, such as uniqueness checks or other service-related exceptions.","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","description":"Detailed message of the 406 error."}}}}}},"500":{"description":"Server Error"}}},"paths":{"/api/v1/channel/{channel_id}/category_trees/{id}/tree_detailed/":{"get":{"summary":"List children nodes of root node of category tree with detailed information.","description":"List all children node of root node for category tree with given ID related with sales channel with channel_id with detailed information.","tags":["SalesChannelCategoryTree"],"parameters":[{"$ref":"#/components/parameters/channel_path"},{"$ref":"#/components/parameters/id_path"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/page"},{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/pk"},{"$ref":"#/components/parameters/name"},{"$ref":"#/components/parameters/name__exact"},{"$ref":"#/components/parameters/path"},{"$ref":"#/components/parameters/path__exact"},{"$ref":"#/components/parameters/path__startswith"}],"responses":{"200":{"description":"A list of category tree children node objects for given channel.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CategoryNodeDetailed"}}}}},"401":{"$ref":"#/components/responses/401"},"404":{"$ref":"#/components/responses/404"},"406":{"$ref":"#/components/responses/406"},"500":{"$ref":"#/components/responses/500"}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://apidocs.akinon.com/omnitron-openapis/saleschannelcategorytree.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.