search
The search operation is used to execute a search on a specific record type based on a set of criteria. You can search by defining search filter fields on the record, joined fields on an associated record, search return columns, or joined search return columns from an associated record. The results of the search can be complete records, or a select set of fields specified through search return columns.
Note that you can also use the search operation to return an existing saved search. You cannot use the search operation to retrieve state values. You must use the getAll operation to retrieve all state values in the system. The getAll operation will return all states, not the legal ones for your default country. Also note that the country and state must match on the address.
The search preferences you set in the SearchPreferences object affect the search request and response. See SOAP Web Services Preferences for details.
Use the search operation to execute the following types of searches:
-
Basic search — Execute a search on a record type based on search filter fields that are specific to that type. See Basic Searches in SOAP Web Services.
-
Joined search — Execute a search on a record type based on search filter fields on an associated record type. See Joined Searches in SOAP Web Services
-
Advanced search — Execute a search on a record type in which you specify search filter fields and/or search return columns or joined search columns. Using advanced search, you can also return an existing saved search. See Advanced Searches in SOAP Web Services.
An asynchronous equivalent is available for the search operation, asyncSearch. For information about asynchronous request processing, see Synchronous Versus Asynchronous Request Processing.
Not all transaction types are supported by SOAP web services searches. For the list of unsupported transactions, see Transaction Search.
Also see the following sections for information on setting additional search filtering values and searching for custom fields:
To go directly to search-related code samples, see Search-Related Sample Code.