Helcim Logo Support & Tutorials

© Copyright 2006-2018 Helcim Inc.

All Rights Reserved.

Helcim Commerce API » Customers »

View a Customer

This API call let's you retrieve the details of a specific customer. The response is an XML of the available customer information.

Request Fields

Field Name Type Required Description
action String Yes customerView
accountId Integer Yes The Helcim Commerce account ID.
apiToken String Yes API token used for authentication and access control. 
customerCode String Yes The customer code.

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 customer name.
billingAddress - XML structure
contactName String The customer name.
businessName String The business name.
street1 String The street name.
street2 String The street name.
city String The city.
provice String The province.
country String The country.
postalCode String The postal code.
phone String The business phone number.
fax String  The business fax number.
email String The business email address.
billingAddress - XML structure
shippingAddress - XML structure
contactName String The customers name.
businessName String  The business name.
street1 String The street name.
street2 String The street name.
city String The city.
provice String The province.
country String The country.
postalCode String The postal code.
phone String The business phone number.
fax String The business fax number.
email String The business email address.
shippingAddress - XML structure
cards - XML structure
card - XML structure
cardNumber String The credit card number (first 4 and last 4 digits only)
cardToken String  The credit card token.
cardF4L4 Integer The first 4 and last 4 digits of the credit card number.
dateLastUsed String The date the credit card was last used.

Errors

For all API requests, there are also generic API authentication and user access restriction errors.
Response Code Error Code Message Description
0 - Invalid Customer Code The customer code you provided cannot be found.

Code Samples

Sample Customer View Response XML

<?xml version="1.0"?>
<customers>
    <customer>
        <customerCode>12A1155</customerCode>
        <businessName>vishna krishna</businessName>
        <contactName>vishna krishna</contactName>
        <billingAddress>
            <contactName>vishna krishna</contactName>
            <businessName></businessName>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country>--</country>
            <postalCode></postalCode>
            <phone></phone>
            <fax></fax>
            <email></email>
        </billingAddress>
        <shippingAddress>
            <contactName></contactName>
            <businessName></businessName>
            <street1></street1>
            <street2></street2>
            <city></city>
            <province></province>
            <country></country>
            <postalCode></postalCode>
            <phone></phone>
            <fax></fax>
            <email></email>
        </shippingAddress>
        <cards>
            <card>
                <cardNumber>5454********5454</cardNumber>
                <cardToken>6dc57d55b60fce3f9c6a5d</cardToken>
                <cardF4L4>54545454</cardF4L4>
                <dateLastUsed>2017-06-02 15:54:03</dateLastUsed>
            </card>
        </cards>
    </customer>
</customers>

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="customerView">
<input type="hidden" name="customerCode" value="12A1167">