Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Customers »

List Detailed Customers

This API call let's you retrieve a customer list. The response is an XML of the customer search.

Request Fields

Field Name Type Required Description
action String Yes customerSearchDetail
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
customers - XML structure
customer - XML structure
customerCode String The customer code.
businessName String The business name.
contactName String The contact name.
dateCreated String The date this customer entry was created.
dateUpdated String The date this customer entry was updated.
createdBy Integer Id of user who created the customer.
passwordExpiry String The date the password expires.
loginStatus Integer 1 or 0. Whether or not the customer can login. 
loginAttempts Integer Current consecutive failed login attempts.
cellPhone String The customer's cell phone number.
lastIpAddress String  The last IP address the customer logged in from.
lastPIN String The customer's last PIN.
lastLoginDate String The date the customer last logged in.
acceptsMarketing Integer 1 or 0. Whether or not the customer accepts receiving marketing materials.
tax exempt Integer 1 or 0. Whether or not the customer is tax exempt.
wholesale Integer 1 or 0. Whether or not the customer gets wholesale price. 
vatNumber Interger The VAT identification number.
billingAddress - XML structure
street1 String The street address.
street2 String  The street address.
city String The city.
province String The province.
country String  The country.
postalCode String  The postal code.
phone String The phone number.
fax String The fax number.
email String  The email address.
billingAddress - XML structure
shippingAddress - XML structure
street1 String  The street address.
street2 String The street address.
city String The city.
province String The province.
country String The country.
postalCode String The postal code.
phone String  The phone number.
fax String  The fax number.
email String  The email address.

Errors

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

Code Samples

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

Sample Customer Detailed Search Response XML

<?xml version="1.0"?>
<customers>
    <customer>
        <customerCode>12A1008</customerCode>
        <businessName>xo productions</businessName>
        <contactName>the weeknd</contactName>
        <dateCreated>2017-03-02 12:29:33</dateCreated>
        <dateUpdated>2017-03-02 12:29:33</dateUpdated>
        <createdBy>17</createdBy>
        <passwordExpiry>0000-00-00 00:00:00</passwordExpiry>
        <loginStatus>0</loginStatus>
        <loginAttempts>0</loginAttempts>
        <cellPhone></cellPhone>
        <lastIpAddress></lastIpAddress>
        <lastPIN></lastPIN>
        <lastLoginDate>0000-00-00 00:00:00</lastLoginDate>
        <acceptsMarketing>1</acceptsMarketing>
        <taxExempt>0</taxExempt>
        <wholesale>0</wholesale>
        <vatNumber></vatNumber>
        <billingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone>49338883</phone>
            <fax></fax>
            <email>slevina@helcim.com</email>
        </billingAddress>
        <shippingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone>49338883</phone>
            <fax></fax>
            <email>slevina@helcim.com</email>
        </shippingAddress>
    </customer>
    <customer>
        <customerCode>CST1107</customerCode>
        <businessName>yay</businessName>
        <contactName>jd</contactName>
        <dateCreated>2017-02-27 17:06:49</dateCreated>
        <dateUpdated>2017-02-27 17:06:49</dateUpdated>
        <createdBy>52</createdBy>
        <passwordExpiry>0000-00-00 00:00:00</passwordExpiry>
        <loginStatus>0</loginStatus>
        <loginAttempts>0</loginAttempts>
        <cellPhone></cellPhone>
        <lastIpAddress></lastIpAddress>
        <lastPIN></lastPIN>
        <lastLoginDate>0000-00-00 00:00:00</lastLoginDate>
        <acceptsMarketing>1</acceptsMarketing>
        <taxExempt>0</taxExempt>
        <wholesale>0</wholesale>
        <vatNumber></vatNumber>
        <billingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone></phone>
            <fax></fax>
            <email></email>
        </billingAddress>
        <shippingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone></phone>
            <fax></fax>
            <email></email>
        </shippingAddress>
    </customer>
    <customer>
        <customerCode>12A1002</customerCode>
        <businessName>yyh</businessName>
        <contactName>hhb</contactName>
        <dateCreated>2017-03-01 16:34:53</dateCreated>
        <dateUpdated>2017-03-01 16:34:53</dateUpdated>
        <createdBy>6246</createdBy>
        <passwordExpiry>0000-00-00 00:00:00</passwordExpiry>
        <loginStatus>0</loginStatus>
        <loginAttempts>0</loginAttempts>
        <cellPhone></cellPhone>
        <lastIpAddress></lastIpAddress>
        <lastPIN></lastPIN>
        <lastLoginDate>0000-00-00 00:00:00</lastLoginDate>
        <acceptsMarketing>1</acceptsMarketing>
        <taxExempt>0</taxExempt>
        <wholesale>0</wholesale>
        <vatNumber></vatNumber>
        <billingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone>hhhh</phone>
            <fax></fax>
            <email></email>
        </billingAddress>
        <shippingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone>hhhh</phone>
            <fax></fax>
            <email></email>
        </shippingAddress>
    </customer>
    <customer>
        <customerCode>CST1082</customerCode>
        <businessName>yyuuu</businessName>
        <contactName>nnnfffuuu</contactName>
        <dateCreated>2017-02-27 16:20:14</dateCreated>
        <dateUpdated>2017-02-27 16:20:14</dateUpdated>
        <createdBy>52</createdBy>
        <passwordExpiry>0000-00-00 00:00:00</passwordExpiry>
        <loginStatus>0</loginStatus>
        <loginAttempts>0</loginAttempts>
        <cellPhone></cellPhone>
        <lastIpAddress></lastIpAddress>
        <lastPIN></lastPIN>
        <lastLoginDate>0000-00-00 00:00:00</lastLoginDate>
        <acceptsMarketing>1</acceptsMarketing>
        <taxExempt>0</taxExempt>
        <wholesale>0</wholesale>
        <vatNumber></vatNumber>
        <billingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone></phone>
            <fax></fax>
            <email></email>
        </billingAddress>
        <shippingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone></phone>
            <fax></fax>
            <email></email>
        </shippingAddress>
    </customer>
    <customer>
        <customerCode>CST1083</customerCode>
        <businessName>yyuuu</businessName>
        <contactName>nnnfffuuu</contactName>
        <dateCreated>2017-02-27 16:20:15</dateCreated>
        <dateUpdated>2017-02-27 16:20:15</dateUpdated>
        <createdBy>52</createdBy>
        <passwordExpiry>0000-00-00 00:00:00</passwordExpiry>
        <loginStatus>0</loginStatus>
        <loginAttempts>0</loginAttempts>
        <cellPhone></cellPhone>
        <lastIpAddress></lastIpAddress>
        <lastPIN></lastPIN>
        <lastLoginDate>0000-00-00 00:00:00</lastLoginDate>
        <acceptsMarketing>1</acceptsMarketing>
        <taxExempt>0</taxExempt>
        <wholesale>0</wholesale>
        <vatNumber></vatNumber>
        <billingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone></phone>
            <fax></fax>
            <email></email>
        </billingAddress>
        <shippingAddress>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone></phone>
            <fax></fax>
            <email></email>
        </shippingAddress>
    </customer>
</customers>