Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Inventory »

List Detailed Products

CHANGEThis 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 productSearchDetail
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
products - XML structure
product - XML structure
id Integer The product ID.
name String The product name.
sku Integer The product sku.
brand - XML structure
id Integer Tthe brand ID.
brand - XML structure
category - XML structure
id Integer The category ID.
name String The category name.
category - XML structure
description String The product description.
barcode Integer The product barcode.
availability Integer 1 or 0 - Whether the product is available for sale.
availabilityOnline Integer 1 or 0 - Whether the product is available for sale online.
availabilityRetail Integer 1 or 0 - Whether the product is available for sale retail.
featured Integer 1 or 0 - Whether the product is featured (front page) item online.
stock Integer The number of items in stock.
price Decimal The product price.
salePrice Decimal The product sale price.
weight Decimal The product weight - based on Helcim Commerce Unit of Measurement (UoM) account settings.
dimensionW Decimal The product width- based on Helcim Commerce Unit of Measurement (UoM) account settings.
dimensionL Decimal The product length - based on Helcim Commerce Unit of Measurement (UoM) account settings.
dimensionH Decimal The product height - based on Helcim Commerce Unit of Measurement (UoM) account settings.
shippingExempt Integer 1 or 0 - Whether the product is exempt from shipping fees.
taxExempt Integer 1 or 0 - Whether the product is exempt from taxes.
backgroundColor String The product background color.
picture String The URL location of the product picture.
variants - XML structure
variant - XML structure
id Integer The variant ID.
options String The variant option.
sku String The variant sku.
barcode Integer The variant barcode.
stock Integer The number of items in stock.
price Decimal The variant price.
weight Decimal The variant weight.
variant - XML structure
variants - XML structure
options - XML Structure
option - XML Structure
id Integer The option ID.
name String The option name.
options String The available choices for this option.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description

Code Samples

Sample List Detailed Products Response XML

<products>
    <product>
        <id>211</id>
        <name>Beach bags</name>
        <sku>123654</sku>
        <brand>
            <id>4</id>
            <name>Fancy</name>
        </brand>
        <category>
            <id>4</id>
            <name>Things</name>
        </category>
        <description>A little jar of awesome goes a long way.</description>
        <barcode>123123123123123213</barcode>
        <availability>1</availability>
        <availabilityOnline>1</availabilityOnline>
        <availabilityRetail>1</availabilityRetail>
        <featured>0</featured>
        <stock>92</stock>
        <price>20.00</price>
        <salePrice>15.00</salePrice>
        <weight>0.00</weight>
        <dimensionW>0.00</dimensionW>
        <dimensionL>0.00</dimensionL>
        <dimensionH>0.00</dimensionH>
        <shippingExempt>0</shippingExempt>
        <taxExempt>0</taxExempt>
        <backgroundColor>EBF0BE</backgroundColor>
        <picture>https://team.myhelcim.com/images/9/smHelcimCommerce-product211-149099048082.jpg</picture>
        <variants>
            <variant>
                <id>34</id>
                <options>[Size] small [Color] red</options>
                <sku>123654-SSCR1</sku>
                <barcode>137345</barcode>
                <stock>-4</stock>
                <price>25.00</price>
                <weight>0.00</weight>
            </variant>
            <variant>
                <id>38</id>
                <options>[Size] small [Color] blue</options>
                <sku>123654-SSCB2</sku>
                <barcode>065030804080</barcode>
                <stock>-4</stock>
                <price>20.00</price>
                <weight>0.00</weight>
            </variant>
            <variant>
                <id>42</id>
                <options>[Size] small [Color] green</options>
                <sku>123654-SSCG3</sku>
                <barcode></barcode>
                <stock>-10</stock>
                <price>20.00</price>
                <weight>0.00</weight>
            </variant>
            <variant>
                <id>46</id>
                <options>[Size] large [Color] red</options>
                <sku>123654-SLCR4</sku>
                <barcode></barcode>
                <stock>1</stock>
                <price>20.00</price>
                <weight>0.00</weight>
            </variant>
            <variant>
                <id>50</id>
                <options>[Size] large [Color] blue</options>
                <sku>123654-SLCB5</sku>
                <barcode>98356</barcode>
                <stock>-6</stock>
                <price>20.00</price>
                <weight>0.00</weight>
            </variant>
            <variant>
                <id>54</id>
                <options>[Size] large [Color] green</options>
                <sku>123654-SLCG6</sku>
                <barcode>43486</barcode>
                <stock>-19</stock>
                <price>20.00</price>
                <weight>0.00</weight>
            </variant>
        </variants>
        <options>
            <option>
                <id>10</id>
                <name>Size</name>
                <options>small,large</options>
            </option>
            <option>
                <id>14</id>
                <name>Color</name>
                <options>red,blue,green</options>
            </option>
        </options>
    </product>

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