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)

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

<?php 
 
try { 
 
  $search=array( 
    array( 
      'Field'=>'amount',  
      'Type'=>'gt', 
      'Value'=>'8.00'), 
 
    array( 
      'Field'=>'failures',  
      'Type'=>'gt',  
      'Value'=>'0') 
    ); 
  $start=0; 
  $limit=10; 
  $matchall=true; 
  $RefNum=1009411;
  $Sort = "fname"; 
 
  $res=$client->searchCustomers($token,$search,$matchall,$start,$limit,$Sort); 
  print_r($res); 
 
  $this->assertTrue($res->CustomersMatched>0 && $res->CustomersReturned>0); 
 
} 
 
catch (SoapFault $e) { 
 
  die("Search Customers failed :" .$e->getMessage()); 
 
} 
 
?>