Skip to main content (Press Enter)
Helcim Logo
Click here if you return to contents

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
0 - Invalid API Token1 The API Token is invalid, or not entered.
0 - Missing or Invalid Fields - Account ID The Account ID is invalid, or not entered.

Related Articles

View a Customer
Add or Edit a Customer
Add or Edit a Credit Card
Add or Edit a Bank Account
List Detailed Customers

Was this article helpful?

Feedback submitted - Thank you!
Click here if you return to the content