Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Inventory »

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 (XML)

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

Code Samples

List Brand Response XML

<?xml version="1.0"?>
<brands>
    <brand>
        <id>4</id>
        <merchantId>9</merchantId>
        <name>Fancy</name>
        <description></description>
        <availability>1</availability>
        <availabilityOnline>1</availabilityOnline>
        <availabilityRetail>1</availabilityRetail>
        <pictureTM>https://team.myhelcim.com/images/9/tmHelcimCommerce-brand4-148766938788.jpg</pictureTM>
        <pictureSM>https://team.myhelcim.com/images/9/smHelcimCommerce-brand4-148766938788.jpg</pictureSM>
    </brand>
    <brand>
        <id>27</id>
        <merchantId>9</merchantId>
        <name>Super Fancy</name>
        <description></description>
        <availability>1</availability>
        <availabilityOnline>1</availabilityOnline>
        <availabilityRetail>1</availabilityRetail>
        <pictureTM></pictureTM>
        <pictureSM></pictureSM>
    </brand>
    <brand>
        <id>95</id>
        <merchantId>9</merchantId>
        <name>New Things</name>
        <description>Really new things</description>
        <availability>1</availability>
        <availabilityOnline>1</availabilityOnline>
        <availabilityRetail>1</availabilityRetail>
        <pictureTM></pictureTM>
        <pictureSM></pictureSM>
    </brand>
    <brand>
        <id>101</id>
        <merchantId>9</merchantId>
        <name>Sumo Burgers</name>
        <description></description>
        <availability>1</availability>
        <availabilityOnline>0</availabilityOnline>
        <availabilityRetail>1</availabilityRetail>
        <pictureTM>https://team.myhelcim.com/images/9/tmHelcimCommerce-brand101-149693949990.jpg</pictureTM>
        <pictureSM>https://team.myhelcim.com/images/9/smHelcimCommerce-brand101-149693949990.jpg</pictureSM>
    </brand>
    <brand>
        <id>105</id>
        <merchantId>9</merchantId>
        <name>In Your Ear East</name>
        <description>East Location</description>
        <availability>1</availability>
        <availabilityOnline>1</availabilityOnline>
        <availabilityRetail>1</availabilityRetail>
        <pictureTM></pictureTM>
        <pictureSM></pictureSM>
    </brand>
</brands>

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="brandsView">