Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Customers »

List 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 customerSearch
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.

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 Listing Customers Response XML

<?xml version="1.0"?>
<customers> 
    <customer>
        <customerCode>1-WC</customerCode>
        <businessName></businessName>
        <contactName></contactName>
    </customer>
    <customer>
        <customerCode>12A1000</customerCode>
        <businessName></businessName>
        <contactName></contactName>
    </customer>
    <customer>
        <customerCode>12A1003</customerCode>
        <businessName></businessName>
        <contactName></contactName>
    </customer>
    <customer>
        <customerCode>12A1004</customerCode>
        <businessName></businessName>
        <contactName></contactName>
    </customer>
    <customer>
        <customerCode>12A1006</customerCode>
        <businessName></businessName>
        <contactName></contactName>
    </customer>
    <customer>
        <customerCode>12A1007</customerCode>
        <businessName></businessName>
        <contactName></contactName>
    </customer>
    <customer>
        <customerCode>12A1014</customerCode>
        <businessName></businessName>
        <contactName></contactName>
    </customer>
    <customer>
        <customerCode>12A1018</customerCode>
        <businessName></businessName>
        <contactName>ikkj</contactName> 
   <customer>
        <customerCode>12A1075</customerCode>
        <businessName>Testing Test Inc</businessName>
        <contactName>Aaron Test</contactName>
    </customer>
</customers>

HTML Form Sample Code

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