Soap API v1.2


Search for customers.


This method allows you to search the customer database using flexible search terms. This method searches the customer database (aka recurring billing) not the transactions history. To search the transaction history for a specific customer, use either the searchTransactions or getCustomerHistory method.

Use as many or as few search terms as you like. With MatchAll set to “true,” all terms must match to return a result. If the search does not yield the desired results, try broadening your search by eliminating terms, or change MatchAll to “false.”

Valid field names for search and sort are:

  • BillingAddress.FirstName
  • BillingAddress.lastname
  • BillingAddress.Company
  • BillingAddress.Street
  • BillingAddress.Street2
  • BillingAddress.City
  • BillingAddress.State
  • BillingAddress.Zip
  • BillingAddress.Country
  • BillingAddress.Phone
  • BillingAddress.Fax
  • BillingAddress.Email
  • Amount
  • CustNum
  • CustomerID
  • Created
  • Description
  • Enabled
  • Failures
  • Modified
  • Start
  • Next
  • Notes
  • NumLeft
  • OrderID
  • ReceiptNote
  • Schedule (1=Daily,2=Weekly,3=Bi-Weekly,4=Monthly,5=Bi-Monthly,6=Quarterly,7=Bi-Annually,8=Annually,9=First of Month, 10=Last Day of Month)
  • SendReceipt
  • Source
  • Tax
  • User

See also searchcustomerscustom, searchcustomerscount, searchCustomerID


CustomerSearchResult searchCustomers ( 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"; 
  $this->assertTrue($res->CustomersMatched>0 && $res->CustomersReturned>0); 
catch (SoapFault $e) { 
  die("Search Customers failed :" .$e->getMessage()); 

Change History

Version Change
1.2 Added Sort Parameter
1.1 Soap 1.1 Release
developer/soap/methods/searchcustomers.txt · Last modified: 2009/08/27 14:20 by tem

Page Tools