C.H. Robinson Orders and Booking 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 Orders and Booking. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
7 operations
across 5 paths,
and defines 89 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.
orderResponse
object
Object containg the order response.
1 property
order
object
14 properties
3 required
exportReasonCode
string
A value required for DHL international shipments indicating why the shipment is being exported.
quoteOrderResponse
object
Object containing the quote order response.
3 properties
specialRequirementOrder
object
11 properties
countryCodeEnum
string
Indicate the country of the location. For a detailed description of all enumerated codes please find them here .
PartyType
string
Party type enumeration.
ReferenceNumber
object
Represents a reference number with type and value.
2 properties
2 required
sellModeEnum
string
Defines the mode: LTL - Less than Truckload Transportation TL - Truckload Transportation DomesticAir - Domestic Air Transportation Ocean - Ocean Transportation…
charge
object
Object relating to the charges for the order.
4 properties
2 required
BookingReferenceNumberType
string
C.H. Robinson defined code for reference number types.
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.
BookingLocationType
string
Location type enumeration.
gfBooking
object
Represents a GF Booking in C.H. Robinson's Navisphere®.
14 properties
3 required
orderItem
object
37 properties
2 required
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…
BookingVolumeUom
string
Unit of measure for volume parameters.
payerTypeEnum
string
Indicates which party involved in the shipment is responsible for payment.
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…
BookingPackageCode
string
C.H. Robinson defined code for packaging type/code.
additionalLocationTypeEnum
string
The additional locations types on the order. BailmentWarehouse - Bailment Warehouse BillToParty - Bill To Party Consignee - Consignee DeliveryAddress - Deliver…
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…
quoteBillTo
object
Object containing bill to information.
3 properties
Stackable
string
Indicates whether packages are stackable.
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…
volumeUomEnum
string
Unit of measure for volume parameters.
BookingLocation
object
List of locations where freight is being transferred for this Booking.
7 properties
1 required
BookingShipmentContainerType
string
Type of shipping container.
BookingAddress
object
Object that contains address specific information.
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,…
error401
object
4 properties
3 required
quote
object
Object containing information for quote order.
9 properties
1 required
BookingContainer
object
Container data.
5 properties
2 required
contactMethod
object
Object defining contact method.
2 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
orderBillTo
object
Object containing bill to information.
6 properties
2 required
bookingNumber
string
The booking number for FedEx heavy air shipments.
orderAddress
object
Object that contains address specific information.
11 properties
5 required
error404
object
3 properties
3 required
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).
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…
referenceNumber
object
2 properties
2 required
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…
collectOnDelivered
object
Information relating to payment.
6 properties
5 required
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…
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…
CommodityItem
object
Represents a commodity item in the shipment.
21 properties
4 required
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.
BookingFreightTerm
string
Code to indicate the freight term type.
additionalLocation
object
List of additional Locations for Ocean/Air transport Mode.
14 properties
1 required
orderCustomer
object
Object containing customer information.
3 properties
1 required
relationships
object
Object to specify master and inner pack qantities.
3 properties
BookingParty
object
Represents a party involved in the shipment.
5 properties
1 required
error403
object
3 properties
3 required
contact
object
Object containing contact information.
4 properties
4 required
BookingMode
string
Indicates the requested mode of transportation.
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.
shipmentContainerTypeEnum
string
Type of shipping container. For a detailed description of all enumerated codes please find them here .
error400
object
4 properties
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…
itemEquipmentTypeEnum
string
Indicates the equipment type needed to move the item. For a detailed description of all enumerated codes please find them here .
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…
linearUomEnum
string
Unit of measure for height, width, and length parameters.
BookingIncoTerms
string
The Incoterms or International Commercial Terms.
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…
contactTypeEnum
string
Indicates the type of contact specified: Vendor - Vendor party (Non Transportation Supplier) Buyer - Buyer Party Contact - Contact Party OrderedBy - Ordered By…
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
contactMethodEnum
string
Indicates the best method for reaching the specified contact.
shippingContainerItems
object
2 properties
2 required
quoteService
object
Object containing quote service information.
4 properties
PackagesDimensions
object
Details for packaging contained within each commodity item handling unit.
9 properties
1 required
shippingContainers
object
12 properties
1 required
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).
BookingHazardousProperties
object
Object containing hazardous material information.
12 properties
weightUomEnum
string
Unit of measure for weight parameters.
hazmatCodeEnum
string
Defines the authorizing entity: C - HazMat Canadian Regulatory Authority Codes D - HazMat US Regulatory Authority Codes I - HazMat MX/International Regulatory…
orderPackage
object
14 properties
1 required
orderService
object
Object containing service information.
21 properties
2 required
quoteLocation
object
Object containing quote location information.
13 properties
itemEquipment
object
Additional information as to the specific equipment needs.
10 properties
serviceLevelEnum
string
C.H. Robinson defined code for a service offering. For a detailed description of all enumerated codes please find them here .
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 .
BookingServiceLevel
string
Specifies movement type of the shipment.
hazardousProperties
object
Object containing hazardous material information.
22 properties
1 required
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…
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
marinePollutantCategory
string
Indicates the Marine Pollutant Category for Hazardous Materials. Severe Marine Pollutant Marine Pollutant
The full machine-readable OpenAPI contract behind this narrative.
Other APIs C.H. Robinson publishes across the network.
