Skip to main content (Press Enter)
Helcim Logo
Click here if you return to contents

List Categories

This API call let's you retrieve a list of available categories. The response is an XML of the categories' information.

Request Fields

Field Name Type Required Description
action String Yes categoriesView
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control.

Response Fields

Field Name Type Description
categories - XML structure
category - XML structure
id Integer The category ID.
parentId Integer The parent category ID.
merchantId Integer The merchant ID.
name String The category name.
description String The category description.
availability Integer 1 or 0 - Whether the category is available for sale.
availabilityOnline Integer 1 or 0 - Whether the category is available for sale online.
availabilityRetail Integer 1 or 0 - Whether the category is available for sale retail.
backgroundColor String The category background color.
pictureTM String The URL location of the small-size picture (500px)
pictureSM String The URL location of the thumbnail-size picture (120px)

Errors

For all API requests, there are also generic API authentication and user access restriction errors.

Response Code Error Code Message Description
0 - Invalid API Token1 The API Token is invalid, or not entered.
0 - Missing or Invalid Fields - Account ID The Account ID is invalid, or not entered.

Related Articles

View a Product
Add or Edit a Product
Update Product Inventory
List Products
View a Category
View a Brand
List Brands

Was this article helpful?

Feedback submitted - Thank you!
Click here if you return to the content