Cloud Network Endpoints for Carrier Access
Offers - Get Active Offers
path Parameters
partnercodestring · requiredPartner code identifier
query Parameters
partneridstring · requiredId of partner
starttimestring · requiredStart Time in UTC
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
Loads - Update Position
Loads - Get Load Detail
Get details of a specific load segment.
path Parameters
partnercodestring · requiredPartner code identifier
loadidstring · requiredLoad identifier
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Loads - Arrive Stop
Arrive a specified stop on a Load.
path Parameters
partnercodestring · requiredPartner code identifier
loadidstring · requiredUnique guid of the load
stopidstring · requiredUnique guid of the stop to arrive
query Parameters
arrivalTimestring · date-time · requiredDate and time that the stop was arrived in local time (format YYYY-MM-ddTHH:mm:ss)
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
Loads - Depart Stop
Depart a specified stop on a Load.
path Parameters
partnercodestring · requiredPartner code identifier
loadidstring · requiredUnique guid of the load
stopidstring · requiredUnique guid of the stop to depart
query Parameters
departureTimestring · date-time · requiredDate and time that the stop was departed in local time (format YYYY-MM-ddTHH:mm:ss)
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Responses
Success
Loads - Add Attachment
Add an attachment to a specified load.
path Parameters
partnercodestring · requiredPartner code identifier
loadidstring · requiredUnique guid of the load
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.
Request Body
docTypestring · requiredDocument type for the attachment.
mimeTypestring · minLength: 1 · maxLength: 10000 · requiredMime type for the file.
fileUrlstring · minLength: 1 · maxLength: 10000 · requiredURL to the file attachment. Should not be used with data.
datastring · minLength: 1 · maxLength: 10000 · requiredBase-64 encoded copy of the file. Should not be used with fileUrl.
Responses
Success
Loads - Add Note
Loads - Get Loads
Get a list of load segments for a specific partner.
path Parameters
partnercodestring · requiredPartner code identifier
query Parameters
pageinteger · int32Page number to return results
refNumberstring · minLength: 1 · maxLength: 100Filter loads by exact reference number match. The reference number must match exactly (case-sensitive).
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate with the API using your API key. Value is of the formatBearer YOUR_KEY_HERE.