Search

Contents

Revindex Storefront

Export Print

Category

The category is used to group products together in a display list. See ProductCategory section for setting up the relationship between products and categories.

DeleteCategory

This service is used to delete a Category object.

Request Parameters

Node Required Data Type
Description
categoryID Yes Integer The object identifier.

Return Data

None


GetCategory

This service is used to query the Category object.

Request Parameters

Node Required Data Type
Description
categoryID Yes Integer
The object identifier.

Return Data

Node Data Type Description
category XML
Container node.
  availabilityRule XML Rule The rule to describe the conditions when the category can be shown.
  categoryID Integer The object identifier.
  categoryKey String A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID.
  createDate DateTime Creation date.
  description XML Locale Localized description.
  displayOrder
Integer
Sort order for display.
  displayTemplate
String The associated display template.
  extension
XML Additional data in XML.
  metaDescription
XML Locale Localized meta description.
  metaKeywords
XML Locale Localized meta keywords.
  name
XML Locale Localized name.
  pageTitle
XML Locale Localized page title.
  parentCategoryID
Integer The object identifier of the parent category if this is a child category.
  portalID
Integer
  published
Boolean If category should be published and visible by end users.
  updateDate
DateTime Update date.
  urlName
XML Locale Localized URL name for SEO.
 


GetCategories

This service is used to get all the Category objects belonging to the portal.

Request Parameters

None

Return Data

Node Data Type Description
categories XML Container node
  category XML
Zero or more category nodes with same data structure as GetCategory service return data.

 


InsertCategory

This service is used to create a new Category object.

Request Parameters

Node Required Data Type Description
availabilityRule No XML Rule The rule to describe the conditions when the category can be shown.
categoryKey Yes String A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID.
description No XML Locale Localized description.
displayOrder
Yes Integer Sort order for display.
displayTemplate
No String
The associated display template.
extension
No XML Additional data in XML.
metaDescription
No XML Locale Localized meta description.
metaKeywords
No XML Locale Localized meta keywords.
name
Yes XML Locale  Localized name.
pageTitle
No XML Locale Localized page title.
parentCategoryID
No Integer The object identifier of the parent category if this is a child category.
published
Yes Boolean If category should be published and visible by end users.
urlName
No XML Locale Localized URL name for SEO.

Return Data

Same as GetCategory service return data.


UpdateCategory

This service is used to update a Category object.

Request Parameters

Node Required Data Type Description
availabilityRule No XML Rule The rule to describe the conditions when the category can be shown.
categoryID Yes Integer The object identifier.
categoryKey Yes String A unique key that can be used to uniquely identify this object. This could be a short meaningful text or simply a GUID.
description No XML Locale Localized description.
displayOrder
Yes Integer Sort order for display.
displayTemplate
No String
The associated display template.
extension
No XML Additional data in XML.
metaDescription
No XML Locale Localized meta description.
metaKeywords
No XML Locale Localized meta keywords.
name
Yes XML Locale  Localized name.
pageTitle
No XML Locale Localized page title.
parentCategoryID
No Integer The object identifier of the parent category if this is a child category.
published
Yes Boolean If category should be published and visible by end users.
urlName
No XML Locale Localized URL name for SEO.

Return Data

Same as GetCategory service return data.

 

Comments

Add comment
ajit Jul 02, 2015 3:01 PM
Is there any  way to show category by created? Like for seller only wish to show category those they created?