This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module Customer searchCustomerRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Customer > Search== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |customer |- style="background-color:#EEEEEE;" |'''Command name''' |…')
Line 31: Line 31:
*[[API Format Phone|fax]]
*[[API Format Phone|fax]]
*email
*email
-
*[[API Format Additional Data|additionalData]] (if withAdditionalData = true)
+
*[[API Format Additional Data Customer|additionalData]] (if withAdditionalData = true)
|}
|}

Revision as of 13:12, 6 April 2010

Contents

Module Customer > Search

Module customer
Command name searchCustomerRequest
Use Returns a list of customer objects matching search criteria
Input
  • limit
  • offset
  • emailPattern
  • lastNamePattern
  • companyNamePattern
  • withAdditionalData
Output Result set of customer details:

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchCustomerRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'offset' => 50,
   'limit'  => 25,
   'emailPattern' => '*@openprovider.nl',
   'lastNamePattern' => 'Smith',
   'companyNamePattern' => '*prov*'
 ));

Raw XML

to do
Views
Personal tools