C.H. Robinson Shipments API is one of 9 APIs that C.H. Robinson publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Shipments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 6 paths,
and defines 63 schemas.
It is described by OpenAPI 3.2.0, at version 2.0.0.
Requests are made against 2 base URLs: https://sandbox-api.navisphere.com, https://api.navisphere.com.
The identity and technical contract details declared by the specification.
specializedEquipmentCodeNAEnum
string
Code to indicate specialized equipment for NA. For a detailed description of all enumerated codes please find them here .
availableShipmentsModeEnum
array
C.H. Robinson defined code for mode. For a detailed description of all enumerated codes please find them here .
supplementalInformation
object
Allows updating entity to provide additional details pertaining to the milestone.
2 properties
milestoneStoptypeEnum
string
Identifies the type of stop the milestone is referencing. If location is for a milestone that isn't tied to a stop then this field should be set to null. - 'P'…
error403
object
3 properties
3 required
rateConfirmation
object
Indicates the individual who is confirming the rate.
2 properties
2 required
railDetail
object
Identifies rail information.
2 properties
offerAcknowledgment
object
1 property
availableShipmentTemperature
object
Temperature control
4 properties
countryCodeEnum
string
Indicate the country of the location. For a detailed description of all enumerated codes please find them here .
lateCodeEnum
string
C.H. Robinson defined code for a carrier being late to a stop or reason to schedule new appiontment. Here is a list of the most commonly used late reason codes…
vehicleDetail
object
Identifies vehicle information.
6 properties
stateProvinceCodeEnum
string
Indicate the state or province of the location. For a detailed description of all enumerated codes please find them here .
temperatureUomEnum
string
Unit of measure for temperature parameters.
offerResponse
object
Object with response to carrier offer.
8 properties
rateCodeEnum
string
C.H. Robinson defined code for rating code. Here is a list of the most commonly used rate codes: 400 - Line Haul, 405 - Fuel Surchage, 260 - Deliver Surchage,…
shipmentContainerTypeEnum
string
Type of shipping container. For a detailed description of all enumerated codes please find them here .
error401
object
4 properties
3 required
error400
object
4 properties
weightUomEnum
string
Unit of measure for weight parameters.
unitOfMeasure
string
Indicates Standard or Metric.
availableShipmentLocation
object
Location information.
11 properties
dateTime
object
Object containing the different types of dates that can apply to a milestone. At least one needs to be present.
3 properties
shipmentIdentifier
object
A list of different common reference numbers that can be used to identify the shipment the milestone is intended for. At least one ship identifier needs to be…
5 properties
error422
object
3 properties
3 required
availableShipmentsResponseV2
object
2 properties
milestoneItem
object
Item totals associated to milestone.
5 properties
airMilestoneEventCodeEnum
string
Code that indicates the type of milestone being sent for a shipment being moved by plane. For a detailed description of all enumerated codes please find them h…
oceanMilestoneEventCodeEnum
string
Code that indicates the type of milestone being sent for a shipment being moved by boat. For a detailed description of all enumerated codes please find them he…
availableShipmentEquipment
object
3 properties
milestone
object
Shipment update
8 properties
4 required
shipmentDetail
object
7 properties
coordinate
object
2 properties
2 required
availableShipmentsRateEnum
string
C.H. Robinson defined rate code. For a detailed description of all enumerated codes please find them here .
availableShipmentsSearchV2
object
22 properties
1 required
availableLoadCost
object
Object containing load cost.
16 properties
error404
object
3 properties
3 required
vesselDetail
object
Identifies vessel information.
4 properties
packageCodeEnum
string
C.H. Robinson defined code for packaging type/code. Here is a list of the most commonly used packagingCodes: BAL - Bale, BAG - Bags, BIN - Bin, BOX - Boxes, CT…
binCost
object
Book it now cost object that is informed by the avaialble shipments response message (availableLoadCost).
6 properties
3 required
availableShipmentV2
array
Contains the information of available loads.
referenceNumber
object
2 properties
2 required
railMilestoneEventCodeEnum
string
Code that indicates the type of milestone being sent for a shipment being moved by train. For a detailed description of all enumerated codes please find them h…
radiusSearch
object
Sets the coordinates and radial distance.
2 properties
2 required
flightDetail
object
Identifies flight information.
3 properties
vehicleContact
object
Contact information.
6 properties
specializedEquipmentCodeEUEnum
string
Code to indicate specialized equipment for EU. For a detailed description of all enumerated codes please find them here .
loadOffer
object
Object to use for submitting load offer.
4 properties
2 required
milestoneCarrier
object
Carrier information associated to the milestone.
13 properties
1 required
availableShipmentStop
object
10 properties
weight
object
Total pounds and kilograms.
2 properties
availableShipmentContact
object
Contact information.
1 property
milestoneLocation
object
Location information associated to the milestone.
8 properties
1 required
distance
object
Total miles and kilometers of the load.
2 properties
emptyLocationV2
object
Indicates the location of the carrier where they are empty and moving towards the pick up location.
4 properties
3 required
loadingTypeEnum
string
Describes how trailer will need to be loaded. CRANE - Top/crane REAR - Rear SIDE - Side REAR/SIDE - Rear/side TOP/SIDE - Top/side DOCK - Dock STRING - String S…
currencyCodeEnum
string
Code to indicate the currency being used. The most common currently in use with C.H. Robinson: USD - US Dollar CAD - Canadian Dollar MXN - Mexican Peso EUR - E…
shipmentDetailEvent
object
22 properties
dimension
object
Dimensions.
2 properties
milestoneLocationAddress
object
Contains address information; variant that does not require stateProvinceCode.
8 properties
4 required
loadBookV2
object
JSON payload to book a carrier to an available shipment.
6 properties
6 required
freightTermEnum
string
Code to indicate the freight term type: CL - Collect PP - Prepaid TP - Third Party PC - Prepaid and Add CC - The Bill To is paying via a Credit Card
roadMilestoneEventCodeEnum
string
Code that indicates the type of milestone being sent for a shipment being moved by truck. For a detailed description of all enumerated codes please find them h…
The full machine-readable OpenAPI contract behind this narrative.
Other APIs C.H. Robinson publishes across the network.
