This API call lets you retrieve a category. The response is an XML of the category's information.
Request Fields
Field Name |
Type |
Required |
Description |
action |
String |
Yes |
categoryView |
accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
apiToken |
String |
Yes |
API token used for authentication and access control. |
categoryId |
Integer |
Yes |
The category ID you wish to view. |
Response Fields
Field Name |
Type |
Description |
categories |
- |
XML structure |
category |
- |
XML structure |
id |
Integer |
The category ID. |
name |
String |
The category name. |
availability |
Integer |
1 or 0 - Whether the product is available for sale. |
description |
String |
The category description |
picture |
String |
The URL location of the category picture. |
products |
- |
XML structure |
product |
- |
XML structure |
id |
Integer |
The product ID. |
name |
String |
The product name. |
SKU |
Integer |
The product SKU. |
stock |
Integer |
The number of items in stock. |
price |
Decimal |
The product price. |
salePrice |
Decimal |
The product sale price. |
availability |
Integer |
1 or 0 - Whether the product is available for sale. |
availabilityOnline |
Interger |
1 or 0 - Whether the product is available for sale online. |
picture |
String |
The URL location of the product picture. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
Response Code |
Error Code |
Message |
Description |
0 |
- |
Invalid Category ID |
The category ID you provided could not be found. |
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. |