developer:soap:methods:searchmerchantscustom

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
  • Street2
  • City
  • State
  • Zip
  • Email
  • Fax
  • Phone

Syntax

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

Arguments

Type Name Description
ueSecurityToken Token Reseller security token, used to identify reseller and validate request.
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 merchant found).
integer Limit Maximum number of merchants 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.
string Sort Field name to sort the results by

Return Value

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

Examples

Change History

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

Page Tools