Membership API

CustomerResponse

object

A customer record.

companyNamestring

The name of the company.

Example:Smart Logistics

emailstring

The email address of the contact. Must be a valid email address format.

Example:contact@aculogistics.com

phoneNumbersarray[object]

Details of a customer’s phone number.

Show Child Parameters
addressesarray[object]

Details of a customer’s address.

Show Child Parameters
customerAuthorityNumbersarray[object]

Details of a customer’s authority number.

Show Child Parameters
customerIdstring(uuid)

The Central Dispatch customer ID of the customer.

Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002

Example

CustomerSearchCollection

object

A collection of customers.

hrefstringrequired

The URL used to query the current collection of the resource.

Example:https://membership-api.centraldispatch.com/customers/?start=5&limit=1&name=acu

countinteger(int32)required

The total count of resources in the collection.

Example:23

itemsarray[object]required

A customer record.

Show Child Parameters
limitinteger(int32)required

The maximum number of items to be returned in the response.

Example:1

Example

CustomerSearchResponse

object

A customer record.

customerNamestring

The customer’s name.

Example:Acu Logistics

customerIdstring

The Central Dispatch customer ID of the customer.

Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002

emailstring

The email address of the customer.

Example:trans-port@notgmail.com

phoneNumbersarray[object]

Details of a customer’s phone number.

Show Child Parameters
addressesarray[object]

Details of a customer’s address.

Show Child Parameters
customerAuthorityNumbersarray[object]

Details of a customer’s authority number.

Show Child Parameters
Example

Error

object

Details of an error or issue.

codestring

The code used for the issue.

Example:resource.issue_type

descriptionstring

A detailed message.

Example:The issue happened because something is wrong.

propertystring

The property to which the issue is associated.

Example:person

propertiesobject

Additional properties related to the issue.

Example:{"firstName":"D0nn@","lastName":"Sm!th"}

Example

Errors

object

An error occurred, and the request could not be completed.

errorsarray[object]

Details of an error or issue.

Show Child Parameters
Example