Categories

Category is used to sort and group Items into different sections. This is to help your Consumers to navigate around your marketplace and help Merchants to know how to group their Items. 


Arcadier supports 2 levels of categories, Parent and Child categories. Child categories cannot exist without a Parent category; but the opposite is possible. Only 2 levels are allowed because having more will creates complicated (and therefore unpleasant) experience for the Consumers. We always encouraged the use of Sorting and Filters to enhance the search experience and not to rely solely on the use of Categories. And each Item is only allowed to be grouped under a single category. 


Example: A groceries marketplace can have a Bakery category (Parent), with Loaves, Toasts, Rolls and Buns as sub-categories (child categories).

Property Table

Categories Properties

Property Names Property Type Description
Id

Optional

integer

"Id": 4581


The unique identity number of the category

Name

Optional

string

"Name": "Men's Shoes"


The name of the category in the marketplace. Please ensure the name of the category is unique for the marketplace.

Description

Optional

string

"Description": "Footwear for various occasions"


The description of the category.

ParentCategoryID

Optional

integer

"ParentCategoryID": 4580


The ID of the parent category to this category belongs to. A category can only have one parent category.

SortOrder

Optional

integer

"SortOrder": 1


The sorting order of the category.

ChildCategories

Optional

Array [Category Object]

"ChildCategories": [
 {
   "Id": 45811,
   "Name": "Sneakers",
   "Description": "Footwear for casual occasion",
   "ParentCategoryID": 4581,
   "SortOrder": 1,
   "ChildCategories": []
 },
 {
   "Id": 45812,
   "Name": "Sports Shoes",
   "Description": "Footwear fit for sport activities",
   "ParentCategoryID": 4581,
   "SortOrder": 2,
   "ChildCategories": []
 }
]


A field that list all the child category information that are related to parent category.

Please note that ChildCategories and SubCategory are referring to the same thing.

ImageUrl

Optional

string

"ImageUrl": "men-shoe.jpg"


The image URL for the category.

Active

Optional

boolean

"Active": true


The status of the category. If category is active, it will be shown as true. For inactive, it will shown as false. The inactive category will not be shown in the marketplace but the category information still exist in the marketplace database.

Images Object

Optional

Array[Image Object]

"Images": [
 {
   "FileId": 4589,
   "MediaUrl": "images/categories/men-shoes.jpg"
 }
]


Image object will list all the images for the category.

Image Object - FileId

Optional

integer

"FileId": 4589


The unique identification number of the image file.

Image Object - MediaUrl

Optional

string

"MediaUrl": "images/categories/men-shoes.jpg"


The url link to image file.

Was this article helpful?
1 out of 1 found this helpful