POST api/users/customer/CustomerLookup
Lookup a customer
Request Information
URI Parameters
None.
Body Parameters
CustomerSearchViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerDID | string |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| Phone | string |
None. |
|
| string |
None. |
||
| getAll | boolean |
None. |
Request Formats
application/xml, text/xml
Sample:
<CustomerSearchViewModel> <CustomerDID>sample string 1</CustomerDID> <FirstName>sample string 2</FirstName> <LastName>sample string 3</LastName> <Phone>sample string 4</Phone> <Email>sample string 5</Email> <getAll>True</getAll> </CustomerSearchViewModel>
application/json, text/json
Sample:
{
"CustomerDID": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"Phone": "sample string 4",
"Email": "sample string 5",
"getAll": true
}
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Collection of ICustomer| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerID | integer |
None. |
|
| CustomerDID | string |
None. |
|
| BCKey | integer |
None. |
|
| CustomerTypeID | integer |
None. |
|
| FirstName | string |
None. |
|
| LastName | string |
None. |
|
| MI | string |
None. |
|
| string |
None. |
||
| Company | string |
None. |
|
| PreferredCulture | integer |
None. |
|
| Password | string |
None. |
|
| BillStreet1 | string |
None. |
|
| BillStreet2 | string |
None. |
|
| BillCity | string |
None. |
|
| BillState | string |
None. |
|
| BillPostalCode | string |
None. |
|
| BillCountry | string |
None. |
|
| BillCounty | string |
None. |
|
| ShipStreet1 | string |
None. |
|
| ShipStreet2 | string |
None. |
|
| ShipCity | string |
None. |
|
| ShipState | string |
None. |
|
| ShipPostalCode | string |
None. |
|
| ShipCountry | string |
None. |
|
| ShipCounty | string |
None. |
|
| Phone1 | string |
None. |
|
| Phone2 | string |
None. |
|
| Phone3 | string |
None. |
|
| Phone4 | string |
None. |
|
| Phone5 | string |
None. |
|
| Phone6 | string |
None. |
|
| TaxExemptCodeID | string |
None. |
|
| TaxExempt | boolean |
None. |
|
| TaxID | string |
None. |
|
| TaxID2 | string |
None. |
|
| ReferralMarketTypeID | integer |
None. |
|
| ReferralMarketTypeInput | string |
None. |
|
| ReferCustomerID | integer |
None. |
|
| CreatedBy | string |
None. |
|
| PasswordResetKey | string |
None. |
|
| PasswordResetExpirationDate | date |
None. |
|
| DateOfBirth | date |
None. |
|
| ApplicationDate | date |
None. |
|
| StatusTypeID | integer |
None. |
|
| ContactStatusID | integer |
None. |
|
| RomanizedName | string |
None. |
|
| ReciprocalRepID | integer |
None. |
|
| LastModifiedBy | string |
None. |
|
| DateLastModified | date |
None. |
|
| TaxExemptReasonTypeID | integer |
None. |
|
| UpgradeRepID | integer |
None. |
|
| PhonesComputed | string |
None. |
|
| CreatedDate | date |
None. |
|
| guid | string |
None. |
|
| AccountNumber | string |
None. |
|
| Gender | string |
None. |
|
| EmailOptOut_Company | boolean |
None. |
|
| EmailOptOut_Upline | boolean |
None. |
Response Formats
application/xml, text/xml, application/json, text/json
Sample:
Sample not available.