C.H. Robinson Navisphere Shipper API
The Navisphere Shipper API integrates C.H. Robinson's global transportation management system into a shipper's TMS or ERP. Capabilities include real-time rate quoting, load tendering, shipment tracking and visibility, document exchange, freight audit and payment, and business intelligence access across multi-modal transportation (truckload, LTL, intermodal, ocean, air, customs).
C.H. Robinson Navisphere Shipper API is one of 2 APIs that C.H. Robinson publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Navisphere, Quoting, Shipments, Shippers, and Tracking. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and an API reference.
This API exposes 35 operations across 32 paths, organized into 9 resource areas, and defines 321 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.
Requests are made against 2 base URLs: https://sandbox-api.navisphere.com, https://api.navisphere.com.
35 operations
32 paths
321 schemas
3 DELETE11 GET19 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
C.H. Robinson Navisphere Shipper API declares
2 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (jwt) (sandbox).
It accepts HTTP bearer tokens (jwt) (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 35
Across 32 paths, the API surfaces 35 operations — 3 DELETE, 11 GET, 19 POST, 2 PUT. They span 9 resource areas: Authentication, Rating, Orders and Booking, Events, Financials, Documents, Shipments, Visibility, Labels. Each is listed below with its method, path, parameters, and response codes.
Authentication 1
C.H. Robinson uses OAuth v2.0 to secure connections to its APIs. oAuth v2 works by delegating user authentication to the service that hosts the user account and authorizing third-…
POST
/v1/oauth/token
Allows partner to retrieve their own auth token.
Rating 2
C.H. Robinson's rating product allows our customers to retrieve contractual or transactional quotes. Customers can generate quotes with nothing more than weights and zip codes! Ho…
POST
/v1/quotes
Allows partner to generate quote from posted shipment information.
POST
/v1/quotes/freight-class-estimate
Allows partner to retrieve the estimated classification, based solely on density, for further use in the actual rate requests.
Orders and Booking 7
C.H. Robinson’s Orders and Bookings products are the starting point for all freight execution in Navisphere®. They provide a unified gateway for customers to submit and manage shi…
POST
/v1/orders
Allows partner to create an order in C.H. Robinson's Navisphere® Order Management system.
PUT
/v1/orders
Allows partner to update an existing order in C.H. Robinson's Navisphere® Order Management system.
POST
/v1/orders/quotes
Allows partner to create an order in C.H. Robinson's Navisphere® Order Management system using a Quote ID. See [Rating](https://developer.chrobinson.com/api-referencetag/Rating) for more information…
DELETE
/v1/orders/{orderNumber}
Allows partner to delete an existing order in C.H. Robinson's Navisphere® Order Management system.
POST
/v1/gfbookings
Allows partner to send a Global Forwarding Booking request to CH Robinson's Navisphere system
PUT
/v1/gfbookings
Allows partner to send a Global Forwarding Booking request to CH Robinson's Navisphere system
DELETE
/v1/gfbookings?{customerReferenceNumber}&{customerCode}
Allows partner to send a Global Forwarding Booking request to CH Robinson's Navisphere system
Events 2
C.H. Robinson's Events product gives complete, near real-time order and shipment information, including all transportation updates. Integrating with C.H. Robinson's Events API giv…
POST
/REPLACE_ME_WITH_YOUR_CALLBACK_URL
C.H. Robinson provides a callback solution for our customers. In a Callback integration type (also known as a Webhook or an HTTP Push API), users set up their own API and ask C.H. Robinson to call it…
GET
/v2/events
For customers that cannot integrate via callbacks, C.H. Robinson also provides an Event Retrieval solution. This retrieval product provides the following features: - Updates from Navisphere are made…
Financials 3
C.H. Robinson's financial product provides customers and carriers insight into their invoicing. Currently, customers can retrieve their invoice information from the Financials pro…
GET
/v1/financials/payments
Allows partners access to the payment processing status of an invoice.
GET
/v1/financials/invoiceSummaries
Allows partner to retrieve list summary of their invoices.
GET
/v1/financials/invoiceSummaries/{invoiceNumber}
Allows partner to retrieve specifics of an invoice.
Documents 7
C.H. Robinson's Documents product allows our partners to generate, post, and retrieve documents. C.H. Robinson currently offers customers the ability to generate blank BOLs and re…
GET
/v1/documents/generateBols
Allows partner to generate the blank order-level BOL for the load. A load can have many orders, and this BOL would reflect the individual order details. This route is intended to be called once the c…
GET
/v1/documents/generateLoadBols
Allows partner to generate the blank load-level BOL for the shipment. This BOL would reflect load details. A load can have many orders. The load-level BOL may also contain API-retrieved end-carrier p…
GET
/v1/documents/invoices/{invoiceNumber}
Allows partner to retrieve PDF document of an invoice.
GET
/v1/documents/retrieveDocumentIds
Allows partner to retrieve list of document IDs.
GET
/v1/documents/{documentId}
Allows partner to retrieve BOLs, PODs, and Lumper receipts.
POST
/events/LoadDocuments/here
This is the endpoint where load documents can be pushed.
POST
/v1/documents/{loadNumber}
Both base64 and binary can be accepted by making a selection in the dropdown next to "Request Body Schema". Binary is form-data, base64 is application/json.
Shipments 6
C.H. Robinson's Shipments product allows our partner base to access C.H. Robinson's available shipments, send offers on those shipments, and book those shipments. Additionally, ou…
POST
/v2/shipments/available/searches
Allows partner to retrieve list summary of shipments available for transportation.
POST
/v1/shipments/{loadNumber}/offers
Allows carrier to submit an offer on a load found through the Available Shipment search if load has associated availableLoadCost(s).
POST
/offerResponse/callback/here
This is the endpoint on your server where we will send the offer response for loads you have made offers on.
POST
/v1/shipments/books
Allows carrier to book a load found through the Available Shipment search if load has associated availableLoadCost(s).
POST
/shipmentDetails/callback/here
This is the endpoint on your server where we will send the shipment details for loads you have booked.
POST
/v1/shipments/milestones
Allows carrier, vendor, or other updating entity to update C.H. Robinson on any shipment.
Visibility 6
Navisphere® Vision and Visibility tool is a global visibility technology that allows select customers to view and proactively manage their supply chain movements from a single pla…
POST
/v2/visibility/shipments
Post a shipment create into Navisphere® Vision and/or Navisphere® Analytics.
GET
/v2/visibility/shipments
Allows partner to retrieve shipments.
DELETE
/v2/visibility/shipments/{shipmentNumber}
Allows partner to delete an existing shipment in Navisphere® Vision and/or Navisphere® Analytics.
POST
/v2/visibility/invoices
Post a shipment invoice into Navisphere® Vision and/or Navisphere® Analytics.
POST
/v2/visibility/orders
Post an order into Navisphere® Vision and/or Navisphere® Analytics.
GET
/v2/visibility/milestones
Allows partner to retrieve events during the life cycle of the order and shipment.
Labels 1
A service for generating small parcel shipping labels. An associated C.H. Robinson order is also created to track the package updates through Navisphere®. Note: Configuration of y…
POST
/v1/labels
Generate label
Schemas 321
The contract defines 321 schemas that model the data the API accepts and returns. The most detailed are ratingItem (59 properties), orderItem (37 properties), purchaseOrderItem (33 properties), commodity (28 properties). Each schema is shown below with its type and property counts.
freightClassEstimate
object
12 properties
8 required
freightClassEstimateResponse
object
1 property
ratingItem
object
59 properties
4 required
ratingLocation
object
Identifies all the relevant location information
22 properties
2 required
cargoLiability
object
Informs of carrier liability coverages.
4 properties
equipment
object
2 properties
transportMode
object
Define information for transport criteria
2 properties
1 required
ratingPost
object
12 properties
6 required
rates
array
An array of all rates associated to a quote
quoteSummaries
object
1 property
tokenRequest
object
4 properties
4 required
tokenSuccessResponse
object
4 properties
order
object
14 properties
3 required
orderCustomer
object
Object containing customer information.
3 properties
1 required
orderBillTo
object
Object containing bill to information.
6 properties
2 required
contact
object
Object containing contact information.
4 properties
4 required
contactMethod
object
Object defining contact method.
2 properties
2 required
charge
object
Object relating to the charges for the order.
4 properties
2 required
orderService
object
Object containing service information.
21 properties
2 required
orderLocation
object
Indicates the locations assigned to this service. All service objects only have two location objects. If you have multiple stops, they need to broken into sing…
22 properties
1 required
orderAddress
object
Object that contains address specific information.
11 properties
5 required
blindLocation
object
A "blind shipment" is a shipment, regardless of mode, in which the party paying the freight charges requests that either the actual "shipper" or actual "consig…
4 properties
specialRequirementOrder
object
11 properties
orderItem
object
37 properties
2 required
relationships
object
Object to specify master and inner pack qantities.
3 properties
orderPackage
object
14 properties
1 required
itemEquipment
object
Additional information as to the specific equipment needs.
10 properties
hazardousProperties
object
Object containing hazardous material information.
22 properties
1 required
ordersEventsHazardousProperties
object
Object containing hazardous material information.
22 properties
1 required
additionalLocation
object
List of additional Locations for Ocean/Air transport Mode.
14 properties
1 required
shippingContainers
object
12 properties
1 required
shippingContainerItems
object
2 properties
2 required
transportSpecs
object
8 properties
1 required
labelReferenceData1
string
First piece of reference data to be used on the package label. This is used as the customer/shipper reference number on the label for FedEx, UPS, DHL, and TNT.
labelReferenceData2
string
Second piece of reference data to be used on the package label. This is used as the PO Number for FedEx or Reference Number 2 for UPS (not used for DHL or TNT).
labelReferenceData3
string
Third piece of reference data to be used on the package label. This is used as the Invoice Number for FedEx (not used for UPS, DHL, or TNT).
dutyPayerAccountNumber
string
Account number of the party paying the duty charges; Required for a dutyPayerType of ThirdParty or if C.H. Robinson does not have the billing account to use on…
exportReasonCode
string
A value required for DHL international shipments indicating why the shipment is being exported.
AESTransactionNumber
string
AES ITN may be required if shipping internationally from the US and the value is over 2,500.00 USD; must be exactly 14 digits and prefixed with X.
bookingNumber
string
The booking number for FedEx heavy air shipments.
isResidential
boolean
A flag indicating whether or not this is a residential location. Used ONLY FOR PARCEL Shipments. For FedEx, FedExGroundHomeDelivery or FedexHomeDelivery must b…
collectOnDelivered
object
Information relating to payment.
6 properties
5 required
quoteBillTo
object
Object containing bill to information.
3 properties
quoteLocation
object
Object containing quote location information.
13 properties
quoteService
object
Object containing quote service information.
4 properties
quotes
array
quote
object
Object containing information for quote order.
9 properties
1 required
orderResponse
object
Object containg the order response.
1 property
quoteOrderResponse
object
Object containing the quote order response.
3 properties
orderNumber
object
1 property
eventResponseV1
object
Object containing the search event response.
9 properties
eventResponses
object
2 properties
eventResponse
object
Contains the response JSON from GET call.
6 properties
globalForwardingDateNullableChangableValue
object
3 properties
globalForwardingDateTimeOffsetNullableChangableValue
object
3 properties
globalForwardingParty
object
1 property
globalForwardingVolume
object
2 properties
globalForwardingWeight
object
2 properties
globalForwardingShipmentEvent
object
Represents a Global Forwarding shipment event.
23 properties
globalForwardingEventTypeEnum
string
The "type" of event for the shipment. If you specify this value in your API request for events, CHR will perform server-side filtering and you will only receiv…
globalForwardingUnknownEventTypeValue
string
This represents a new event type that has been implemented, but it not yet ready for public consumption.
globalForwardingShipmentTypeEnum
string
globalForwardingUnknownShipmentTypeValue
string
This represents a new shipment type that has been implemented, but it not yet ready for public consumption.
globalForwardingChrServiceEnum
string
globalForwardingUnknownChrServiceValue
string
This represents a new service level that has been implemented, but it not yet ready for public consumption.
globalForwardingServiceLevelEnum
string
globalForwardingUnknownServiceLevelValue
string
This represents a new service level that has been implemented, but it not yet ready for public consumption.
globalForwardingModeEnum
string
globalForwardingUnknownModeValue
string
This represents a new mode that has been implemented, but it not yet ready for public consumption.
globalForwardingShipmentStatusEnum
string
globalForwardingUnknownShipmentStatusValue
string
This represents a new shipment status that has been implemented, but it not yet ready for public consumption.
globalForwardingIncoTermsEnum
string
globalForwardingUnknownIncoTermsValue
string
This represents a new INCO terms value that has been implemented, but it not yet ready for public consumption.
globalForwardingFreightTermsEnum
string
Prepaid: The shipper pays for the freight charges. Collect: The customer/consignee pays for the freight charges.
globalForwardingUnknownFreightTermsValue
string
This represents a new freight terms value that has been implemented, but it not yet ready for public consumption.
globalForwardingAirShipment
object
When this shipment is an air shipment, this object will contain air shipment details.
19 properties
globalForwardingAirMainlineCarrier
object
The mainline carrier that transports the shipment over air.
4 properties
globalForwardingFlight
object
A flight that is used to transport the shipment.
4 properties
globalForwardingFromAirport
globalForwardingToAirport
globalForwardingOceanShipment
object
When this shipment is an ocean shipment, this object will contain ocean shipment details.
8 properties
globalForwardingOceanMainlineCarrier
object
The mainline carrier that transports the shipment over the ocean.
6 properties
globalForwardingContainer
object
21 properties
globalForwardingContainerTypeEnum
string
globalForwardingUnknownContainerTypeValue
string
This represents a new container type that has been implemented, but it not yet ready for public consumption.
globalForwardingQuantity
object
2 properties
globalForwardingUnitOfMeasureEnum
string
globalForwardingUnknownUnitOfMeasureValue
string
This represents a new unit of measure that has been implemented, but it not yet ready for public consumption.
globalForwardingStop
globalForwardingStopTypeEnum
string
Indicates the type of the stop.
globalForwardingUnknownStopTypeValue
string
This represents a new stop type that has been implemented, but it not yet ready for public consumption.
globalForwardingLocation
object
4 properties
globalForwardingAddress
object
6 properties
globalForwardingCustomsEntry
object
The customs entry for the shipment.
4 properties
globalForwardingCustomsEntryStatusEnum
string
globalForwardingUnknownCustomsEntryStatusValue
string
This represents a new customs entry status that has been implemented, but it not yet ready for public consumption.
globalForwardingUsCustomsEntry
object
The US customs entry for the shipment.
1 property
globalForwardingPgaStatus
object
The status of the Partner Government Agency (PGA) release for the cargo.
4 properties
globalForwardingPgaStatusEnum
string
globalForwardingUnknownPgaStatusValue
string
This represents a new PGA status value that has been implemented, but it not yet ready for public consumption.
globalForwardingCustoms
object
This represents customs entries.
2 properties
globalForwardingAuCustoms
object
This represents the customs entries for Australia.
1 property
globalForwardingNzCustoms
object
This represents the customs entries for New Zealand.
1 property
globalForwardingNzCustomsN10
object
This represents the N10 document for a New Zealand customs entry.
3 properties
globalForwardingNzCustomsStatusEnum
string
This represents a New Zealand customs statuses that have been implemented and available for use.
globalForwardingUnknownNzCustomsStatusValue
string
This represents a new New Zealand customs status that has been implemented, but it not yet ready for public consumption.
globalForwardingAuCustomsN10
object
This represents the N10 document for Australia customs entry.
3 properties
globalForwardingAuCustomsStatusEnum
string
This represents a Australia customs statuses that have been implemented and available for use.
globalForwardingUnknownAuCustomsStatusValue
string
This represents a new Australia customs status that has been implemented, but it not yet ready for public consumption.
orderEvent
object
5 properties
orderEventService
object
8 properties
orderEventLocation
object
Location information specific to the service.
7 properties
orderEventItem
object
Items tied to the service.
27 properties
loadEvent
object
17 properties
stopEvent
object
12 properties
inTransitEvent
object
11 properties
trackingNumberEvent
object
5 properties
appointmentEvent
object
7 properties
packageStopEvent
object
6 properties
packageInTransitEvent
object
7 properties
bookedBillTo
object
The bill to(s) on the shipment.
9 properties
eventCharge
object
Object relating to the charges for the order.
5 properties
2 required
eventAddress
object
Contains address information
8 properties
2 required
milestoneLocationAddress
object
Contains address information; variant that does not require stateProvinceCode.
8 properties
4 required
loadDetails
object
Contains load specific information and reference numbers.
2 properties
inTransitAddress
object
Contains address information
5 properties
packageInTransitAddress
object
Contains address information
6 properties
inTransitNextStop
object
Contains stop information
5 properties
bookedCustomer
object
The customer(s) on the shipment.
5 properties
contactPosition
object
Object containing contact information.
4 properties
4 required
proposedCarrier
object
Carrier CHR is proposing to use for this shipment (Only available for Small Parcel Mode).
1 property
carrier
object
Object containing carrier information.
14 properties
loadStopInformation
object
Stop information specific to the load.
4 properties
stopEventLocation
object
Location information specific to the event.
13 properties
eventLocation
object
Location information specific to the event.
12 properties
eventItem
object
21 properties
orderDetail
object
Contains order number and order tracking information.
7 properties
orderEventOrderDetail
object
Contains order number and order tracking information.
5 properties
loadEventOrderDetail
object
Contains order number and order tracking information.
8 properties
bookedLocation
eventPackage
object
Package object.
5 properties
eventLoadPackage
object
Package object.
3 properties
bookedItem
loadDocumentCallback
object
Object containing the search event response.
6 properties
invoiceShipments
array
Contains high level shipment charge information.
invoiceRates
array
Defines all charges properties
invoiceShipmentsWithRates
array
Contains detailed shipment charge information.
invoiceSummaries
array
All properties returned on the invoice get call.
invoiceSummary
object
All properties returned on the invoice get call.
11 properties
payments
array
All properties returned on the payment's get call.
documentIdResults
array
Document ID results.
shipmentDetail
object
7 properties
shipmentDetailEvent
object
22 properties
shipmentsSearch
object
18 properties
3 required
availableShipmentCost
object
6 properties
availableShipmentLocation
object
Location information.
11 properties
availableShipmentStop
object
10 properties
availableShipmentEquipment
object
3 properties
availableShipmentContact
object
Contact information.
1 property
availableShipmentsSearchV2
object
22 properties
1 required
availableShipmentsResponseV2
object
2 properties
availableShipmentV2
array
Contains the information of available loads.
availableLoadCost
object
Object containing load cost.
16 properties
availableShipmentTemperature
object
Temperature control
4 properties
saltRate
bookSaltRate
object
3 properties
3 required
coordinate
object
2 properties
2 required
radiusSearch
object
Sets the coordinates and radial distance.
2 properties
2 required
unitOfMeasure
string
Indicates Standard or Metric.
distance
object
Total miles and kilometers of the load.
2 properties
weight
object
Total pounds and kilograms.
2 properties
dimension
object
Dimensions.
2 properties
milestone
object
Shipment update
8 properties
4 required
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
milestoneLocation
object
Location information associated to the milestone.
8 properties
1 required
supplementalInformation
object
Allows updating entity to provide additional details pertaining to the milestone.
2 properties
milestoneCarrier
object
Carrier information associated to the milestone.
13 properties
1 required
vehicleDetail
object
Identifies vehicle information.
6 properties
flightDetail
object
Identifies flight information.
3 properties
railDetail
object
Identifies rail information.
2 properties
vesselDetail
object
Identifies vessel information.
4 properties
vehicleContact
object
Contact information.
6 properties
milestoneItem
object
Item totals associated to milestone.
5 properties
emptyLocation
object
Indicates the location of the carrier where they are empty and moving towards the pick up location.
4 properties
3 required
rateConfirmation
object
Indicates the individual who is confirming the rate.
2 properties
2 required
driver
object
Object to provide driver information.
3 properties
loadBook
object
JSON payload to book a carrier to an available shipment.
12 properties
loadBookV2
object
JSON payload to book a carrier to an available shipment.
6 properties
6 required
emptyLocationV2
object
Indicates the location of the carrier where they are empty and moving towards the pick up location.
4 properties
3 required
binCost
object
Book it now cost object that is informed by the avaialble shipments response message (availableLoadCost).
6 properties
3 required
loadOffer
object
Object to use for submitting load offer.
4 properties
2 required
offerAcknowledgment
object
1 property
offerResponse
object
Object with response to carrier offer.
8 properties
purchaseOrder
object
8 properties
3 required
purchaseOrderItem
object
33 properties
2 required
purchaseOrderLocation
object
6 properties
purchaseOrderAddress
object
6 properties
5 required
party
object
4 properties
1 required
relatedParty
object
3 properties
1 required
purchaseOrderContactMethod
object
2 properties
customerContact
object
2 properties
1 required
supplier
object
4 properties
shipments
object
27 properties
6 required
visibilityOrder
object
Order Created by the Shipper
21 properties
3 required
visibilityLocation
object
All locations associated with the order.
16 properties
6 required
stop
object
4 properties
3 required
handlingUnit
object
Object containing commodity (or group of commodities)
19 properties
2 required
commodity
object
28 properties
2 required
invoice
object
12 properties
6 required
visibilityCharge
object
5 properties
3 required
containerInformation
object
5 properties
1 required
label
object
Object containing information for the label
25 properties
7 required
customer
object
The customer on the order.
2 properties
1 required
billTo
object
The bill to on the order.
3 properties
2 required
payer
object
The party responsible for paying the shipping charges.
11 properties
1 required
location
object
The locations on the label.
9 properties
4 required
address
object
Object that contains address specific information.
8 properties
3 required
package
object
Describes a package
21 properties
7 required
content
object
10 properties
7 required
hazardousPackageInformation
object
Additional information about any hazardous materials or dangerous goods in the package.
7 properties
1 required
hazardousMaterial
object
23 properties
1 required
signatory
object
3 properties
internationalShipping
object
Elements specific to international shipping scenarios.
16 properties
additionalLocationLabels
object
List of additional locations to provide extra information for customs purposes. (Only supported for UPS paperless Invoice and FedEx).
6 properties
5 required
document
object
Defines document content and metadata.
5 properties
3 required
currencyCodeLabelsEnum
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…
countryCodeLabelsEnum
string
Indicates the country.
payerTypeEnum
string
Indicates which party involved in the shipment is responsible for payment.
carrierEnum
string
The list of supported small parcel carriers
serviceLevelLabelsEnum
string
The list of supported small parcel carrier service levels
hazardousClassDivisionNumberEnum
string
The list of supported hazardous material classes
successLabelCreate
object
12 properties
packageShippingInfo
object
5 properties
carrierMessage
object
3 properties
packageLabel
object
3 properties
documentInfo
object
3 properties
error400
object
4 properties
error401
object
4 properties
3 required
error403
object
3 properties
3 required
error404
object
3 properties
3 required
error422
object
3 properties
3 required
error424
object
4 properties
3 required
packageCodeRatingEnum
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…
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…
parcelPackageCodeEnum
string
Used to specify if carrier-specific branded packaging is used for a parcel shipment. For a detailed description of all enumerated codes please find them here .
contactTypeEnum
string
Indicates the type of contact specified: Vendor - Vendor party (Non Transportation Supplier) Buyer - Buyer Party Contact - Contact Party OrderedBy - Ordered By…
contactPositionEnum
string
Indicates the type of contact. For a detailed description of all enumerated codes please find them here .
contactMethodEnum
string
Indicates the best method for reaching the specified contact.
weightUomEnum
string
Unit of measure for weight parameters.
volumeUomEnum
string
Unit of measure for volume parameters.
linearUomEnum
string
Unit of measure for height, width, and length parameters.
temperatureUomEnum
string
Unit of measure for temperature parameters.
temperatureSensitiveEnum
string
Indicates if temperature control is needed, and what level: Dry - Dry Fresh - Fresh (25 to 32 degrees) Frozen - Frozen (-10 to 0 degrees) Chilled - Chilled (40…
distanceUomEnum
string
Unit of measure for distance parameters.
stateProvinceCodeEnum
string
Indicate the state or province of the location. For a detailed description of all enumerated codes please find them here .
stateProvinceCodeRatingEnum
string
Indicate the state or province of the location. For a detailed description of all enumerated codes please find them here . Required if quote will be used to cr…
countryCodeEnum
string
Indicate the country of the location. For a detailed description of all enumerated codes please find them here .
countryCodeRatingEnum
string
Indicate the country of the location. For a detailed description of all enumerated codes please find them here .
referenceNumber
object
2 properties
2 required
specialRequirementRating
object
11 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,…
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…
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
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…
tarpTypeEnum
string
Details the type of tarp required for flat bed trailer. 10 - Ten Feet 2 - Two Feet 4 - Four Feet 6 - Six Feet 8 - Eight Feet MESH - Nursery/Mesh NO TARP - No T…
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…
itemEquipmentTypeEnum
string
Indicates the equipment type needed to move the item. For a detailed description of all enumerated codes please find them here .
orderEventLocationType
string
Identifies the type of stop the location is.
orderEventLocationStyle
string
identifies the style of the stop.
orderEventServiceLevel
string
Identifies the level of service.
serviceLevelEnum
string
C.H. Robinson defined code for a service offering. For a detailed description of all enumerated codes please find them here .
hazardousGroupEnum
string
Dangerous goods are assigned into 3 packing groups (also known as UN Packing Group) in accordance with the degree of danger they present. I - Group I - Major D…
hazmatCodeEnum
string
Defines the authorizing entity: C - HazMat Canadian Regulatory Authority Codes D - HazMat US Regulatory Authority Codes I - HazMat MX/International Regulatory…
vesselStowageCategoryEnum
string
Indicates the HazMat Stowage category code according stowage requirements listed in the IMDG Code Dangerous Goods List. A - Stowage category code A B - Stowage…
marinePollutantCategory
string
Indicates the Marine Pollutant Category for Hazardous Materials. Severe Marine Pollutant Marine Pollutant
additionalLocationTypeEnum
string
The additional locations types on the order. BailmentWarehouse - Bailment Warehouse BillToParty - Bill To Party Consignee - Consignee DeliveryAddress - Deliver…
transportModeEnum
string
Defines the mode: LTL - Less Than Truckload TL - Truckload Air - Air Ocean - Ocean Bulk - Bulk Consol - Consolidated Flatbed - Flatbed IMDL - Intermodal
condition
string
Identifies the condition.
specialServicesEnum
string
Defines the specialServices: teamDriver - indicates if truckload includes 2 drivers STF - driver and equipment meet safe transportation of food standards tanke…
orderEventMode
string
Identifies the mode of the service.
sellModeEnum
string
Defines the mode: LTL - Less than Truckload Transportation TL - Truckload Transportation DomesticAir - Domestic Air Transportation Ocean - Ocean Transportation…
freightClassEnum
string
Indicates the freight class on this shipment. (Freight Class is a voluntary standard that provides a comparison of commodities moving in interstate, intrastate…
freightEstimateResponseEnum
number
Estimated freight class for the request. (Freight Class is a voluntary standard that provides a comparison of commodities moving in interstate, intrastate and…
availableShipmentEquipmentEnum
array
C.H. Robinson defined code for equipment. 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 .
availableShipmentsRateEnum
string
C.H. Robinson defined rate code. For a detailed description of all enumerated codes please find them here .
specializedEquipmentCodeNAEnum
string
Code to indicate specialized equipment for NA. For a detailed description of all enumerated codes please find them here .
specializedEquipmentCodeEUEnum
string
Code to indicate specialized equipment for EU. For a detailed description of all enumerated codes please find them here .
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…
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…
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…
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…
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'…
equipmentCodeEnum
string
Only one container type per rating request is currently supported.
invoiceMethodEnum
string
Method which customer will be invoiced. PP - Pre-Paid CL - Collect TP - Third Party PC - Pre-Paid and Add CC - Credit Card
incoTermsEnum
string
The Incoterms or International Commercial Terms are a series of pre-defined commercial terms published by the International Chamber of Commerce (ICC) relating…
movementTypeEnum
string
Specifies movement type of the shipment: OD - "Origin Dray" DD - "Destination Dray" OPDP - "Origin Port to Destination Port" OPDD - "Origin Port to Destination…
shipmentContainerTypeEnum
string
Type of shipping container. For a detailed description of all enumerated codes please find them here .
docTypeEnum
string
C.H. Robinson codes for the different types of documents. For a detailed description of all enumerated codes please find them here .
gfBooking
object
Represents a GF Booking in C.H. Robinson's Navisphere®.
14 properties
3 required
BookingAddress
object
Object that contains address specific information.
11 properties
BookingMode
string
Indicates the requested mode of transportation.
CommodityItem
object
Represents a commodity item in the shipment.
21 properties
4 required
BookingContainer
object
Container data.
5 properties
2 required
BookingFreightTerm
string
Code to indicate the freight term type.
BookingHazardousProperties
object
Object containing hazardous material information.
12 properties
BookingIncoTerms
string
The Incoterms or International Commercial Terms.
InternalBooking
object
Represents an internal booking that extends the base Booking class with additional internal-specific properties.
BookingLocation
object
List of locations where freight is being transferred for this Booking.
7 properties
1 required
BookingLocationType
string
Location type enumeration.
BookingPackageCode
string
C.H. Robinson defined code for packaging type/code.
PackagesDimensions
object
Details for packaging contained within each commodity item handling unit.
9 properties
1 required
BookingParty
object
Represents a party involved in the shipment.
5 properties
1 required
PartyType
string
Party type enumeration.
ReferenceNumber
object
Represents a reference number with type and value.
2 properties
2 required
BookingReferenceNumberType
string
C.H. Robinson defined code for reference number types.
BookingServiceLevel
string
Specifies movement type of the shipment.
BookingShipmentContainerType
string
Type of shipping container.
Stackable
string
Indicates whether packages are stackable.
BookingVolumeUom
string
Unit of measure for volume parameters.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from C.H. Robinson 1
Other APIs C.H. Robinson publishes across the network.
C.H. Robinson Carrier API
#Navisphere#Quoting#Shipments#Shippers#Tracking#TMS
Where this information came from
This is an independent, third-party profile of C.H. Robinson Navisphere Shipper API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.