...
The following table provides the URI and method that can be used to search for customer in Crittah.
| Method | Result |
|---|---|
| URI | https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/customers/search |
| POST | Post a JSON or XML object with search criteria. |
Search Fields
| Field | Value type | Mandatory | Description | Example |
|---|---|---|---|---|
| CompanyName | string | Company name of customer. Partial matches will return results. | Megga Corp | |
| CompanyNo | string | Company number of customer. Partial matches will return results. | ABN65482555 | |
| Phone | string | Phone number of the contact. Partial matches will return results. | 987649874 | |
| Mobile | string | Mobile phone number of the contact. Partial matches will return results. | 041658246 | |
| Fax | string | Fax number of the contact. Partial matches will return results. | 6546548665 | |
| City | string | City of the contact. Partial matches will return results. | Sydney | |
| CustomerRef | string | The unique reference of the customer allocated by Crittah customer is created | 6548335 | |
| PostalCode | string | Post code of the customer. Partial matches will return results. |
Example Search
Perform a POST to the following URLÂ https://[companyID].crittah.com/ws/apiv2/json/customers/search
JSON
| Code Block |
|---|
{
"CompanyName": "Super Corp"
} |
XML
| Code Block |
|---|
<?xml version="1.0" encoding="UTF-8"?>
<CustomeSearchParamsComplex xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<CompanyName>Super Corp</CompanyName>
</CustomeSearchParamsComplex> |
Working with a single customer
...