Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Inventory »

View a Brand

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

Request Fields

Field Name Type Required Description
action String Yes brandView
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
brandId Integer Yes  The brand ID you wish to view.

Response Fields (XML)

Field Name Type Description
brands - XML structure
brand - XML structure
id Integer The brand ID.
name String The brand name.
availability Integer The brand availability.
description - XML structure
picture String The URL location of the brand 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.


For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Invalid Brand ID The brand ID you provided could not be found.

Code Samples

Sample Brand Response XML

<?xml version="1.0"?>
        <name>Sumo Burgers</name>
                <name>The Featherweight</name>
                <name>The Heavyweight</name>
                <name>The Lightweight</name>
                <name>The Sumoweight</name>
                <name>The Welterweight</name>

HTML Form Sample HTML

<input type="hidden" name="accountId" value="YOUR-ACCOUNT-ID">
<input type="hidden" name="apiToken" value="YOUR-API-TOKEN">
<input type="hidden" name="action" value="brandView">
<input type="hidden" name="brandId" value="4">