Search
K
Stage - Membership API

CarrierMatchResponse

object

A carrier matched for a listing, enriched with rating, tenure, contact, and network information.

hrefstring

Canonical self URL for the carrier’s customer resource.

Example:https://membership-api.centraldispatch.com/customers/id/0ca91a43-fbee-4c05-9a6c-aa5c63888f5c

customerIdstring(uuid)

The Central Dispatch customer ID of the customer.

Example:0ca91a43-fbee-4c05-9a6c-aa5c63888f5c

customerNamestring

The carrier name.

Example:Acu Logistics

addressobject

Details of a customer’s address.

Show Child Parameters
phonestring

The carrier’s business phone number.

Example:800-555-0142

establishedInstring

The year the company was established.

Example:1998

joinedOnstring(date-time)

The date the company joined the platform, in UTC/ISO 8601 format.

Example:2024-09-10T00:00:00Z

usDotAuthorizedStatestring

The state under which the carrier’s USDOT number is authorized to operate, if on file; otherwise null.

Example:OH

overallRatingobject

A carrier’s rating summary for a given period.

Show Child Parameters
recentRatingobject

A carrier’s rating summary for a given period.

Show Child Parameters
isPreferredboolean

Whether this carrier is in the calling shipper’s preferred-carrier network.

Example:true

warningsarray[object]

An advisory warning about a matched carrier.

Show Child Parameters
Example

CarrierRating

object

A carrier’s rating summary for a given period.

averageRatingsnumber(double)

Average rating across the period.

Example:4.7

totalRatingsinteger(int32)

Number of ratings the average is computed from.

Example:42

periodDaysinteger(int32)

Rating window in days; null means lifetime, 90 means the recent (90-day) window.

Example:90

Example

CarrierWarning

object

An advisory warning about a matched carrier.

codestring

Namespaced warning code (carrier.fmcsa.* or carrier.audit.*).

Example:carrier.fmcsa.authority_revoked

messagestring

Human-readable warning description.

Example:FMCSA operating authority has been revoked.

Example

CustomerResponse

object

A customer record.

companyNamestring

The name of the company.

Example:Smart Logistics

establishedInstring

The year the company was established. This value will be returned only if customer-management scope is used.

Example:1998

emailstring

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

Example:contact@aculogistics.com

joinedOnstring(date-time)

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

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

accessPausedboolean

Indicates if the company has temporarily lost access to their account due to security reasons.

Example:true

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