Soap API v1.2


Search for customers, only return customer counts


Identical to the searchCustomers method except only the customer counts are returned. Like searchCustomers, this method returns CustomerSearchResult. The only difference is that CustomerSearchResult.Customers is left empty. This method provides a quicker way to determine the size of the result set before starting to retrieve the full search results.

See also searchCustomers, searchCustomersCustom


CustomerSearchResult searchCustomersCount ( ueSecurityToken Token, SearchParam Search, boolean MatchAll, integer Start, integer Limit, string Sort)


Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
SearchParam Search Array of search parameters.
boolean MatchAll If set to “true,” only results matching all search criteria will be returned, if set to “false,” results matching any of the search criteria will be returned.
integer Start Start position, defaults to 0 (first customer found).
integer Limit Maximum number of customers to return in result.
string Sort Field name to sort the results by

Return Value

CustomerSearchResult Returns results of customer search based on parameters set.



For directions on how to set up the WSDL link, create “$token” and “$client”, go to PHP Soap How-to.

try { 
  $Sort = "fname"; 
catch (SoapFault $e) { 
  die("Search Customers failed :" .$e->getMessage()); 

Change History

Version Change
1.2 Method added in soap 1.2 release
developer/soap/methods/searchcustomerscount.txt · Last modified: 2009/07/24 00:32 by tem

Page Tools