Search
K
Stage - Membership API

Users

Get User

Get a user by ID.

get
https://membership-api.centraldispatch.com/users/id/{userId}

Path Parameters

userIdstring(uuid)required

The Central Dispatch user ID.

Example:d71b5750-e89b-12d3-a456-426614174000

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

UserResponse

A user record.

hrefstring

The fully qualified URL of the user record.

Example:https://membership-api.centraldispatch.com/users/id/d71b5750-e89b-12d3-a456-426614174000

userIdstring(uuid)

The ID of the user.

Example:d71b5750-e89b-12d3-a456-426614174000

firstNamestring | null

The preferred first name of the user.

Example:Mickey

lastNamestring

The legal last name of the user.

Example:Smith

legalFirstNamestring

The legal first name of the user.

Example:Michael

emailAddressstring | null

The email address of the user.

Example:mickey@snoogle.com

usernamestring

The username of the user.

Example:msmith

isActiveboolean

Indicates if the user is active.

Example:true

createdOnstring(date-time)

The creation date of the user (UTC/ISO 8601).

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

updatedOnstring(date-time)

The last updated date of the user (UTC/ISO 8601).

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

phoneNumberstring | null

The phone number of the user.

Example:949-555-1323

get/users/id/{userId}
 
application/json

Get My Users

Get all the users that are associated with the customer in the Bearer token.

get
https://membership-api.centraldispatch.com/users/mine

Query Parameters

limit(startingPoint,numberOfResults)string

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

  • startingPoint is 1-based integer, default 1.
  • numberOfResults is an integer, default 25, maximum 500.

Example:limit(1,10)

Headers

Acceptstringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

OK. Successful request.

UserCollection

A paginated collection of users.

hrefstring

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

Example:https://membership-api.centraldispatch.com/users/mine?limit(5,1)

itemsarray[object]

A user record.

Show Child Parameters
limitinteger(int32)

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

Example:1

nextstring | null

The URL to the next page of the collection, if available.

Example:https://membership-api.centraldispatch.com/users/mine?limit(6,1)

previousstring | null

The URL to the previous page of the collection, if available.

Example:https://membership-api.centraldispatch.com/users/mine?limit(4,1)

firststring | null

The URL to the first page of the collection.

Example:https://membership-api.centraldispatch.com/users/mine?limit(1,1)

countinteger(int32)

The total count of resources in the collection.

Example:23

get/users/mine
 
application/json

Carrier Matches

Create Carrier Match

Requests ranked carrier recommendations for a listing and persists the match, returning up to 10 carriers enriched with ratings, tenure, contact information, preferred-network status, and advisory warnings.

👥 Customer Type

  • Shipper

📝 Important Notes

  • Requires an authorized Premium shipper account.
  • The response will contain a Location header that contains the fully qualified URL of the newly created resource. The final segment of the URL will be the ID of the resource.
  • If no carriers are matched, the response is still 201 with an empty carriers collection — the match is persisted and has an ID.
post
https://membership-api.centraldispatch.com/carrier-matches/ref/listings/id/{listingId}

Path Parameters

listingIdstringrequired

The ID of the listing.

Example:42220470

Headers

X-CoxAuto-Caller-Channelstring

Marks the source of the carrier match request. The only supported value is API; the header may also be omitted.

Example:API

X-CoxAuto-AcceptFallbackstring

Opts into a degraded response when carrier rating data is temporarily unavailable. When true, overallRating and recentRating are omitted from the response and a Warning header is returned instead of a 503.

Example:true

Content-Typestringrequired

The major version of the API to make a request against. This is a custom MIME type that contains vnd.coxauto.v[#]+. For example, to request a resource from version 1.x.x of an API, the Content-Type header should be set to application/vnd.coxauto.v1+json.

Example:application/vnd.coxauto.v1+json

Response

application/json

Created. Successful request.

CarrierMatchResourceResponse

The created carrier match, with carriers ranked and enriched.

hrefstring | null

Canonical self URL for the created carrier match.

Example:https://membership-api.centraldispatch.com/carrier-matches/id/c1a7e9d0-4b3f-4a1e-9c6d-8f2b5a7e0c14

carriersarray | null[object]

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

Show Child Parameters
post/carrier-matches/ref/listings/id/{listingId}
 
application/json