Search for customers, return custom result set.
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, sort and return are:
See also searchcustomers, searchcustomerscount, searchCustomerID
string searchCustomersCustom ( ueSecurityToken Token, SearchParam Search, boolean MatchAll, integer Start, integer Limit, string FieldList, string Format, 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 | FieldList | String Array of fields to return in search. |
string | Format | Specify format of return data. Possible formats include: csv, tab, xml, php, json |
string | Sort | Field name to sort the results by |
string | Base64 encode result set. Returns all of the fields from any customers matching your search parameters. |
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'=>'customerid', 'Type'=>'gt', 'Value'=>'0') ); $start=0; $limit=10; $matchall=true; $fieldList = array('CustNum', 'BillingAddress.Company', 'Amount', 'Next'); $format='csv'; $Sort='fname'; $res=$this->client->searchCustomersCustom($this->token,$search,$matchall,$start,$limit,$fieldList,$format,$Sort); $res=base64_decode($res); print_r($res); } catch (SoapFault $e) { die("Search Customers failed :" .$e->getMessage()); } ?>
Dim matchAll As Boolean matchAll = True Dim search(0 To 1) As usaepay.SearchParam search(0) = New usaepay.SearchParam() search(0).Field = "Created" search(0).Type = "gt" search(0).Value = "2010-10-18" Dim FieldList(0 To 2) As String FieldList(0) = "CustNum" FieldList(1) = "BillingAddress.Company" FieldList(2) = "Amount" Dim result As String result = client.searchCustomersCustom(token, search, matchAll, "0", "10", FieldList, "csv", "fname") Dim binaryData() As Byte binaryData = Convert.FromBase64String(result) MsgBox(Encoding.UTF8.GetString(binaryData))
Boolean matchAll = true; usaepay.SearchParam[] search = new usaepay.SearchParam[2]; search[0] = new usaepay.SearchParam(); search[0].Field = "Created"; search[0].Type = "gt"; search[0].Value = "2010-09-16"; string[] FieldList = new string[3]; FieldList[0] = "CustNum"; FieldList[1] = "BillingAddress.Company"; FieldList[2] = "Amount"; string result; try { result = client.searchCustomersCustom(token, search, matchAll, "0", "10", FieldList, "csv", "fname"); Byte[] binaryData = new Byte[3]; binaryData = Convert.FromBase64String(result); MessageBox.Show(Encoding.UTF8.GetString(binaryData)); } catch (Exception err) { MessageBox.Show(err.Message); }
Version | Change |
---|---|
1.2 | Added Sort Parameter |
1.1 | Soap 1.1 Release |
1.0 | Method added in soap v1.0 |