Excerpt | ||
---|---|---|
Use this method to get a list of Contacts from a specific Customer.
|
Filter by label (Content by label) | ||||||||
---|---|---|---|---|---|---|---|---|
|
Request
URL: https://api.kometsales.com/api/customer.contact.list
Method: GET
Content-Type: URL Parameters
Input parameters
authenticationToken (required)(string:50)
Komet Sales security token.
customerId (required)(integer:20)
Komet Sales internal customer ID.
You can get this value from the customer.list API method.
Code Block | ||
---|---|---|
| ||
https://api.kometsales.com/api/customer.contact.list? authenticationToken=token_info_goes_here&customerId=6236 |
Request
status (integer:1)
Transaction status.
Valid values: 1 = Success | 0 = Failure
message (string:500)
Transaction status description.
contacts (array)
An array containing the Customer’s contacts.
id (integer:20)
Komet Sales internal contact ID.
name (string:200)
Contact’s name.
type (string: 50)
The contact type.
Example: A/P, Buyer, etc.
phone (string:50)
Phone number.
ext (string:50)
Phone number extension.
mobile (string:50)
Mobile phone number.
fax (string:50)
Fax number.
email (string:50)
Email address.
description (string:200)
Description.
instantMessaging (string:200)
Instant messaging number.
emailPOD (boolean)
If the contact receives PODs via email.
Code Block | ||
---|---|---|
| ||
{ "status": "1", "message": "OK", "contacts": [ { "id": 23423, "name": "Joe Smith", "type": "Buyer", "phone": "594-123-0982", "ext": "345", "mobile": "305-0112-0982", "fax": "594-123-0112", "email": "contact@mydomain.com", "description": "nothing special", "instantMessaging": "594-123-0982", "emailPOD": false }, { "id": 23245, "name": "Lance Bossard", "type": "A/P", "phone": "594-123-8615", "ext": "349", "mobile": "305-0112-0982", "fax": "594-123-0122", "email": "contact@mydomain.com", "description": "nothing special", "instantMessaging": "594-123-0982", "emailPOD": true } ] } |