Skip to main content

Category

Categories are a primary way to group products with similar features. You can also add subcategories if desired.

AttributesDescription
category_idlong: Unique identifier of the category.
namestring: Name of the category.
urlstring: URL of the category.
descriptionstring: Detailed description of the category.
SEO 
titlestring: Title for SEO.
keywordstring: SEO keywords for the category.
descriptionstring: SEO description for the category.
parent_category_idlong: Unique ID generated by the server for the parent category (value -1 defines the ROOT category).
handlestring: URL of the category
bread_crumbsarray: List of bread crumbs preceding the category page.
is_selectedboolean: Denotes whether bread crumb is selected.
namestring: Name of the preceding category.
urlstring: URL of the preceeding category.
sub_categoriesarray: List of children of the category.
category_idlong: Unique ID of the category.
parent_category_idlong: Unique ID of the parent category.
sibling_orderint: Category's order in the hierarchy.
visibilityboolean: Visibility of the category.
namestring: Name of the category.
handlestring: URL path of the category.
urlstring: Complete url of the category in the store.
imagesarray: List of images for the category.
imagesarray: List of all the images mapped for the category.
alternate_textstring: Alternate text for the SEO purpose of the image.
is_placeholder_imageboolean: Denotes whether the image is used as a placeholder.
idlong: Unique ID for the image.
titlestring: Name of the image.
urlstring: URL of the image.
is_featuredboolean: This denotes whether the image is featured.
orderint: This denotes the chronological order of the image.
productsarray: List of all the products belonging to the category.
sort_by_optionsarray: Array of the different sort options available.
is_selectedboolean: Denotes whether the sort by option is selected.
namestring: Name of the sort by option.
valuestring: Value of the sort by option.
specificationsarray