The identity and technical contract details declared by the specification.
bookedCustomer
object
The customer(s) on the shipment.
5 properties
globalForwardingStopTypeEnum
string
Indicates the type of the stop.
countryCodeEnum
string
Indicate the country of the location. For a detailed description of all enumerated codes please find them here .
globalForwardingUnknownShipmentStatusValue
string
This represents a new shipment status that has been implemented, but it not yet ready for public consumption.
globalForwardingToAirport
orderEventServiceLevel
string
Identifies the level of service.
globalForwardingServiceLevelEnum
string
globalForwardingAddress
objectnull
6 properties
packageInTransitEvent
object
7 properties
globalForwardingNzCustoms
object
This represents the customs entries for New Zealand.
1 property
ordersEventsHazardousProperties
object
Object containing hazardous material information.
22 properties
1 required
orderEventMode
string
Identifies the mode of the service.
globalForwardingUnknownIncoTermsValue
string
This represents a new INCO terms value that has been implemented, but it not yet ready for public consumption.
globalForwardingAuCustoms
object
This represents the customs entries for Australia.
1 property
globalForwardingFromAirport
globalForwardingModeEnum
string
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…
contactPositionEnum
string
Indicates the type of contact. For a detailed description of all enumerated codes please find them here .
globalForwardingUnknownNzCustomsStatusValue
string
This represents a new New Zealand customs status that has been implemented, but it not yet ready for public consumption.
globalForwardingUnknownContainerTypeValue
string
This represents a new container type that has been implemented, but it not yet ready for public consumption.
eventResponse
object
Contains the response JSON from GET call.
6 properties
globalForwardingPgaStatusEnum
string
globalForwardingUnknownCustomsEntryStatusValue
string
This represents a new customs entry status that has been implemented, but it not yet ready for public consumption.
orderEventService
object
8 properties
globalForwardingShipmentTypeEnum
string
globalForwardingUnknownModeValue
string
This represents a new mode that has been implemented, but it not yet ready for public consumption.
eventAddress
object
Contains address information
8 properties
2 required
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…
globalForwardingQuantity
object
2 properties
orderEventLocation
object
Location information specific to the service.
7 properties
volumeUomEnum
string
Unit of measure for volume parameters.
inTransitAddress
object
Contains address information
5 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
appointmentEvent
object
7 properties
contactMethod
object
Object defining contact method.
2 properties
2 required
globalForwardingShipmentEvent
object
Represents a Global Forwarding shipment event.
23 properties
eventItem
object
21 properties
proposedCarrier
object
Carrier CHR is proposing to use for this shipment (Only available for Small Parcel Mode).
1 property
error404
object
3 properties
3 required
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…
eventPackage
object
Package object.
5 properties
referenceNumber
object
2 properties
2 required
globalForwardingUnknownServiceLevelValue
string
This represents a new service level that has been implemented, but it not yet ready for public consumption.
stopEventLocation
object
Location information specific to the event.
13 properties
globalForwardingAuCustomsN10
object
This represents the N10 document for Australia customs entry.
3 properties
inTransitEvent
object
11 properties
loadDetails
object
Contains load specific information and reference numbers.
2 properties
globalForwardingUnknownAuCustomsStatusValue
string
This represents a new Australia customs status that has been implemented, but it not yet ready for public consumption.
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…
globalForwardingCustoms
object
This represents customs entries.
2 properties
globalForwardingNzCustomsN10
object
This represents the N10 document for a New Zealand customs entry.
3 properties
error403
object
3 properties
3 required
eventLocation
object
Location information specific to the event.
12 properties
contact
object
Object containing contact information.
4 properties
4 required
globalForwardingUnknownUnitOfMeasureValue
string
This represents a new unit of measure that has been implemented, but it not yet ready for public consumption.
stateProvinceCodeEnum
string
Indicate the state or province of the location. For a detailed description of all enumerated codes please find them here .
error400
object
4 properties
globalForwardingUnknownStopTypeValue
string
This represents a new stop type that has been implemented, but it not yet ready for public consumption.
loadEventOrderDetail
object
Contains order number and order tracking information.
8 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…
globalForwardingFreightTermsEnum
stringnull
Prepaid: The shipper pays for the freight charges. Collect: The customer/consignee pays for the freight charges.
globalForwardingUnknownPgaStatusValue
string
This represents a new PGA status value that has been implemented, but it not yet ready for public consumption.
bookedBillTo
object
The bill to(s) on the shipment.
9 properties
condition
string
Identifies the condition.
orderDetail
object
Contains order number and order tracking information.
7 properties
globalForwardingUnknownFreightTermsValue
string
This represents a new freight terms value that has been implemented, but it not yet ready for public consumption.
packageStopEvent
object
6 properties
globalForwardingContainer
object
21 properties
orderEventItem
object
Items tied to the service.
27 properties
eventCharge
object
Object relating to the charges for the order.
5 properties
2 required
eventResponses
object
2 properties
orderEventLocationType
string
Identifies the type of stop the location is.
linearUomEnum
string
Unit of measure for height, width, and length parameters.
globalForwardingOceanMainlineCarrier
objectnull
The mainline carrier that transports the shipment over the ocean.
6 properties
eventLoadPackage
object
Package object.
3 properties
globalForwardingAuCustomsStatusEnum
string
This represents a Australia customs statuses that have been implemented and available for use.
globalForwardingFlight
objectnull
A flight that is used to transport the shipment.
4 properties
globalForwardingUsCustomsEntry
object
The US customs entry for the shipment.
1 property
stopEvent
object
12 properties
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…
orderNumber
object
1 property
globalForwardingUnknownShipmentTypeValue
string
This represents a new shipment type that has been implemented, but it not yet ready for public consumption.
contactTypeEnum
string
Indicates the type of contact specified: Vendor - Vendor party (Non Transportation Supplier) Buyer - Buyer Party Contact - Contact Party OrderedBy - Ordered By…
contactMethodEnum
string
Indicates the best method for reaching the specified contact.
globalForwardingLocation
object
4 properties
loadStopInformation
object
Stop information specific to the load.
4 properties
orderEventLocationStyle
string
identifies the style of the stop.
globalForwardingNzCustomsStatusEnum
string
This represents a New Zealand customs statuses that have been implemented and available for use.
globalForwardingCustomsEntry
object
The customs entry for the shipment.
4 properties
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…
globalForwardingUnknownEventTypeValue
string
This represents a new event type that has been implemented, but it not yet ready for public consumption.
globalForwardingUnknownChrServiceValue
string
This represents a new service level that has been implemented, but it not yet ready for public consumption.
weightUomEnum
string
Unit of measure for weight parameters.
globalForwardingCustomsEntryStatusEnum
string
hazmatCodeEnum
string
Defines the authorizing entity: C - HazMat Canadian Regulatory Authority Codes D - HazMat US Regulatory Authority Codes I - HazMat MX/International Regulatory…
globalForwardingContainerTypeEnum
stringnull
globalForwardingChrServiceEnum
string
globalForwardingShipmentStatusEnum
string
trackingNumberEvent
object
5 properties
invoiceMethodEnum
string
Method which customer will be invoiced. PP - Pre-Paid CL - Collect TP - Third Party PC - Pre-Paid and Add CC - Credit Card
orderEventOrderDetail
object
Contains order number and order tracking information.
5 properties
orderEvent
object
5 properties
globalForwardingUnitOfMeasureEnum
stringnull
loadEvent
object
17 properties
packageInTransitAddress
object
Contains address information
6 properties
globalForwardingPgaStatus
object
The status of the Partner Government Agency (PGA) release for the cargo.
4 properties
inTransitNextStop
object
Contains stop information
5 properties
globalForwardingOceanShipment
objectnull
When this shipment is an ocean shipment, this object will contain ocean shipment details.
8 properties
carrier
object
Object containing carrier information.
14 properties
globalForwardingIncoTermsEnum
stringnull
globalForwardingAirMainlineCarrier
objectnull
The mainline carrier that transports the shipment over air.
4 properties
contactPosition
object
Object containing contact information.
4 properties
4 required
globalForwardingAirShipment
objectnull
When this shipment is an air shipment, this object will contain air shipment details.
19 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.