Categories Resource

Categories are maintained in the Sage Data Exchange application. The Categories Resource returns the Category and, optionally, the Products within the Category.

Categories can also return the column names that represent the properties of the products. For example, the Category “Mens Shoes” may contain properties like “Color” and “Size”. The Category response would contain a array, “properties”, with the two values “Color” and “Size”.

Resource Method List
ActionHTTPURIAdmin?Description
getGET/categories[?category=<category>] Retrieve Category and, optionally, Product data for one or more Categories
listGET/categoriesRetrieve Category and, optionally, Product data for one or more Categories

Resource Table List
Click on the table to view detail.

Category

Element NameDescriptionTypeLength
categoryCategoryString64
categoryRIDCategory Reference IDString8
categoryDescriptionCategory DescriptionString64
categoryImageCategory ImageString64
categoryShortDescriptionCategory Short DescriptionString2048
categoryLongDescriptionCategory Long DescriptionString4096
mainNavigationMain NavigationNumeric1
categoryEnabledCategory EnabledNumeric1
parentCategoryParent CategoryString64

Category Detail

Element NameDescriptionTypeLength
categoryRIDCategory Reference IDString8
sequenceSequenceString3
itemCodeItem CodeString30
itemDescriptionItem DescriptionString30


Get

Users and Administrators can retrieve Category data which can optionally contain the Product data within each Category. Select the columns to be returned in Return Maintenance.

List

Users and Administrators can retrieve Category data which can optionally contain the Product data within each Category. Select the columns to be returned in Return Maintenance.