CarrierCloud (v1) - Universal Transportation API

Utilities

Geocoding and document synchronisation helpers.

Reverse Geocode

GET

https://carriercloud.ai

/v1/utility/geocode/reverse

Get an address from a specified Latitude/Longitude. Query parameters are passed to the geocoder as given; the best match is returned as a single ZoneActor.

Reverse Geocode › query Parameters

point.lat

number · required

Latitude in decimal degrees.

point.lon

number · required

Longitude in decimal degrees.

Reverse Geocode › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Reverse Geocode › Responses

The best match as a single ZoneActor.

A geocoded place. Returned as a single object (not an array).

ZoneId

string

Always empty.

Description

string

Display label of the match.

Address1

string

House number and street, when present.

Address2

string

Always empty.

City

string

State

string

ZipCode

string

Country

string

Latitude

number

Longitude

number

IsHub

boolean

Always false.

IsInterchange

boolean

Always false.

IsTerminal

boolean

Always false.

Geocode Search

GET

https://carriercloud.ai

/v1/utility/geocode/search

Geocode a location to obtain a Zone Actor object with latitude/longitude. Query parameters are passed to the geocoder as given; the best match is returned as a single ZoneActor.

Geocode Search › query Parameters

text

string · required

Free-text place or address to geocode.

Geocode Search › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Geocode Search › Responses

The best match as a single ZoneActor.

A geocoded place. Returned as a single object (not an array).

ZoneId

string

Always empty.

Description

string

Display label of the match.

Address1

string

House number and street, when present.

Address2

string

Always empty.

City

string

State

string

ZipCode

string

Country

string

Latitude

number

Longitude

number

IsHub

boolean

Always false.

IsInterchange

boolean

Always false.

IsTerminal

boolean

Always false.

Geocode Structured Search

GET

https://carriercloud.ai

/v1/utility/geocode/structured

Geocode a location with structured search parameters (address, city, state, zip, etc.) to obtain a Zone Actor object with latitude/longitude. Query parameters are passed to the geocoder as given; the best match is returned as a single ZoneActor.

Geocode Structured Search › query Parameters

address

string

House number and street.

locality

string

City or town.

region

string

State or province.

postalcode

string

Postal code.

country

string

Country name or code.

Geocode Structured Search › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Geocode Structured Search › Responses

The best match as a single ZoneActor.

A geocoded place. Returned as a single object (not an array).

ZoneId

string

Always empty.

Description

string

Display label of the match.

Address1

string

House number and street, when present.

Address2

string

Always empty.

City

string

State

string

ZipCode

string

Country

string

Latitude

number

Longitude

number

IsHub

boolean

Always false.

IsInterchange

boolean

Always false.

IsTerminal

boolean

Always false.

Utilities - Sync External Documents

GET

https://carriercloud.ai

/v1/partner/{partnercode}/utility/{id}/syncexternaldocuments

Triggers retrieval of additional documents from configured external integrations on the partner company. Sync is asynchronous; a 202 response means the request was accepted, not that documents are ready. Poll the object after a short wait to check for new attachments.

Utilities - Sync External Documents › path Parameters

partnercode

string · required

Partner code of the company whose data this request reads or writes (its VIA company code, for example MIST). Your API key identifies your own company; the request succeeds only when the two companies have an approved, API-enabled partnership in the Partner Network. Use Get Active Partners to list the codes available to you.

id

string · required

Identifier of the object addressed by this route, as returned by the matching list or lookup operation.

Utilities - Sync External Documents › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Utilities - Sync External Documents › Responses

Synchronisation started; documents arrive on the card asynchronously.

message

string

Dropdown Options Webhooks