ProductCategory is the relationship that joins the Product to the Category object.
DeleteProductCategory
This service is used to delete a ProductCategory object.
Request Parameters
Node |
Required |
Data Type |
Description |
productCategoryID |
Yes |
Integer |
The object identifier. |
Return Data
None
GetProductCategory
This service is used to query the ProductCategory object.
Request Parameters
Node |
Required |
Data Type |
Description |
productCategoryID |
Yes |
Integer |
The object identifier. |
Return Data
Node |
Data Type |
Description |
productCategory |
XML |
Container node. |
categoryID |
Integer |
The Category object identifier. |
createDate |
DateTime |
Creation date. |
defaultCategory |
Boolean |
Specify if this is the default category association for this product. The default category is shown on the breadcrumb if customer arrived on the product detail page without selecting a category, manufacturer, distributor or coming from a search. |
productCategoryID |
Integer |
The object identifier. |
productID |
Integer |
The Product object identifier. |
GetProductCategoriesByCategory
This service is used to get all the ProductCategory objects belonging to the category.
Request Parameters
Node |
Required |
Data Type |
Description |
categoryID |
Yes |
Integer |
The Category object identifier. |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
skip |
No |
Integer |
The number of records to skip over for paging purposes. |
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
productCategories |
XML |
Container node |
productCategory |
XML |
Zero or more productCategory nodes with same data structure as GetProductCategory service return data. |
GetProductCategoriesByPortal
This service is used to get all the ProductCategory objects belonging to the category.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
skip |
No |
Integer |
The number of records to skip over for paging purposes. |
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
productCategories |
XML |
Container node |
productCategory |
XML |
Zero or more productCategory nodes with same data structure as GetProductCategory service return data. |
GetProductCategoriesByProduct
This service is used to get all the ProductCategory objects belonging to the product.
Request Parameters
Node |
Required |
Data Type |
Description |
count |
No |
Boolean |
Specify if return data should include total number of records found. |
productID |
Yes |
Integer |
The Product object identifier. |
skip |
No |
Integer |
The number of records to skip over for paging purposes. |
take |
No |
Integer |
The number of records to return for paging purposes. |
Return Data
Node |
Data Type |
Description |
totalCount |
Integer |
Number of records found. |
productCategories |
XML |
Container node |
productCategory |
XML |
Zero or more productCategory nodes with same data structure as GetProductCategory service return data. |
InsertProductCategory
This service is used to create a new ProductCategory object.
Request Parameters
Node |
Required |
Data Type |
Description |
categoryID |
Yes |
Integer |
The Category object identifier. |
defaultCategory |
Yes |
Boolean |
Specify if this is the default category association for this product. The default category is shown on the breadcrumb if customer arrived on the product detail page without selecting a category, manufacturer, distributor or coming from a search. |
productID |
Yes |
Integer |
The Product object identifier. |
Return Data
Same as GetProductCategory service return data.