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

List Brands

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

Request Fields

Field Name Type Required Description
action String Yes brandsView
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
brands - XML structure
brand - XML structure
id Integer The brand ID.
merchantId Integer The merchant ID.
name String The brand name.
description String The brand description.
availability Integer 1 or 0 - Whether the brand is available for sale.
availabilityOnline Integer 1 or 0 - Whether the brand is available for sale online.
availabilityRetail Integer 1 or 0 - Whether the brand is available for sale retail.
picturesTM String The URL location of the small-size picture (500px).
picturesSM String The URL location of the small-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
List Categories
View a Brand

Was this article helpful?

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