CustomerSearchResponse
objectA customer record.
The customer’s name.
Example:Acu Logistics
The Central Dispatch customer ID of the customer.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002
The email address of the customer.
Example:trans-port@notgmail.com
Details of a customer’s phone number.
Show Child Parameters
Details of a customer’s address.
Show Child Parameters
Details of a customer’s authority number.
Show Child Parameters
{
"customerName": "Acu Logistics",
"customerId": "d5c62b14-cbd1-11ee-9a0e-0242ac110002",
"email": "trans-port@notgmail.com",
"phoneNumbers": [
{
"phoneNumber": "949-555-1323",
"type": "LOCAL",
"extension": "303",
"notes": "Primary contact number"
}
],
"addresses": [
{
"streetAddress": "345 W Elm St.",
"streetAddress2": "2nd Floor",
"city": "Anaheim",
"state": "CA",
"zipcode": "92802",
"type": "PRIMARY"
}
],
"customerAuthorityNumbers": [
{
"number": "DL 01-00673-10",
"verified": true,
"type": "DEALER_LICENSE"
}
]
}Error
objectDetails of an error or issue.
The code used for the issue.
Example:resource.issue_type
A detailed message.
Example:The issue happened because something is wrong.
The property to which the issue is associated.
Example:person
Additional properties related to the issue.
Example:{"firstName":"D0nn@","lastName":"Sm!th"}
{
"code": "resource.issue_type",
"message": "The issue happened because something is wrong.",
"property": "person",
"properties": {
"firstName": "D0nn@",
"lastName": "Sm!th"
}
}Errors
objectAn error occurred, and the request could not be completed.
Details of an error or issue.
Show Child Parameters
{
"errors": [
{
"code": "resource.issue_type",
"message": "The issue happened because something is wrong.",
"property": "person",
"properties": {
"firstName": "D0nn@",
"lastName": "Sm!th"
}
}
]
}PhoneResponse
objectDetails of a customer’s phone number.
The phone number of the contact.
Example:949-555-1323
The type of phone number (e.g., BILLING, LISTING, LOCAL).
Example:LOCAL
The phone number extension.
Example:303
Additional notes about the phone number.
Example:Primary contact number
{
"phoneNumber": "949-555-1323",
"type": "LOCAL",
"extension": "303",
"notes": "Primary contact number"
}StatusError
objectAn error occurred, and the request could not be completed.
The status of the response.
Example:error
A collection of error messages.
Example:The issue happened because something is wrong.
{
"status": "error",
"errors": [
"The issue happened because something is wrong."
]
}