developer:soap:objects:customersearchresult

Soap API v1.2

CustomerSearchResult

Contains customer search data.

Description

This object is returned by the searchCustomers method. It describes the result of the search, including the total number of customers matched, the number being returned, and an array of CustomerObjects.

Properties

Type Name Description
integer CustomersMatched Total number of customers matched by search criteria.
integer CustomersReturned Total number of customers contained in search result.
integer StartIndex The index where this result set begins (default is 0).
integer Limit The maximum number of customers to be returned in the search.
CustomerObject Customers An array of CustomerObjects matched by search criteria.

Places Used

Examples

developer/soap/objects/customersearchresult.txt · Last modified: 2009/07/15 11:44 by epouchak

Page Tools