CarrierRating
objectA carrier’s rating summary for a given period.
Average rating across the period.
Example:4.7
Number of ratings the average is computed from.
Example:42
Rating window in days; null means lifetime, 90 means the recent (90-day) window.
Example:90
CarrierWarning
objectAn advisory warning about a matched carrier.
Namespaced warning code (carrier.fmcsa.* or carrier.audit.*).
Example:carrier.fmcsa.authority_revoked
Human-readable warning description.
Example:FMCSA operating authority has been revoked.
CustomerResponse
objectA customer record.
The name of the company.
Example:Smart Logistics
The year the company was established. This value will be returned only if customer-management scope is used.
Example:1998
The email address of the contact. Must be a valid email address format.
Example:contact@aculogistics.com
The date the company joined the platform, in UTC/ISO 8601 format. This value will be returned only if customer-management scope is used.
Example:2024-10-31T00:00:00Z
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
The Central Dispatch customer ID of the customer.
Example:d5c62b14-cbd1-11ee-9a0e-0242ac110002
Indicates if the company has temporarily lost access to their account due to security reasons.
Example:true
CustomerSearchCollection
objectA collection of customers.
The URL used to query the current collection of the resource.
Example:https://membership-api.centraldispatch.com/customers/?start=5&limit=1&name=acu
The total count of resources in the collection.
Example:23
A customer record.
Show Child Parameters
The maximum number of items to be returned in the response.
Example:1
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
The year the company was established.
Example:1998
The date the company joined the platform, in UTC/ISO 8601 format.
Example:2024-10-31T00:00:00Z
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.