developer:soap:methods:searchmerchantscustom

This is an old revision of the document!


Soap API v1.2

searchMerchantsCustom

Reseller only method.

Search Merchants and return only specific fields.

Description

Use this method if you only need to view a few select fields of the merchants you are searching for. Since it will only return the fields you specify, it is more efficient than the searchMerchants method.

See also getMerchant, updateMerchant, getMerchantSummary, searchMerchantsCount

Search Fields

The following fields may be used to search the database for transactions:

  • Merchant ID
  • Contact
  • Company
  • Street
  • Street 2
  • City
  • State
  • Zip
  • Email
  • Fax
  • Phone Number

Syntax

string searchMerchantsCustom ( ueSecurityToken Token, SearchParam Search, boolean MatchAll, integer Start, integer Limit, string FieldList, string Format, string Sort)

Arguments

Type Name Description
ueSecurityToken Token Merchant security token: used to identify merchant and validate transaction.
SearchParam Search Array of search parameters (SearchParam objects) available.
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 Sequence number to start returning on.
integer Limit Maximum number of transactions to return in result set.
string FieldList String Array of fields to return in search.
string Format Specify format of return data. Possible formats include: csv, tab, xml.
string Sort Field name to sort results by

Return Value

string Base64 encode result set. Returns all of the fields from any transactions matching your search parameters.

Examples

PHP

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'=>'Activated', 'Type'=>'gt','Value'=>'2001-09-01 00:00:00'),
  );
  $start=0;
  $limit=2;
  $matchall=true;
  $fieldList=array('MerchID','Activated');
  $format ='csv';	//Specify format of return data: csv, tab, xml 		
  $sortby='merchid';
 
  $res=$client->searchMerchantsCustom($restoken,$search,$matchall,$start,$limit, $fieldList, $format, $sortby);
  print_r($res);
 
} 
 
catch(SoapFault $e) { 
  echo $client->__getLastResponse(); 
  die("Search Merchants Failed :".$e->getMessage()); 
} 
 
?> 

Change History

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

Page Tools