contact:search

Search for contacts.

Parameters

Permitted search fields are:

  • code
  • email_address
  • firstname
  • lastname
  • company
  • postcode

Brightpearl API will return a set of contacts as per contact:list method.

Search is wildcard after : eg searching for "James" will perform /james*/

If multiple parameters are passed, the search is AND-ed

Request

<?xml version="1.0" encoding="utf-8"?> 
<request method="contact.search">
<auth token="xxxxxxxx" user="user@test.com" pass="xxxxxxxx" />
<email_address>mine@email.com</email_address>
<firstname>james</contact_firstname>
  <page>1</page>
  <per_page>25</per_page>
</request>

Response

The ID of the contact just created will be returned.

<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>OK</status>
<message>Contact created</message>
<datetimeutc>2009-10-29T09:06:42Z</datetimeutc>
<requesttime>0.23490</requesttime>
<contacts>
  <contact>
  ... full set of contact data as per contact:get
</contact>
  <contact>
  ... full set of contact data as per contact:get
 </contact>
</contacts>
<response>