{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/ch-robinson-worldwide/main/json-schema/ch-robinson-worldwide-event-responses-schema.json",
"title": "eventResponses",
"x-generated": "2026-10-20",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/ch-robinson-worldwide-events-api-openapi.yml#/components/schemas/eventResponses",
"type": "object",
"properties": {
"totalCount": {
"type": "integer",
"description": "Total number of events available for search criteria."
},
"results": {
"type": "array",
"description": "Contains all events based on parameter search criteria.",
"items": {
"$ref": "#/$defs/eventResponse"
}
}
},
"$defs": {
"appointmentEvent": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "Indicates an appointment has been added or changed at one of the designated stops. \n* `APPOINTMENT UPDATED` - Provides appointment time window for the stop.",
"enum": [
"APPOINTMENT UPDATED"
]
},
"orderDetails": {
"type": "array",
"description": "Contains order number and order tracking information.",
"items": {
"$ref": "#/$defs/orderDetail"
}
},
"loadNumber": {
"type": "integer",
"description": "C.H. Robinson defined shipment number."
},
"location": {
"$ref": "#/$defs/eventLocation"
},
"carrier": {
"$ref": "#/$defs/carrier"
},
"appointment": {
"type": "object",
"description": "Appointment information",
"properties": {
"appointmentNumber": {
"type": "string",
"description": "Appointment number."
},
"scheduledOpenDateTimeUTC": {
"type": "string",
"format": "date-time",
"description": "Indicates the scheduled earliest date/time carrier can arrive at the stop."
},
"scheduledCloseDateTimeUTC": {
"type": "string",
"format": "date-time",
"description": "Indicates the scheduled latest date/time carrier can arrive at the stop"
},
"changeReason": {
"$ref": "#/$defs/lateCodeEnum"
},
"scheduledCompany": {
"type": "string",
"description": "Name of the company appointment is scheduled with."
},
"scheduledWithName": {
"type": "string",
"description": "Name of individual the appointment is scheduled with."
}
}
},
"items": {
"type": "array",
"description": "List of items associated to the shipment.",
"items": {
"$ref": "#/$defs/bookedItem"
}
}
}
},
"bookedBillTo": {
"type": "object",
"description": "The bill to(s) on the shipment.",
"properties": {
"customerCode": {
"type": "string",
"description": "C.H. Robinson defined customer code."
},
"customerName": {
"type": "string",
"description": "The name of the customer."
},
"currencyCode": {
"$ref": "#/$defs/currencyCodeEnum"
},
"invoiceMethod": {
"$ref": "#/$defs/invoiceMethodEnum"
},
"milesBilled": {
"type": "string",
"description": "total miles of the shipment."
},
"exchangeRate": {
"type": "double",
"description": "Exhange rate."
},
"charges": {
"type": "array",
"description": "Charges tied to the bill to.",
"items": {
"$ref": "#/$defs/eventCharge"
}
},
"contacts": {
"type": "array",
"description": "Bill to contacts.",
"items": {
"$ref": "#/$defs/contact"
}
},
"referenceNumbers": {
"type": "array",
"description": "Bill To reference numbers.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"bookedCustomer": {
"type": "object",
"description": "The customer(s) on the shipment.",
"properties": {
"customerCode": {
"type": "string",
"description": "C.H. Robinson defined customer code."
},
"customerName": {
"type": "string",
"description": "The name of the customer."
},
"contacts": {
"type": "array",
"description": "Customer contacts.",
"items": {
"$ref": "#/$defs/contactPosition"
}
},
"ebolEnabledWithCarrier": {
"type": "boolean",
"description": "Indicates if customer is enabled with listed carrier to retrieve PRO number in advance of pickup."
},
"referenceNumbers": {
"type": "array",
"description": "Customer reference numbers.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"bookedItem": {
"allOf": [
{
"$ref": "#/$defs/eventItem"
},
{
"type": "object",
"properties": {
"associatedStop": {
"type": "object",
"description": "Identifies the pick up and drop off stop sequence numbers.",
"properties": {
"pickSequenceNumber": {
"type": "integer",
"description": "Identifies sequence number of where the item is picked up."
},
"dropSequenceNumber": {
"type": "integer",
"description": "Identifies sequence number of where the item is dropped off."
}
}
},
"expectedPallets": {
"type": "string",
"format": "float",
"description": "Expected pallet count of the item(s)."
},
"expectedQuantity": {
"type": "string",
"format": "float",
"description": "Expected quantity of the item(s)."
},
"expectedWeight": {
"type": "string",
"format": "float",
"description": "Expected weight of the item(s)."
},
"expectedWeightUnitOfMeasure": {
"$ref": "#/$defs/weightUomEnum"
},
"expectedPackagingLength": {
"type": "string",
"format": "float",
"description": "Expected packaging length of the item(s)."
},
"expectedPackagingHeight": {
"type": "string",
"format": "float",
"description": "Expected height length of the item(s)."
},
"expectedPackagingWidth": {
"type": "string",
"format": "float",
"description": "Expected packaging width of the item(s)."
},
"expectedPackagingUnitOfMeasure": {
"$ref": "#/$defs/linearUomEnum"
},
"expectedVolume": {
"type": "string",
"format": "float",
"description": "Volume of the item(s)."
},
"expectedVolumeUnitOfMeasure": {
"$ref": "#/$defs/volumeUomEnum"
},
"innerPackQuantity": {
"type": "float",
"description": "Represents the number of units of the innermost packing."
}
}
}
]
},
"bookedLocation": {
"allOf": [
{
"$ref": "#/$defs/eventLocation"
},
{
"type": "object",
"properties": {
"appointmentNumber": {
"type": "string",
"description": "Appointment number."
},
"scheduledOpenDateTime": {
"type": "string",
"format": "date-time",
"description": "An ISO8601 UTC date-time when location is scheduled to be open."
},
"scheduledCloseDateTime": {
"type": "string",
"format": "date-time",
"description": "An ISO8601 UTC date-time when location is scheduled to be closed."
},
"scheduledEnteredDate": {
"type": "string",
"format": "date-time",
"description": "An ISO8601 UTC date-time when the scheduledCloseDateTime and scheduledOpenDateTime was entered."
},
"arrivalDateTime": {
"type": "string",
"format": "date-time",
"description": "An ISO8601 UTC date-time that carrier has arrived."
},
"departureDateTime": {
"type": "string",
"format": "date-time",
"description": "An ISO8601 UTC date-time that carrier has departed."
},
"isDropTrailerNeeded": {
"type": "boolean",
"description": "Informs if drop trailer is required at this location."
},
"scheduledWith": {
"type": "string",
"description": "Individual who accepted the appointment for this location."
},
"etaDateTime": {
"type": "string",
"format": "date-time",
"description": "Estimated time of arrival for this location."
}
}
}
]
},
"carrier": {
"type": "object",
"description": "Object containing carrier information.",
"properties": {
"name": {
"type": "string",
"description": "Name of carrier executing shipment."
},
"carrierCode": {
"type": "string",
"description": "C.H. Robinson defined carrier code."
},
"scac": {
"type": "string",
"description": "In North America this is the Nmfta defined standard carrier alpha code."
},
"proNumber": {
"type": "string",
"description": "Carrier provided primary reference number. Primarily used for LTL shipments."
},
"driverName": {
"type": "string",
"description": "Name of the driver transporting the shipment."
},
"driverPhone": {
"type": "string",
"description": "Phone number of the driver transporting the shipment."
},
"secondDriverName": {
"type": "string",
"description": "Name of the driver transporting the shipment."
},
"sealNumber": {
"type": "string",
"description": "If trailer has a seal, the identifier of the seal."
},
"licensePlate": {
"type": "string",
"description": "License plate of the powered unit."
},
"tractorNumber": {
"type": "string",
"description": "Identifier of the powered unit transporting the shipment."
},
"trailerNumber": {
"type": "string",
"description": "Identifier of the trailer the shipment resides in."
},
"dotNumber": {
"type": "string",
"description": "A number that is issued by the Department of Transportation to a carrier."
},
"barcodeType": {
"type": "string",
"description": "Represents the barcode type used by the carrier."
},
"ebolEnabled": {
"type": "boolean",
"description": "Indicates if carrier can provide PRO number in advance of pickup."
}
}
},
"condition": {
"type": "string",
"description": "Identifies the condition.",
"enum": [
"Active",
"OnHold",
"PartiallyFinLocked",
"FinanciallyLocked",
"Rejected",
"Cancelled",
"WaitingAcceptance",
"WaitingRecommendation",
"NotShipReady",
"Unreleased"
]
},
"contact": {
"type": "object",
"description": "Object containing contact information.",
"required": [
"name",
"type",
"companyName",
"contactMethods"
],
"properties": {
"name": {
"type": "string",
"minimum": 1,
"maximum": 200,
"description": "Name of the contact."
},
"type": {
"$ref": "#/$defs/contactTypeEnum"
},
"companyName": {
"type": "string",
"minimum": 1,
"maximum": 100,
"description": "Company name of the contact."
},
"contactMethods": {
"type": "array",
"description": "Contact Methods",
"items": {
"$ref": "#/$defs/contactMethod"
}
}
}
},
"contactMethod": {
"type": "object",
"description": "Object defining contact method.",
"required": [
"method",
"value"
],
"properties": {
"method": {
"$ref": "#/$defs/contactMethodEnum"
},
"value": {
"type": "string",
"minimum": 1,
"maximum": 50,
"description": "Actual content of contact information."
}
}
},
"contactMethodEnum": {
"type": "string",
"description": "Indicates the best method for reaching the specified contact.\n",
"enum": [
"Email",
"Phone",
"Fax"
]
},
"contactPosition": {
"type": "object",
"description": "Object containing contact information.",
"required": [
"name",
"type",
"companyName",
"contactMethods"
],
"properties": {
"name": {
"type": "string",
"minimum": 1,
"maximum": 200,
"description": "Name of the contact."
},
"type": {
"$ref": "#/$defs/contactPositionEnum"
},
"companyName": {
"type": "string",
"minimum": 1,
"maximum": 100,
"description": "Company name of the contact."
},
"contactMethods": {
"type": "array",
"description": "Contact Methods",
"items": {
"$ref": "#/$defs/contactMethod"
}
}
}
},
"contactPositionEnum": {
"type": "string",
"description": "Indicates the type of contact. \n\nFor a detailed description of all enumerated codes please find them here. \n\n ### ",
"enum": [
"AA",
"AM",
"AP",
"AR",
"AUD",
"BILL",
"CEO",
"CFO",
"CIO",
"Claims",
"CLERK",
"CM",
"CO",
"CONTROLLER",
"COO",
"CSR",
"DIF",
"DIR",
"DISP",
"EDI",
"EVP",
"EVPO",
"EVPSC",
"IO",
"IS",
"ITM",
"LAW",
"LP",
"Manager",
"MIS",
"OPM",
"OPS",
"OWN",
"PAY",
"Pchs",
"PM",
"PRES",
"RATES",
"Safety Ops",
"SALES",
"SM",
"TM",
"TRANMAN",
"TRM",
"TRSR",
"VP",
"VPSOUR",
"WHSE",
"WM",
"WO",
"WR",
"WS"
]
},
"contactTypeEnum": {
"type": "string",
"description": "Indicates the type of contact specified:\n * `Vendor` - Vendor party (Non Transportation Supplier)\n * `Buyer` - Buyer Party\n * `Contact` - Contact Party\n * `OrderedBy` - Ordered By Party on the Order or Load\n * `NotifyParty` - Notify Party\n * `OnlineContact` - CHRWOnline Contact\n * `SchedWith` - Scheduled With\n * `POCustomer` - Customer on the Purchase Order\n",
"enum": [
"Vendor",
"Buyer",
"Contact",
"OrderedBy",
"NotifyParty",
"OnlineContact",
"SchedWith",
"POCustomer"
]
},
"countryCodeEnum": {
"type": "string",
"description": "Indicate the country of the location. \n\nFor a detailed description of all enumerated codes please find them here.",
"enum": [
"AD",
"AE",
"AF",
"AG",
"AI",
"AL",
"AM",
"AO",
"AQ",
"AR",
"AS",
"AT",
"AU",
"AW",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BI",
"BJ",
"BM",
"BN",
"BO",
"BR",
"BS",
"BT",
"MM",
"BV",
"BW",
"BY",
"BZ",
"CA",
"CC",
"CD",
"CF",
"CG",
"CH",
"CI",
"CK",
"CL",
"CM",
"CN",
"CO",
"CR",
"RS",
"CU",
"CV",
"CX",
"CY",
"CZ",
"DE",
"DJ",
"DK",
"DM",
"DO",
"DZ",
"EC",
"EE",
"EG",
"EH",
"ER",
"ES",
"ET",
"FI",
"FJ",
"FK",
"FM",
"FO",
"FR",
"GA",
"GD",
"GE",
"GF",
"GH",
"GI",
"GL",
"GM",
"GN",
"GP",
"GQ",
"GR",
"GS",
"GT",
"GU",
"GW",
"GY",
"HK",
"HM",
"HN",
"HR",
"HT",
"HU",
"ID",
"IE",
"IL",
"IN",
"IO",
"IQ",
"IR",
"IS",
"IT",
"JM",
"JO",
"JP",
"KE",
"KG",
"KH",
"KI",
"KM",
"KN",
"KP",
"KR",
"KW",
"KY",
"KZ",
"LA",
"LB",
"LC",
"LI",
"LK",
"LR",
"LS",
"LT",
"LU",
"LV",
"LY",
"MA",
"MC",
"MD",
"MG",
"MH",
"MK",
"ML",
"MN",
"MO",
"MP",
"MQ",
"MR",
"MS",
"MT",
"MU",
"MV",
"MW",
"MX",
"MY",
"MZ",
"NA",
"NC",
"NE",
"NF",
"NG",
"NI",
"NL",
"NO",
"NP",
"NR",
"NU",
"NZ",
"OM",
"PA",
"PE",
"PF",
"PG",
"PH",
"PK",
"PL",
"PM",
"PN",
"PR",
"PS",
"PT",
"PW",
"PY",
"QA",
"RE",
"RO",
"RU",
"RW",
"SA",
"SB",
"SC",
"SD",
"SE",
"SG",
"SH",
"SI",
"SJ",
"SK",
"SL",
"SM",
"SN",
"SO",
"SR",
"ST",
"SV",
"SY",
"SZ",
"TC",
"TD",
"TF",
"TG",
"TH",
"TJ",
"TK",
"TL",
"TM",
"TN",
"TO",
"TP",
"TR",
"TT",
"TV",
"TW",
"TZ",
"UA",
"UG",
"GB",
"UM",
"US",
"UY",
"UZ",
"VA",
"VC",
"VE",
"VG",
"VI",
"VN",
"VU",
"WF",
"WS",
"YE",
"YT",
"ZA",
"ZM",
"ZR",
"ZW",
"AX",
"GG",
"IM",
"JE",
"ME",
"MF",
"CW",
"SX",
"SS",
"IC",
"XC",
"XL"
]
},
"currencyCodeEnum": {
"type": "string",
"description": "Code to indicate the currency being used. The most common currently in use with C.H. Robinson:\n\n* `USD` - US Dollar\n* `CAD` - Canadian Dollar \n* `MXN` - Mexican Peso\n* `EUR` - European Euro\n\n\n\nFor a detailed description of all enumerated codes please find them here.",
"enum": [
"USD",
"CAD",
"EUR",
"MXN",
"CHF",
"GBP",
"HUF",
"CZK",
"NZD",
"PLN",
"ZAR",
"VEB",
"VND",
"TWD",
"TRY",
"SEK",
"SGD",
"RUB",
"NOK",
"HKD",
"INR",
"JPY",
"CLP",
"CNY",
"DKK",
"AUD",
"BRL",
"AED",
"PEN",
"THB",
"ARS",
"MYR",
"VEF",
"SAR",
"BBD",
"BHD",
"BMD",
"BSD",
"ILS",
"ISK",
"KES",
"KRW",
"KWD",
"OMR",
"PHP",
"PKR",
"QAR",
"RON",
"TTD",
"UAH",
"LKR",
"XPF",
"UYU",
"COP",
"CRC",
"FJD"
]
},
"eventAddress": {
"type": "object",
"description": "Contains address information",
"required": [
"city",
"stateProvinceCode"
],
"properties": {
"addressLine1": {
"type": "string",
"description": "Line one of the address."
},
"addressLine2": {
"type": "string",
"description": "Line two of the address."
},
"city": {
"type": "string",
"description": "City name of address."
},
"stateProvinceCode": {
"$ref": "#/$defs/stateProvinceCodeEnum"
},
"postalCode": {
"type": "string",
"description": "Postal code of address."
},
"country": {
"$ref": "#/$defs/countryCodeEnum"
},
"latitude": {
"type": "number",
"format": "float",
"minimum": -90,
"maximum": 90,
"description": "The decimal latitude of the address."
},
"longitude": {
"type": "number",
"format": "float",
"minimum": -180,
"maximum": 180,
"description": "The decimal longitude of the address."
}
}
},
"eventCharge": {
"type": "object",
"description": "Object relating to the charges for the order.",
"required": [
"rate",
"rateCode"
],
"properties": {
"rate": {
"type": "number",
"format": "float",
"description": "Monetary amount of this rate type."
},
"rateCode": {
"$ref": "#/$defs/rateCodeEnum"
},
"quantity": {
"type": "number",
"format": "float",
"description": "Quantity of the rate. Multiplying `rate` by `quantity` will give the total charge for this rate line item.",
"default": 1
},
"alternateDescription": {
"type": "string",
"minimum": 1,
"maximum": 20,
"description": "Description of the charge."
},
"chargeType": {
"type": "string",
"description": "Indicates the type of charge.",
"enum": [
"Actual Charge",
"End Customer Charge"
]
}
}
},
"eventItem": {
"type": "object",
"properties": {
"packagingType": {
"$ref": "#/$defs/packageCodeEnum"
},
"description": {
"type": "string",
"description": "Customer defined description of the item in the order (product name)."
},
"productCode": {
"type": "string",
"description": "Customer defined code of the item in the order."
},
"freightClass": {
"$ref": "#/$defs/freightClassEnum"
},
"insuranceValue": {
"type": "number",
"format": "float",
"description": "Insurance valuation of item."
},
"innerPackQuantity": {
"type": "float",
"description": "Represents the number of units of the innermost packing."
},
"primaryReferenceNumber": {
"type": "string",
"description": "Primary reference number of the item."
},
"poNumber": {
"type": "string",
"description": "PO number number of the item."
},
"skuNumber": {
"type": "string",
"description": "sku number of the item."
},
"pluNumber": {
"type": "string",
"description": "plu number of the item."
},
"actualQuantity": {
"type": "string",
"format": "integer",
"description": "Confirmed quantity of the item(s)."
},
"actualWeight": {
"type": "string",
"format": "float",
"description": "Confirmed weight of the item(s)."
},
"actualWeightUnitOfMeasure": {
"$ref": "#/$defs/weightUomEnum"
},
"actualPallets": {
"type": "string",
"format": "float",
"description": "Actual pallet count of the item(s)."
},
"actualVolume": {
"type": "string",
"format": "float",
"description": "Volume of the item(s)."
},
"actualVolumeUnitOfMeasure": {
"$ref": "#/$defs/volumeUomEnum"
},
"actualPackagingLength": {
"type": "string",
"format": "float",
"description": "Confirmed packaging length of the item(s)."
},
"actualPackagingHeight": {
"type": "string",
"format": "float",
"description": "Confirmed packaging height of the item(s)."
},
"actualPackagingWidth": {
"type": "string",
"format": "float",
"description": "Confirmed packaging width of the item(s)."
},
"actualPackagingUnitOfMeasure": {
"$ref": "#/$defs/linearUomEnum"
},
"referenceNumbers": {
"type": "array",
"description": "Reference numbers associated to this item.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"eventLoadPackage": {
"type": "object",
"description": "Package object.",
"properties": {
"trackingNumber": {
"type": "string",
"description": "Carrier specified tracking number."
},
"packageType": {
"type": "string",
"description": "Customer specified packaging type."
},
"referenceNumbers": {
"type": "array",
"description": "Reference numbers associated to this package.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"eventLocation": {
"type": "object",
"description": "Location information specific to the event.",
"properties": {
"chrLocationId": {
"type": "string",
"description": "C.H. Robinson defined location identifier."
},
"customerLocationId": {
"type": "string",
"description": "Customer generated location identifier."
},
"type": {
"type": "string",
"description": "Identifies the type of stop the location is."
},
"style": {
"type": "string",
"description": "identifies the style of the stop."
},
"stopSequenceNumber": {
"type": "integer",
"description": "Number to indicate where in the order of stops the location is. C.H. Robinson uses a zero index. This means the \\\"0\\\" will indicate the first stop in the sequence of stops."
},
"sequenceNumber": {
"type": "integer",
"description": "System generated number applied to the location when it is entered into the system."
},
"name": {
"type": "string",
"description": "Name of the location."
},
"address": {
"$ref": "#/$defs/eventAddress"
},
"pickUpNumber": {
"type": "string",
"description": "Pick-Up number."
},
"deliveryNumber": {
"type": "string",
"description": "Delivery number."
},
"locationContact": {
"type": "object",
"description": "Contact information for the location.",
"properties": {
"name": {
"type": "string",
"description": "Name of contact at the location."
},
"phoneNumber": {
"type": "string",
"description": "Phone number of contact at the location."
},
"email": {
"type": "string",
"description": "E-mail address of the contact at the location."
}
}
},
"referenceNumbers": {
"type": "array",
"description": "Reference numbers associated to this location.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"eventPackage": {
"type": "object",
"description": "Package object.",
"properties": {
"trackingNumber": {
"type": "string",
"description": "Carrier specified tracking number."
},
"packageType": {
"type": "string",
"description": "Customer specified packaging type."
},
"ediCode": {
"type": "string",
"description": "Most parcel carriers update us on packages using EDI transactions. ediCode will reflect the EDI event code the carriers provided to us."
},
"note": {
"type": "string",
"description": "Additional information on disposition of the package."
},
"referenceNumbers": {
"type": "array",
"description": "Reference numbers associated to this package.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"eventResponse": {
"type": "object",
"description": "Contains the response JSON from GET call.",
"properties": {
"time": {
"type": "string",
"format": "date-time",
"description": "The date/time in ISO8601 UTC format when the event was written to the Enterprise API database."
},
"customer": {
"type": "string",
"description": "C.H. Robinson defined customer code."
},
"eventTime": {
"type": "string",
"format": "date-time",
"description": "The date/time in ISO8601 UTC format when the event was reported to have occured."
},
"customerReferenceNumber": {
"type": "string",
"description": "Primary customer reference number."
},
"billToReferenceNumber": {
"type": "string",
"description": "Primary customer bill to reference number. Often the customer's order number."
},
"event": {
"type": "object",
"description": "C.H. Robinson defined event type.",
"oneOf": [
{
"$ref": "#/$defs/orderEvent"
},
{
"$ref": "#/$defs/loadEvent"
},
{
"$ref": "#/$defs/stopEvent"
},
{
"$ref": "#/$defs/appointmentEvent"
},
{
"$ref": "#/$defs/inTransitEvent"
},
{
"$ref": "#/$defs/packageInTransitEvent"
},
{
"$ref": "#/$defs/packageStopEvent"
},
{
"$ref": "#/$defs/globalForwardingShipmentEvent"
},
{
"$ref": "#/$defs/trackingNumberEvent"
}
]
}
}
},
"freightClassEnum": {
"type": "string",
"description": "Indicates the freight class on this shipment. (Freight Class is a voluntary standard that provides a comparison of commodities moving in interstate, intrastate and foreign commerce. It is similar in concept to the groupings or grading systems that serve many other industries.)",
"enum": [
"50",
"55",
"60",
"65",
"70",
"77.5",
"85",
"92.5",
"100",
"110",
"125",
"150",
"175",
"200",
"250",
"300",
"400",
"500"
]
},
"globalForwardingAddress": {
"type": [
"object",
"null"
],
"properties": {
"address1": {
"description": "The first line of the address.",
"type": [
"string",
"null"
]
},
"address2": {
"description": "The second line of the address.",
"type": [
"string",
"null"
]
},
"city": {
"description": "The city portion of the address.",
"type": [
"string",
"null"
]
},
"stateProvinceCode": {
"description": "The state or province code of the address.",
"type": [
"string",
"null"
]
},
"country": {
"description": "The country code of the address.",
"type": [
"string",
"null"
]
},
"postalCode": {
"description": "The postal code of the address.",
"type": [
"string",
"null"
]
}
}
},
"globalForwardingAirMainlineCarrier": {
"description": "The mainline carrier that transports the shipment over air.",
"type": [
"object",
"null"
],
"properties": {
"carrierName": {
"description": "The name of the airline carrier.",
"type": [
"string",
"null"
]
},
"carrierScac": {
"description": "The SCAC code of the airline carrier.",
"type": [
"string",
"null"
]
},
"bookingNumber": {
"description": "A unique identifier for the booking.",
"type": [
"string",
"null"
]
},
"flights": {
"description": "An ordered list of flights that are used to transport the shipment.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingFlight"
}
}
}
},
"globalForwardingAirShipment": {
"description": "When this shipment is an air shipment, this object will contain air shipment details.\n",
"type": [
"object",
"null"
],
"properties": {
"houseAirwayBillNumber": {
"description": "The number of the House Airway Bill (HAWB) issued by the forwarder.",
"type": [
"string",
"null"
]
},
"masterAirwayBillNumber": {
"description": "The number of the Master Airway Bill (MAWB) issued by the carrier.",
"type": [
"string",
"null"
]
},
"airMainlineCarrier": {
"$ref": "#/$defs/globalForwardingAirMainlineCarrier"
},
"stops": {
"description": "The stops that the shipment will make during its journey. The stops are in first-to-last order.\n",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingStop"
}
},
"estimatedFlightDepartureFromOriginAirport": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The estimated date-time that the flight will depart from the origin airport."
},
"actualFlightDepartureFromOriginAirport": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the flight departed from the origin airport."
},
"estimatedFlightArrivalAtDestinationAirport": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The estimated date-time that the flight will arrive at the destination airport."
},
"actualFlightArrivalAtDestinationAirport": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the flight arrived at the destination airport."
},
"requestedPickupDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that the customer requested the shipment be picked up from the pick-up location."
},
"estimatedPickupDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that CHR estimates that the shipment will be picked up by the carrier."
},
"actualPickupDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the shipment was be picked up by the carrier."
},
"requestedDeliveryDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that the customer requested the shipment be delivered to the drop-off location."
},
"estimatedDeliveryDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that CHR estimates that the shipment will be delivered to the drop-off location."
},
"actualDeliveryDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the shipment was delivered to the drop-off location."
},
"innerPacks": {
"description": "Aggregated inner pack quantities of all items.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingQuantity"
}
},
"outerPacks": {
"description": "Aggregated outer pack quantities of all items.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingQuantity"
}
},
"totalWeight": {
"type": [
"object",
"null"
],
"properties": {
"kilograms": {
"type": "number",
"format": "decimal"
},
"pounds": {
"type": "number",
"format": "decimal"
}
},
"description": "The total weight of all items."
},
"chargeableWeight": {
"type": [
"object",
"null"
],
"properties": {
"kilograms": {
"type": "number",
"format": "decimal"
},
"pounds": {
"type": "number",
"format": "decimal"
}
},
"description": "The total chargeable weight of all items."
},
"totalVolume": {
"type": [
"object",
"null"
],
"properties": {
"cubicMeters": {
"type": "number",
"format": "decimal"
},
"cubicFeet": {
"type": "number",
"format": "decimal"
}
},
"description": "The total volume of all items."
}
}
},
"globalForwardingAuCustoms": {
"description": "This represents the customs entries for Australia.",
"type": "object",
"properties": {
"n10": {
"$ref": "#/$defs/globalForwardingAuCustomsN10"
}
}
},
"globalForwardingAuCustomsN10": {
"description": "This represents the N10 document for Australia customs entry.",
"type": "object",
"properties": {
"dateOfClearance": {
"description": "The date customs was cleared.",
"type": [
"string",
"null"
],
"format": "date"
},
"entryNumber": {
"description": "A unique identifier assigned to an import declaration or customs entry.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Represents the current status of the customs process for imported goods.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingAuCustomsStatusEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownAuCustomsStatusValue"
}
]
}
}
},
"globalForwardingAuCustomsStatusEnum": {
"type": "string",
"description": "This represents a Australia customs statuses that have been implemented and available for use.\n",
"enum": [
"Cleared"
]
},
"globalForwardingChrServiceEnum": {
"type": "string",
"enum": [
"Non-Vessel Operating Common Carrier",
"Freight Forwarding",
"Air Direct",
"Air House",
"Air Sub House",
"Air Sub Master",
"Customs Brokerage",
"Service Fin Only"
]
},
"globalForwardingContainer": {
"type": "object",
"properties": {
"isAffectedByEvent": {
"description": "`true` if the change identicated by the eventType property on the event corresponds to this container.",
"type": "boolean"
},
"containerNumber": {
"description": "The number of the container. This should be unique within the shipment.",
"type": [
"string",
"null"
]
},
"containerType": {
"description": "The type of the container.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingContainerTypeEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownContainerTypeValue"
}
]
},
"innerPacks": {
"description": "Aggregated inner pack quantities of all items in the container.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingQuantity"
}
},
"outerPacks": {
"description": "Aggregated outer pack quantities of all items in the container.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingQuantity"
}
},
"purchaseOrderNumbers": {
"description": "The Purchase Order (PO) numbers associated with the items within the container.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"sealNumber": {
"description": "The seal number of the container.",
"type": [
"string",
"null"
]
},
"totalGrossWeight": {
"type": [
"object",
"null"
],
"properties": {
"kilograms": {
"type": "number",
"format": "decimal"
},
"pounds": {
"type": "number",
"format": "decimal"
}
},
"description": "The total gross weight of the container."
},
"totalNetWeight": {
"type": [
"object",
"null"
],
"properties": {
"kilograms": {
"type": "number",
"format": "decimal"
},
"pounds": {
"type": "number",
"format": "decimal"
}
},
"description": "The total net weight of the container."
},
"totalVolume": {
"type": [
"object",
"null"
],
"properties": {
"cubicMeters": {
"type": "number",
"format": "decimal"
},
"cubicFeet": {
"type": "number",
"format": "decimal"
}
},
"description": "The total volume of the container."
},
"stops": {
"description": "The stops that the container will make during its journey. The stops are in first-to-last order.\n",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingStop"
}
},
"requestedPickupDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that the customer requested the container be picked up from the pick-up location."
},
"requestedDeliveryDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that the customer requested the container be delivered to the drop-off location."
},
"estimatedPickupDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that CHR estimates that the container will be picked up by the carrier."
},
"estimatedDeliveryDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that CHR estimates that the container will be delivered to the drop-off location."
},
"actualPickupDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the container was be picked up by the carrier."
},
"lastFreeDay": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The last day that the container can reside at the destination port without incurring demurrage fees."
},
"actualDeliveryDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the container was delivered to the drop-off location."
},
"lastFreeDayForEmptyReturn": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The last day that the empty container can be returned to the destination port without incurring demurrage fees."
},
"emptyPickupDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that the empty container was picked up from the drop-off location."
},
"emptyReturnDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date-time that the empty container was returned to the destination port."
}
}
},
"globalForwardingContainerTypeEnum": {
"type": [
"string",
"null"
],
"enum": [
"20FR",
"20FT",
"20IT",
"20OT",
"20RF",
"40FR",
"40FT",
"40HC",
"40OT",
"40RF",
"40RH",
"45HC",
"45TR",
"48TR",
"53TR"
]
},
"globalForwardingCustoms": {
"description": "This represents customs entries.",
"type": "object",
"properties": {
"auCustoms": {
"$ref": "#/$defs/globalForwardingAuCustoms"
},
"nzCustoms": {
"$ref": "#/$defs/globalForwardingNzCustoms"
}
}
},
"globalForwardingCustomsEntry": {
"description": "The customs entry for the shipment.",
"type": "object",
"properties": {
"entryNumber": {
"description": "The entry number of the cargo release customs entry.",
"type": [
"string",
"null"
]
},
"status": {
"description": "The status of the cargo release customs entry.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingCustomsEntryStatusEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownCustomsEntryStatusValue"
}
]
},
"releaseDate": {
"description": "The release date of the cargo release customs entry.",
"type": [
"string",
"null"
],
"format": "date-time"
},
"usCustomsEntry": {
"$ref": "#/$defs/globalForwardingUsCustomsEntry"
}
}
},
"globalForwardingCustomsEntryStatusEnum": {
"type": "string",
"enum": [
"Pending",
"Intensive Exam",
"Admissible",
"NotReleased",
"DocumentRequired",
"RequiresBrokerReview",
"Cancelled",
"Released"
]
},
"globalForwardingEventTypeEnum": {
"type": "string",
"description": "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 receive the events you are interested in.\n",
"enum": [
"SHIPMENT CREATED",
"SHIPMENT BOOKED",
"SHIPMENT CANCELLED",
"CONTAINER CREATED",
"CONTAINER CANCELLED",
"CONTAINER UPDATED",
"SHIPMENT ESTIMATED DELIVERY DATE CHANGED",
"ESTIMATED DELIVERY DATE CHANGED",
"ESTIMATED TIME OF VESSEL DEPARTURE CHANGED",
"ESTIMATED TIME OF VESSEL ARRIVAL CHANGED",
"ESTIMATED TIME OF VESSEL ARRIVAL/DEPARTURE CHANGED",
"ESTIMATED TIME OF FLIGHT DEPARTURE CHANGED",
"ESTIMATED TIME OF FLIGHT ARRIVAL CHANGED",
"ESTIMATED TIME OF FLIGHT ARRIVAL/DEPARTURE CHANGED",
"ESTIMATED ARRIVAL TO DESTINATION RAIL CHANGED",
"ARRIVED AT PICKUP",
"CARGO PICKED UP",
"ARRIVED AT ORIGIN RAMP",
"DEPARTED FROM ORIGIN RAMP",
"ARRIVED AT ORIGIN TERMINAL",
"DEPARTED FROM ORIGIN TERMINAL",
"IN GATE AT ORIGIN PORT",
"VESSEL DEPARTED FROM ORIGIN PORT",
"FLIGHT DEPARTED FROM ORIGIN AIRPORT",
"VESSEL ARRIVED AT INTERMEDIARY PORT",
"FLIGHT ARRIVED AT INTERMEDIARY AIRPORT",
"VESSEL DEPARTED FROM INTERMEDIARY PORT",
"FLIGHT DEPARTED FROM INTERMEDIARY AIRPORT",
"VESSEL ARRIVED AT DESTINATION PORT",
"FLIGHT ARRIVED AT DESTINATION AIRPORT",
"OUT GATE FROM DESTINATION PORT",
"DEPARTED FROM DESTINATION AIRPORT",
"ARRIVED AT DESTINATION TERMINAL",
"DEPARTED FROM DESTINATION TERMINAL",
"ARRIVED AT DESTINATION RAMP",
"DEPARTED FROM DESTINATION RAMP",
"ARRIVED AT FINAL DESTINATION",
"CARGO DELIVERED",
"EMPTY CONTAINER RETURNED",
"CUSTOMS PENDING",
"CUSTOMS CANCELLED",
"CUSTOMS NOT RELEASED",
"CUSTOMS INTENSIVE EXAM",
"CUSTOMS ADMISSIBLE",
"CUSTOMS DOCUMENT REQUIRED",
"CUSTOMS REQUIRES BROKER REVIEW",
"PGA RELEASED",
"CUSTOMS RELEASED",
"SHIPMENT UPDATED"
]
},
"globalForwardingFlight": {
"description": "A flight that is used to transport the shipment.",
"type": [
"object",
"null"
],
"properties": {
"flightNumber": {
"description": "The number of the flight.",
"type": [
"string",
"null"
]
},
"sequence": {
"description": "The order of the flight in the list of flights.",
"type": "integer"
},
"fromAirport": {
"$ref": "#/$defs/globalForwardingFromAirport"
},
"toAirport": {
"$ref": "#/$defs/globalForwardingToAirport"
}
}
},
"globalForwardingFreightTermsEnum": {
"description": "* Prepaid: The shipper pays for the freight charges. * Collect: The customer/consignee pays for the freight charges.\n",
"type": [
"string",
"null"
],
"enum": [
"Prepaid",
"Collect"
]
},
"globalForwardingFromAirport": {
"allOf": [
{
"$ref": "#/$defs/globalForwardingLocation"
},
{
"type": [
"object",
"null"
],
"description": "The airport that the flight departs from.",
"properties": {
"estimatedDepartureDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The estimated date-time that the flight will depart from the airport."
},
"actualDepartureDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the flight departed from the airport."
}
}
}
]
},
"globalForwardingIncoTermsEnum": {
"type": [
"string",
"null"
],
"enum": [
"Ex-Works",
"Free Carrier",
"Free Alongside Ship",
"Free On-Board Vessel",
"Cost & Freight",
"Cost Insurance & Freight",
"Carriage Paid To",
"Carriage & Insurance Paid To",
"Delivery At Frontier",
"Delivered Ex-Ship",
"Delivered Ex-Quay, Duty Unpaid",
"Delivered Duty Unpaid",
"Delivered Duty Paid",
"Delivered at Place",
"Delivered at Terminal",
"Delivered at Place Unloaded"
]
},
"globalForwardingLocation": {
"type": "object",
"properties": {
"name": {
"description": "The name of the location.",
"type": [
"string",
"null"
]
},
"locationCode": {
"description": "The standard location code for this stop. For example, this may be an port code or an IATA airport code.\n",
"type": [
"string",
"null"
]
},
"unlocode": {
"description": "The UN/LOCODE of the location.",
"type": [
"string",
"null"
]
},
"address": {
"$ref": "#/$defs/globalForwardingAddress"
}
}
},
"globalForwardingModeEnum": {
"type": "string",
"enum": [
"Ocean",
"Air"
]
},
"globalForwardingNzCustoms": {
"description": "This represents the customs entries for New Zealand.",
"type": "object",
"properties": {
"n10": {
"$ref": "#/$defs/globalForwardingNzCustomsN10"
}
}
},
"globalForwardingNzCustomsN10": {
"description": "This represents the N10 document for a New Zealand customs entry.",
"type": "object",
"properties": {
"dateOfClearance": {
"description": "The date customs was cleared.",
"type": [
"string",
"null"
],
"format": "date"
},
"entryNumber": {
"description": "A unique identifier assigned to an import declaration or customs entry.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Represents the current status of the customs process for imported goods.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingNzCustomsStatusEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownNzCustomsStatusValue"
}
]
}
}
},
"globalForwardingNzCustomsStatusEnum": {
"type": "string",
"description": "This represents a New Zealand customs statuses that have been implemented and available for use.\n",
"enum": [
"Cleared"
]
},
"globalForwardingOceanMainlineCarrier": {
"description": "The mainline carrier that transports the shipment over the ocean.",
"type": [
"object",
"null"
],
"properties": {
"carrierName": {
"description": "The name of the mainline carrier.",
"type": [
"string",
"null"
]
},
"carrierScac": {
"description": "The SCAC code of the mainline carrier.",
"type": [
"string",
"null"
]
},
"vesselImo": {
"description": "The International Maritime Organization (IMO) number of the vessel.",
"type": [
"string",
"null"
]
},
"vesselName": {
"description": "The name of the vessel.",
"type": [
"string",
"null"
]
},
"voyageNumber": {
"description": "A unique identifier for the voyage.",
"type": [
"string",
"null"
]
},
"bookingNumber": {
"description": "A unique identifier for the booking.",
"type": [
"string",
"null"
]
}
}
},
"globalForwardingOceanShipment": {
"description": "When this shipment is an ocean shipment, this object will contain ocean shipment details.\n",
"type": [
"object",
"null"
],
"properties": {
"houseBillNumber": {
"description": "The number of the House Bill of Lading (HBL) issued by the NVOCC.",
"type": [
"string",
"null"
]
},
"masterBillNumber": {
"description": "The number of the Master Bill of Lading (MBL) issued by the carrier.",
"type": [
"string",
"null"
]
},
"oceanMainlineCarrier": {
"$ref": "#/$defs/globalForwardingOceanMainlineCarrier"
},
"containers": {
"description": "A list of containers transported by the shipment.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingContainer"
}
},
"estimatedVesselDepartureDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The estimated date-time that the vessel will depart from the origin port."
},
"actualVesselDepartureDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the vessel departed from the origin port."
},
"estimatedVesselArrivalDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The estimated date-time that the vessel will arrive at the destination port."
},
"actualVesselArrivalDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the vessel arrived at the destination port."
}
}
},
"globalForwardingPgaStatus": {
"description": "The status of the Partner Government Agency (PGA) release for the cargo.",
"type": "object",
"properties": {
"agency": {
"description": "The Partner Government Agency (PGA) that is responsible for the release.",
"type": "string"
},
"status": {
"description": "The status of the PGA release.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingPgaStatusEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownPgaStatusValue"
}
]
},
"releaseDate": {
"description": "The release date of the Partner Government Agency (PGA).",
"type": [
"string",
"null"
],
"format": "date"
},
"wasReleased": {
"description": "`true` if the cargo was released by the Partner Government Agency (PGA).",
"type": "boolean"
}
}
},
"globalForwardingPgaStatusEnum": {
"type": "string",
"enum": [
"Ex-Works",
"Free Carrier",
"Free Alongside Ship",
"Free On-Board Vessel",
"Cost & Freight",
"Cost Insurance & Freight",
"Carriage Paid To",
"Carriage & Insurance Paid To",
"Delivery At Frontier",
"Delivered Ex-Ship",
"Delivered Ex-Quay, Duty Unpaid",
"Delivered Duty Unpaid",
"Delivered Duty Paid",
"Delivered at Place",
"Delivered at Terminal",
"Delivered at Place Unloaded"
]
},
"globalForwardingQuantity": {
"type": "object",
"properties": {
"value": {
"type": "number",
"format": "decimal"
},
"unitOfMeasure": {
"description": "The unit of measure for the quantity.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingUnitOfMeasureEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownUnitOfMeasureValue"
}
]
}
}
},
"globalForwardingServiceLevelEnum": {
"type": "string",
"enum": [
"Door to Door",
"Port to Port",
"Door to Destination Port",
"Door to Destination Ramp",
"Door to Destination Terminal",
"Origin Port to Door",
"Origin Port to Destination Ramp",
"Origin Port to Destination Terminal",
"Origin Ramp to Door",
"Origin Ramp to Destination Port",
"Origin Ramp to Destination Ramp",
"Origin Terminal to Destination Port",
"Origin Terminal to Door",
"Origin Terminal to Destination Terminal",
"Origin Ramp to Destination Terminal",
"Origin Terminal to Destination Ramp",
"Door to Destination Airport",
"Origin Airport To Door",
"Origin Airport To Destination Airport",
"Origin Airport To Destination Terminal",
"Origin Terminal To Destination Airport"
]
},
"globalForwardingShipmentEvent": {
"type": "object",
"description": "Represents a Global Forwarding shipment event.",
"properties": {
"eventType": {
"description": "The type of event that occurred on the shipment.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingEventTypeEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownEventTypeValue"
}
]
},
"shipmentNumber": {
"description": "A unique identifier for this shipment. This value is generated by CHR.",
"type": "string"
},
"agentReferenceNumber": {
"description": "A unique identifier for this shipment. This value is supplied to CHR by the agent.",
"type": [
"string",
"null"
]
},
"customerReferenceNumber": {
"description": "A unique identifier for this shipment. This value is supplied to CHR by the customer.",
"type": [
"string",
"null"
]
},
"shipmentType": {
"description": "The type of shipment.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingShipmentTypeEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownShipmentTypeValue"
}
]
},
"purchaseOrderNumbers": {
"description": "Purchase order numbers associated with the shipment.",
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"servicesProvidedByChr": {
"description": "The services provided by CHR for this shipment. For example, CHR may only provide Freight Forwarding services (in which case, this array would have only one elemnt). CHR may also provide Customs Brokerage services in addition (in which case, this array would have two elements -- one for each service).\n",
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/$defs/globalForwardingChrServiceEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownChrServiceValue"
}
]
}
},
"serviceLevel": {
"description": "The extent of service provided by CHR for this shipment. For example, CHR may be responsible for the entire shipment from origin warehouse to the destination warehouse, or only from the origin port to the destination port.\n",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingServiceLevelEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownServiceLevelValue"
}
]
},
"mode": {
"description": "The mode of transportation for the shipment.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingModeEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownModeValue"
}
]
},
"status": {
"description": "The current status of the shipment.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingShipmentStatusEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownShipmentStatusValue"
}
]
},
"incoLocation": {
"description": "The location where the IncoTerms apply.",
"type": "string"
},
"incoTerms": {
"description": "The International Commercial Terms (IncoTerms) that apply to the shipment.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingIncoTermsEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownIncoTermsValue"
}
]
},
"freightTerms": {
"description": "The freight terms that apply to the shipment.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingFreightTermsEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownFreightTermsValue"
}
]
},
"customer": {
"type": "object",
"properties": {
"name": {
"description": "The name of this entity.",
"type": "string"
}
},
"description": "The customer that requested this shipment."
},
"shipper": {
"type": "object",
"properties": {
"name": {
"description": "The name of this entity.",
"type": "string"
}
},
"description": "The shipper CHR has contracted with to transport the shipment."
},
"consignee": {
"type": "object",
"properties": {
"name": {
"description": "The name of this entity.",
"type": "string"
}
},
"description": "The consignee that will receive the shipment."
},
"oceanShipment": {
"$ref": "#/$defs/globalForwardingOceanShipment"
},
"airShipment": {
"$ref": "#/$defs/globalForwardingAirShipment"
},
"shipmentCreatedDate": {
"description": "The date-time that the shipment was created.",
"type": "string",
"format": "date-time"
},
"estimatedCargoReadyDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The date that the supplier estimates the cargo will be ready for pickup. The date is in the pick-up location's local time zone.\n"
},
"estimatedDeliverByDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The estimated date by which CHR estimates the shipment will be delivered. The date is in the drop off location's local time zone.\n"
},
"customsEntry": {
"$ref": "#/$defs/globalForwardingCustomsEntry"
},
"customs": {
"$ref": "#/$defs/globalForwardingCustoms"
}
}
},
"globalForwardingShipmentStatusEnum": {
"type": "string",
"enum": [
"Financial Only",
"Ordered",
"Consolidated",
"Assigned to Rep",
"Tendered to Carrier",
"Booked",
"Carrier Directed",
"Checked In",
"Waybilled to Railroad",
"Booking Completed",
"Loading",
"Arrived at Terminal",
"Ready for Departure",
"Picked Up",
"Departed from Terminal",
"On the Rail",
"Departed Port or Airport",
"Arrived at Port or Airport",
"In Transit",
"Arrived at Ramp",
"Rail Completed",
"Port or Airport Completed",
"Terminal Completed",
"Unloading",
"Carrier Released",
"Delivered"
]
},
"globalForwardingShipmentTypeEnum": {
"type": "string",
"enum": [
"FCL",
"LCL"
]
},
"globalForwardingStop": {
"allOf": [
{
"$ref": "#/$defs/globalForwardingLocation"
},
{
"type": "object",
"description": "A stop that the shipment will make during its journey.",
"properties": {
"sequenceNumber": {
"description": "The index of this stop in the list of stops of the parent container. Since two containers within the same shipment may have different stops, the sequence number is unique only within a given container.\n",
"type": "integer",
"format": "int32"
},
"stopType": {
"description": "The type of the stop.",
"oneOf": [
{
"$ref": "#/$defs/globalForwardingStopTypeEnum"
},
{
"$ref": "#/$defs/globalForwardingUnknownStopTypeValue"
}
]
},
"estimatedArrivalDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The estimated date-time that the carrier will arrive at this stop."
},
"actualArrivalDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the carrier arrived at this stop."
},
"actualDepartureDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the carrier departed from this stop."
}
}
}
]
},
"globalForwardingStopTypeEnum": {
"description": "Indicates the type of the stop.",
"type": "string",
"enum": [
"Pickup Location",
"Origin Port",
"Origin Airport",
"Origin Terminal",
"Origin Ramp",
"Intermediary Port",
"Intermediary Airport",
"Destination Port",
"Destination Airport",
"Destination Ramp",
"Destination Terminal",
"Drop Location"
]
},
"globalForwardingToAirport": {
"allOf": [
{
"$ref": "#/$defs/globalForwardingLocation"
},
{
"type": [
"object",
"null"
],
"description": "The airport that the flight arrives at.",
"properties": {
"estimatedArrivalDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The estimated date-time that the flight will arrive at the airport."
},
"actualArrivalDate": {
"type": "object",
"properties": {
"currentValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"previousValue": {
"type": [
"string",
"null"
],
"format": "date-time"
},
"hasChanged": {
"type": "boolean",
"readOnly": true
}
},
"description": "The actual date-time that the flight arrived at the airport."
}
}
}
]
},
"globalForwardingUnitOfMeasureEnum": {
"type": [
"string",
"null"
],
"enum": [
"Bale",
"Bin",
"Bottle",
"Bucket",
"Jar",
"Loose",
"Lug",
"Other",
"Reels",
"Sack",
"Skid",
"Skid elevating or lift truck",
"Slip Sheet",
"Intermodal Trailer/Container Load (Rail)",
"Tray",
"Bags",
"Boxes",
"Bundles",
"Cartons",
"Case",
"Crates",
"Dozens",
"Drums",
"Eaches",
"Gaylords",
"Hundred Weight (lbs)",
"Linear Foot",
"Package",
"Pail",
"Pallet",
"Pieces",
"Pounds",
"Roll",
"Totes",
"Yards",
"Skids",
"Gallon",
"Kit",
"Feet",
"Pad",
"Pair",
"Set",
"Sheet",
"Meter",
"Kilogram",
"Intermediate Bulk Container",
"Batch",
"Assortment",
"Cube",
"Racks",
"Packet",
"Thousand",
"24\" Bin",
"30\" Bin",
"36\" Bin",
"40\" Bin",
"Bushel",
"Cellpack",
"DRC",
"ECO Crate",
"EURO Ctn",
"Flat",
"Half Bin",
"Half Ctn",
"Heavy Pack",
"IFCO",
"IFCO 6408",
"IFCO 6411",
"IFCO 6413",
"IFCO 6416",
"IFCO 6419",
"IFCO 6423",
"IFCO 6425",
"IFCO 6428",
"ORBIS",
"ORBIS 6409",
"ORBIS 6411",
"ORBIS 6413",
"ORBIS 6416",
"ORBIS 6419",
"ORBIS 6425",
"ORBIS 6428",
"PL 4311",
"PL 4317",
"PL 6408",
"PL 6411",
"PL 6413",
"PL 6416",
"PL 6419",
"PL 6423",
"PL 6425",
"PL 6428",
"RPC",
"RPC 6411",
"RPC 6413",
"RPC 6416",
"Tension Bin",
"TOSCA",
"TOSCA 6408",
"TOSCA 6411",
"TOSCA 6413",
"TOSCA 6416",
"TOSCA 6419",
"TOSCA 6423",
"TOSCA 6425",
"TOSCA 6428",
"Wood Crate",
"Barrel",
"Rack",
"Tub",
"CARD",
"Display",
"Square Feet",
"Cylinder",
"Keg",
"Pounds-IFCO",
"Pallet (48\"x40\")",
"Pallet (48\"x48\")",
"Pallet (60\"x48\")",
"Carpets",
"Coils",
"Tubes/Pipes",
"Garment on Hanger",
"Bulk",
"Proof of Gallons",
"Liter",
"International Pallet",
"Tank",
"Jug",
"Can",
"Unit Pack",
"Meters Squared",
"Gross",
"Ounces",
"Grams",
"Knockdowns"
]
},
"globalForwardingUnknownAuCustomsStatusValue": {
"description": "This represents a new Australia customs status that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"description": "This represents a Australia customs statuses that have been implemented and available for use.\n",
"enum": [
"Cleared"
]
}
},
"globalForwardingUnknownChrServiceValue": {
"description": "This represents a new service level that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"enum": [
"Non-Vessel Operating Common Carrier",
"Freight Forwarding",
"Air Direct",
"Air House",
"Air Sub House",
"Air Sub Master",
"Customs Brokerage",
"Service Fin Only"
]
}
},
"globalForwardingUnknownContainerTypeValue": {
"description": "This represents a new container type that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": [
"string",
"null"
],
"enum": [
"20FR",
"20FT",
"20IT",
"20OT",
"20RF",
"40FR",
"40FT",
"40HC",
"40OT",
"40RF",
"40RH",
"45HC",
"45TR",
"48TR",
"53TR"
]
}
},
"globalForwardingUnknownCustomsEntryStatusValue": {
"description": "This represents a new customs entry status that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"enum": [
"Pending",
"Intensive Exam",
"Admissible",
"NotReleased",
"DocumentRequired",
"RequiresBrokerReview",
"Cancelled",
"Released"
]
}
},
"globalForwardingUnknownEventTypeValue": {
"description": "This represents a new event type that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"description": "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 receive the events you are interested in.\n",
"enum": [
"SHIPMENT CREATED",
"SHIPMENT BOOKED",
"SHIPMENT CANCELLED",
"CONTAINER CREATED",
"CONTAINER CANCELLED",
"CONTAINER UPDATED",
"SHIPMENT ESTIMATED DELIVERY DATE CHANGED",
"ESTIMATED DELIVERY DATE CHANGED",
"ESTIMATED TIME OF VESSEL DEPARTURE CHANGED",
"ESTIMATED TIME OF VESSEL ARRIVAL CHANGED",
"ESTIMATED TIME OF VESSEL ARRIVAL/DEPARTURE CHANGED",
"ESTIMATED TIME OF FLIGHT DEPARTURE CHANGED",
"ESTIMATED TIME OF FLIGHT ARRIVAL CHANGED",
"ESTIMATED TIME OF FLIGHT ARRIVAL/DEPARTURE CHANGED",
"ESTIMATED ARRIVAL TO DESTINATION RAIL CHANGED",
"ARRIVED AT PICKUP",
"CARGO PICKED UP",
"ARRIVED AT ORIGIN RAMP",
"DEPARTED FROM ORIGIN RAMP",
"ARRIVED AT ORIGIN TERMINAL",
"DEPARTED FROM ORIGIN TERMINAL",
"IN GATE AT ORIGIN PORT",
"VESSEL DEPARTED FROM ORIGIN PORT",
"FLIGHT DEPARTED FROM ORIGIN AIRPORT",
"VESSEL ARRIVED AT INTERMEDIARY PORT",
"FLIGHT ARRIVED AT INTERMEDIARY AIRPORT",
"VESSEL DEPARTED FROM INTERMEDIARY PORT",
"FLIGHT DEPARTED FROM INTERMEDIARY AIRPORT",
"VESSEL ARRIVED AT DESTINATION PORT",
"FLIGHT ARRIVED AT DESTINATION AIRPORT",
"OUT GATE FROM DESTINATION PORT",
"DEPARTED FROM DESTINATION AIRPORT",
"ARRIVED AT DESTINATION TERMINAL",
"DEPARTED FROM DESTINATION TERMINAL",
"ARRIVED AT DESTINATION RAMP",
"DEPARTED FROM DESTINATION RAMP",
"ARRIVED AT FINAL DESTINATION",
"CARGO DELIVERED",
"EMPTY CONTAINER RETURNED",
"CUSTOMS PENDING",
"CUSTOMS CANCELLED",
"CUSTOMS NOT RELEASED",
"CUSTOMS INTENSIVE EXAM",
"CUSTOMS ADMISSIBLE",
"CUSTOMS DOCUMENT REQUIRED",
"CUSTOMS REQUIRES BROKER REVIEW",
"PGA RELEASED",
"CUSTOMS RELEASED",
"SHIPMENT UPDATED"
]
}
},
"globalForwardingUnknownFreightTermsValue": {
"description": "This represents a new freight terms value that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"description": "* Prepaid: The shipper pays for the freight charges. * Collect: The customer/consignee pays for the freight charges.\n",
"type": [
"string",
"null"
],
"enum": [
"Prepaid",
"Collect"
]
}
},
"globalForwardingUnknownIncoTermsValue": {
"description": "This represents a new INCO terms value that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": [
"string",
"null"
],
"enum": [
"Ex-Works",
"Free Carrier",
"Free Alongside Ship",
"Free On-Board Vessel",
"Cost & Freight",
"Cost Insurance & Freight",
"Carriage Paid To",
"Carriage & Insurance Paid To",
"Delivery At Frontier",
"Delivered Ex-Ship",
"Delivered Ex-Quay, Duty Unpaid",
"Delivered Duty Unpaid",
"Delivered Duty Paid",
"Delivered at Place",
"Delivered at Terminal",
"Delivered at Place Unloaded"
]
}
},
"globalForwardingUnknownModeValue": {
"description": "This represents a new mode that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"enum": [
"Ocean",
"Air"
]
}
},
"globalForwardingUnknownNzCustomsStatusValue": {
"description": "This represents a new New Zealand customs status that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"description": "This represents a New Zealand customs statuses that have been implemented and available for use.\n",
"enum": [
"Cleared"
]
}
},
"globalForwardingUnknownPgaStatusValue": {
"description": "This represents a new PGA status value that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"enum": [
"Ex-Works",
"Free Carrier",
"Free Alongside Ship",
"Free On-Board Vessel",
"Cost & Freight",
"Cost Insurance & Freight",
"Carriage Paid To",
"Carriage & Insurance Paid To",
"Delivery At Frontier",
"Delivered Ex-Ship",
"Delivered Ex-Quay, Duty Unpaid",
"Delivered Duty Unpaid",
"Delivered Duty Paid",
"Delivered at Place",
"Delivered at Terminal",
"Delivered at Place Unloaded"
]
}
},
"globalForwardingUnknownServiceLevelValue": {
"description": "This represents a new service level that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"enum": [
"Door to Door",
"Port to Port",
"Door to Destination Port",
"Door to Destination Ramp",
"Door to Destination Terminal",
"Origin Port to Door",
"Origin Port to Destination Ramp",
"Origin Port to Destination Terminal",
"Origin Ramp to Door",
"Origin Ramp to Destination Port",
"Origin Ramp to Destination Ramp",
"Origin Terminal to Destination Port",
"Origin Terminal to Door",
"Origin Terminal to Destination Terminal",
"Origin Ramp to Destination Terminal",
"Origin Terminal to Destination Ramp",
"Door to Destination Airport",
"Origin Airport To Door",
"Origin Airport To Destination Airport",
"Origin Airport To Destination Terminal",
"Origin Terminal To Destination Airport"
]
}
},
"globalForwardingUnknownShipmentStatusValue": {
"description": "This represents a new shipment status that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"enum": [
"Financial Only",
"Ordered",
"Consolidated",
"Assigned to Rep",
"Tendered to Carrier",
"Booked",
"Carrier Directed",
"Checked In",
"Waybilled to Railroad",
"Booking Completed",
"Loading",
"Arrived at Terminal",
"Ready for Departure",
"Picked Up",
"Departed from Terminal",
"On the Rail",
"Departed Port or Airport",
"Arrived at Port or Airport",
"In Transit",
"Arrived at Ramp",
"Rail Completed",
"Port or Airport Completed",
"Terminal Completed",
"Unloading",
"Carrier Released",
"Delivered"
]
}
},
"globalForwardingUnknownShipmentTypeValue": {
"description": "This represents a new shipment type that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": "string",
"enum": [
"FCL",
"LCL"
]
}
},
"globalForwardingUnknownStopTypeValue": {
"description": "This represents a new stop type that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"description": "Indicates the type of the stop.",
"type": "string",
"enum": [
"Pickup Location",
"Origin Port",
"Origin Airport",
"Origin Terminal",
"Origin Ramp",
"Intermediary Port",
"Intermediary Airport",
"Destination Port",
"Destination Airport",
"Destination Ramp",
"Destination Terminal",
"Drop Location"
]
}
},
"globalForwardingUnknownUnitOfMeasureValue": {
"description": "This represents a new unit of measure that has been implemented, but it not yet ready for public consumption.\n",
"type": "string",
"not": {
"type": [
"string",
"null"
],
"enum": [
"Bale",
"Bin",
"Bottle",
"Bucket",
"Jar",
"Loose",
"Lug",
"Other",
"Reels",
"Sack",
"Skid",
"Skid elevating or lift truck",
"Slip Sheet",
"Intermodal Trailer/Container Load (Rail)",
"Tray",
"Bags",
"Boxes",
"Bundles",
"Cartons",
"Case",
"Crates",
"Dozens",
"Drums",
"Eaches",
"Gaylords",
"Hundred Weight (lbs)",
"Linear Foot",
"Package",
"Pail",
"Pallet",
"Pieces",
"Pounds",
"Roll",
"Totes",
"Yards",
"Skids",
"Gallon",
"Kit",
"Feet",
"Pad",
"Pair",
"Set",
"Sheet",
"Meter",
"Kilogram",
"Intermediate Bulk Container",
"Batch",
"Assortment",
"Cube",
"Racks",
"Packet",
"Thousand",
"24\" Bin",
"30\" Bin",
"36\" Bin",
"40\" Bin",
"Bushel",
"Cellpack",
"DRC",
"ECO Crate",
"EURO Ctn",
"Flat",
"Half Bin",
"Half Ctn",
"Heavy Pack",
"IFCO",
"IFCO 6408",
"IFCO 6411",
"IFCO 6413",
"IFCO 6416",
"IFCO 6419",
"IFCO 6423",
"IFCO 6425",
"IFCO 6428",
"ORBIS",
"ORBIS 6409",
"ORBIS 6411",
"ORBIS 6413",
"ORBIS 6416",
"ORBIS 6419",
"ORBIS 6425",
"ORBIS 6428",
"PL 4311",
"PL 4317",
"PL 6408",
"PL 6411",
"PL 6413",
"PL 6416",
"PL 6419",
"PL 6423",
"PL 6425",
"PL 6428",
"RPC",
"RPC 6411",
"RPC 6413",
"RPC 6416",
"Tension Bin",
"TOSCA",
"TOSCA 6408",
"TOSCA 6411",
"TOSCA 6413",
"TOSCA 6416",
"TOSCA 6419",
"TOSCA 6423",
"TOSCA 6425",
"TOSCA 6428",
"Wood Crate",
"Barrel",
"Rack",
"Tub",
"CARD",
"Display",
"Square Feet",
"Cylinder",
"Keg",
"Pounds-IFCO",
"Pallet (48\"x40\")",
"Pallet (48\"x48\")",
"Pallet (60\"x48\")",
"Carpets",
"Coils",
"Tubes/Pipes",
"Garment on Hanger",
"Bulk",
"Proof of Gallons",
"Liter",
"International Pallet",
"Tank",
"Jug",
"Can",
"Unit Pack",
"Meters Squared",
"Gross",
"Ounces",
"Grams",
"Knockdowns"
]
}
},
"globalForwardingUsCustomsEntry": {
"description": "The US customs entry for the shipment.",
"type": "object",
"properties": {
"pgaStatuses": {
"description": "The status of the Partner Government Agency (PGA) release for the cargo release customs entry.",
"type": "array",
"uniqueItems": true,
"items": {
"$ref": "#/$defs/globalForwardingPgaStatus"
}
}
}
},
"hazardousGroupEnum": {
"type": "string",
"description": "Dangerous goods are assigned into 3 packing groups (also known as UN Packing Group) in accordance with the degree of danger they present.\n * `I` - Group I - Major Danger\n * `II` - Group II - Medium Danger\n * `III` - Group III - Minor Danger\n",
"enum": [
"I",
"II",
"III"
]
},
"hazmatCodeEnum": {
"type": "string",
"description": "Defines the authorizing entity:\n * `C` - HazMat Canadian Regulatory Authority Codes\n * `D` - HazMat US Regulatory Authority Codes\n * `I` - HazMat MX/International Regulatory Authority Codes\n",
"enum": [
"C",
"D",
"I"
]
},
"inTransitAddress": {
"type": "object",
"description": "Contains address information",
"properties": {
"city": {
"type": "string",
"description": "City name of address."
},
"stateProvinceCode": {
"$ref": "#/$defs/stateProvinceCodeEnum"
},
"country": {
"$ref": "#/$defs/countryCodeEnum"
},
"latitude": {
"type": "number",
"format": "float",
"minimum": -90,
"maximum": 90,
"description": "The latitude of reported update in decimal format."
},
"longitude": {
"type": "number",
"format": "float",
"minimum": -180,
"maximum": 180,
"description": "The longitude of reported update in decimal format."
}
}
},
"inTransitEvent": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "A periodic location update during the transport cycle of the shipment.\n* `IN TRANSIT` - An update indicating the shipment is in transit between stops.\n* `IN TRANSIT TO ORIGIN` - An update indicating the shipment is in transit to the origin stop.",
"enum": [
"IN TRANSIT",
"IN TRANSIT TO ORIGIN"
]
},
"orderDetails": {
"type": "array",
"description": "Contains order number and order tracking information.",
"items": {
"$ref": "#/$defs/orderDetail"
}
},
"loadNumber": {
"type": "integer",
"description": "C.H. Robinson defined shipment number."
},
"carrier": {
"$ref": "#/$defs/carrier"
},
"location": {
"$ref": "#/$defs/inTransitAddress"
},
"loadStops": {
"type": "array",
"description": "An array that offers all stops on the load with key stop details.",
"items": {
"$ref": "#/$defs/loadStopInformation"
}
},
"items": {
"type": "array",
"description": "Items associated to this shipment.",
"items": {
"$ref": "#/$defs/bookedItem"
}
},
"deliveryEta": {
"type": "string",
"description": "The date/time in ISO8601 UTC format of the delivery ETA."
},
"nextStop": {
"$ref": "#/$defs/inTransitNextStop"
},
"loadDetails": {
"$ref": "#/$defs/loadDetails"
},
"notes": {
"type": "string",
"description": "Any additional information from the user or Carrier."
}
}
},
"inTransitNextStop": {
"type": "object",
"description": "Contains stop information",
"properties": {
"eta": {
"type": "string",
"description": "The date/time in ISO8601 UTC format of ETA at the stop."
},
"stopId": {
"type": "string",
"description": "A C.H. Robinson identifier for the specific stop."
},
"stopType": {
"type": "string",
"description": "Stop type. \\n- 'P' - Pick \\n- 'D' - Drop \\n- 'X' - Cross Dock",
"enum": [
"P",
"D",
"X"
]
},
"city": {
"type": "string",
"description": "City name for the stop."
},
"state": {
"type": "string",
"description": "The state abbreviation for the stop."
}
}
},
"invoiceMethodEnum": {
"type": "string",
"description": "Method which customer will be invoiced.\n * `PP` - Pre-Paid\n * `CL` - Collect\n * `TP` - Third Party\n * `PC` - Pre-Paid and Add\n * `CC` - Credit Card\n",
"enum": [
"PP",
"CL",
"TP",
"PC",
"CC"
]
},
"lateCodeEnum": {
"type": "string",
"description": "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: \n* `1` - Missed Delivery - Transportation carrier missed customer delivery\n* `3` - Returned to Shipper\n* `9` - Mechanical breakdown\n* `14` - Weather or Natural Disaster Related - Shipment delayed by natural disaster or severe weather\n\nFor a detailed description of all enumerated codes please find them here.",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"31",
"32",
"33",
"34",
"35",
"36",
"37",
"38",
"39",
"40",
"41",
"42",
"43",
"44",
"45",
"46",
"47",
"48",
"49",
"50",
"51",
"52",
"53",
"54",
"55",
"56",
"57",
"58",
"59",
"60",
"61",
"62",
"63",
"64",
"65",
"66",
"67",
"68",
"69",
"70",
"71",
"72",
"73",
"74",
"75",
"76",
"77",
"78",
"79",
"80",
"81",
"82",
"83",
"84",
"85",
"86",
"87",
"88",
"89",
"90",
"CSC",
"CSCCHR",
"91",
"92",
"AE",
"BH",
"BO",
"CA",
"CR",
"CSCCAR",
"CSCCUS",
"CSCEDI",
"CSCREQ",
"CSCWEA",
"DR",
"EE",
"MA",
"ME",
"VI",
"WR",
"93",
"94",
"95",
"96",
"97",
"98",
"99",
"100",
"0"
]
},
"linearUomEnum": {
"type": "string",
"description": "Unit of measure for height, width, and length parameters.",
"enum": [
"Inches",
"Feet",
"Centimeters",
"Meters"
]
},
"loadDetails": {
"type": "object",
"description": "Contains load specific information and reference numbers.",
"properties": {
"loadNumber": {
"type": "integer",
"description": "C.H. Robinson defined shipment number."
},
"referenceNumbers": {
"type": "array",
"description": "Load level reference numbers.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"loadEvent": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "Load level events. \n* `LOAD CREATED` - A shipment has been created in our execution system. \n* `LOAD BOOKED` - Carrier has been selected to transport the shipment.\n* `LOAD CANCELLED` - The load has been cancelled. \n* `PRO NUMBER ADDED` - Pro Number has been added to the shipment.",
"enum": [
"LOAD CREATED",
"LOAD BOOKED",
"LOAD CANCELLED",
"PRO NUMBER ADDED"
]
},
"orderDetails": {
"type": "array",
"description": "Contains order number and order tracking information.",
"items": {
"$ref": "#/$defs/loadEventOrderDetail"
}
},
"loadNumber": {
"type": "integer",
"description": "C.H. Robinson defined shipment number."
},
"equipmentType": {
"type": "string",
"description": "Indicates the equipment type."
},
"mode": {
"type": "string",
"description": "Indicates the mode of the shipment.",
"enum": [
"Truckload",
"LTL Linehaul",
"Small Parcel",
"Bulk Transportation",
"Intermodal Linehaul",
"Intermodal Pickup Drayage",
"Intermodal Delivery Drayage",
"Intermodal Cross Town Dray"
]
},
"serviceOffering": {
"type": "string",
"description": "Indicates the level of service associated to the shipment.",
"enum": [
"LTL Transportation",
"Truckload Transportation",
"Consolidated Transportation",
"Truckload Temp Controlled Transportation",
"Truckload Flatbed Transportation",
"Small Parcel",
"LTL Temp Controlled Transportation",
"Consolidated Temp Controlled Transportation",
"LTL Europe",
"Produce Truckload Temp Controlled Transportation",
"Intermodal Full Container Transportation",
"International Ocean NVOCC",
"Produce LTL Temp Controlled Transportation",
"Domestic Air Transportation",
"Bulk Transportation",
"Ocean",
"Truckload Tautliner Europe",
"Broker - Inventory Freight",
"International Air House",
"Produce Consolidation Temp Controlled Transportation",
"Intermodal Full Temp Controlled Transportation",
"LTL Flatbed Transportation",
"Truckload Europe Box",
"Truckload Bulk Europe",
"International Air Direct",
"Intermodal Europe",
"Tautliner",
"Broker Produce Freight Partial Dry Van"
]
},
"readyByDate": {
"type": "string",
"format": "date-time",
"description": "Earliest date, local to location, carrier can pick up the shipment."
},
"pickupByDate": {
"type": "string",
"format": "date-time",
"description": "Latest date, local to location, carrier can pick up the shipment."
},
"deliveryAvailableByDate": {
"type": "string",
"format": "date-time",
"description": "Earliest date, local to location, carrier can deliver the shipment."
},
"deliveryByDate": {
"type": "string",
"format": "date-time",
"description": "Latest date, local to location, carrier can deliver the shipment."
},
"proposedCarrier": {
"$ref": "#/$defs/proposedCarrier"
},
"billTos": {
"type": "array",
"description": "Customer billTos associated to this shipment.",
"items": {
"$ref": "#/$defs/bookedBillTo"
}
},
"customers": {
"type": "array",
"description": "Customers associated to this shipment.",
"items": {
"$ref": "#/$defs/bookedCustomer"
}
},
"carrier": {
"$ref": "#/$defs/carrier"
},
"locations": {
"type": "array",
"description": "Locations associated to this shipment.",
"items": {
"$ref": "#/$defs/bookedLocation"
}
},
"items": {
"type": "array",
"description": "Items associated to this shipment.",
"items": {
"$ref": "#/$defs/bookedItem"
}
},
"packages": {
"type": "array",
"description": "List of packages associated to the shipment.",
"items": {
"$ref": "#/$defs/eventLoadPackage"
}
}
}
},
"loadEventOrderDetail": {
"type": "object",
"description": "Contains order number and order tracking information.",
"properties": {
"orderNumber": {
"type": "integer",
"description": "C.H. Robinsons defined order number."
},
"customerReferenceNumber": {
"type": "string",
"description": "Primary customer reference number."
},
"billToReferenceNumber": {
"type": "string",
"description": "Primary customer bill to reference number. Often the customer's order number."
},
"customerOrderReferenceNumber": {
"type": "string",
"description": "Primary customer order reference number."
},
"navisphereTrackingNumber": {
"type": "string",
"description": "C.H. Robinson reference number that allows you to track your order through Navisphere® Online."
},
"navisphereTrackingLink": {
"type": "string",
"description": "Link that takes user straight to the Navisphere® Online webpage for the order's tracking information."
},
"referenceNumbers": {
"type": "array",
"description": "Reference numbers associated to this item.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
},
"ordersPlannedOnLoad": {
"type": "array",
"description": "List of C.H. Robinson defined customer order numbers included on this load.",
"items": {
"$ref": "#/$defs/orderNumber"
}
}
}
},
"loadStopInformation": {
"type": "object",
"description": "Stop information specific to the load.",
"properties": {
"stopType": {
"type": "string",
"description": "Identifies the type of stop the location is."
},
"stopStyle": {
"type": "string",
"description": "Identifies the style of the stop."
},
"stopSequenceNumber": {
"type": "integer",
"description": "Number to indicate where in the order of stops the location is. C.H. Robinson uses a zero index. This means the \"0\" will indicate the first stop in the sequence of stops."
},
"warehouseCode": {
"type": "string",
"description": "The C.H. Robinson code for the warehouse at the stop."
}
}
},
"marinePollutantCategory": {
"type": "string",
"description": "Indicates the Marine Pollutant Category for Hazardous Materials.\n * `Severe Marine Pollutant`\n * `Marine Pollutant`\n",
"enum": [
"SevereMarinePollutant",
"MarinePollutant"
]
},
"orderDetail": {
"type": "object",
"description": "Contains order number and order tracking information.",
"properties": {
"orderNumber": {
"type": "integer",
"description": "C.H. Robinsons defined order number."
},
"customerReferenceNumber": {
"type": "string",
"description": "Primary customer reference number."
},
"billToReferenceNumber": {
"type": "string",
"description": "Primary customer bill to reference number. Often the customer's order number."
},
"customerOrderReferenceNumber": {
"type": "string",
"description": "Primary customer order reference number."
},
"navisphereTrackingNumber": {
"type": "string",
"description": "C.H. Robinson reference number that allows you to track your order through Navisphere® Online."
},
"navisphereTrackingLink": {
"type": "string",
"description": "Link that takes user straight to the Navisphere® Online webpage for the order's tracking information."
},
"referenceNumbers": {
"type": "array",
"description": "Reference numbers associated to this item.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"orderEvent": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "Indicates the type of order event.\n* ORDER CREATED - Order has been created in the C.H. Robinson system. This event should be listened to as confirmation the order has successfully been created in Navisphere® Order Management System.\n* ORDER UPDATE - An update has occured on the order. \n* ORDER CANCELED - The order has been canceled. \n* ORDER REJECTED - The order was rejected and will not continue processing. \n* ORDER COMPLETED - All loads associated to the order have been delivered and order is complete.",
"enum": [
"ORDER CREATED",
"ORDER REJECTED",
"ORDER UPDATED",
"ORDER CANCELED",
"ORDER COMPLETED"
]
},
"eventSubType": {
"type": "string",
"description": "Indicates the sub type of order updated event. This is only applicable for Order Updated events, and must be subscribed to individually. Events consumers are automatically opted into 'ORDER UPDATE', which indicates when the service is planned or the service is booked.",
"enum": [
"ORDER UPDATE",
"ADD ITEM DETAILS",
"REMOVE ITEM DETAILS",
"UPDATE ITEM DETAILS",
"ADD PARTY",
"UPDATE PARTY",
"REMOVE PARTY",
"UPDATE PLAN",
"CREATE PLAN",
"REMOVE PLAN",
"UPDATE ORDER STATUS",
"UPDATE ORIGIN DATE",
"UPDATE DELIVERY DATE",
"UPDATE REFERENCE NUMBER"
]
},
"orderDetail": {
"type": "array",
"description": "Contains order number and order tracking information.",
"items": {
"$ref": "#/$defs/orderEventOrderDetail"
}
},
"loadNumbers": {
"type": "array",
"description": "C.H. Robinson defined shipment number(s) tied to this order.",
"items": {
"type": "integer"
}
},
"referenceNumbers": {
"type": "array",
"description": "Any additional reference numbers that are contained on the order.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"orderEventItem": {
"type": "object",
"description": "Items tied to the service.",
"properties": {
"packagingType": {
"$ref": "#/$defs/packageCodeEnum"
},
"description": {
"type": "string",
"description": "Customer defined description of the item in the order (product name)."
},
"productCode": {
"type": "string",
"description": "Customer defined code of the item in the order."
},
"freightClass": {
"$ref": "#/$defs/freightClassEnum"
},
"upcNumber": {
"type": "string",
"description": "UPC number number of the item."
},
"skuNumber": {
"type": "string",
"description": "sku number of the item."
},
"pluNumber": {
"type": "string",
"description": "plu number of the item."
},
"insuranceValue": {
"type": "number",
"format": "float",
"description": "Insurance valuation of item."
},
"minWeight": {
"type": "number",
"format": "float",
"description": "The minimum weight of the item."
},
"minWeightUnitOfMeasure": {
"$ref": "#/$defs/weightUomEnum"
},
"maxWeight": {
"type": "number",
"format": "float",
"description": "The minimum weight of the item."
},
"maxWeightUnitOfMeasure": {
"$ref": "#/$defs/weightUomEnum"
},
"length": {
"type": "number",
"format": "float",
"description": "Length of the item."
},
"lengthUnitOfMeasure": {
"$ref": "#/$defs/linearUomEnum"
},
"height": {
"type": "number",
"format": "float",
"description": "Height of the item."
},
"heightUnitOfMeasure": {
"$ref": "#/$defs/linearUomEnum"
},
"width": {
"type": "number",
"format": "float",
"description": "Width of the item."
},
"widthUnitOfMeasure": {
"$ref": "#/$defs/linearUomEnum"
},
"volume": {
"type": "number",
"format": "float",
"description": "Volume of the item."
},
"volumeUnitOfMeasure": {
"$ref": "#/$defs/volumeUomEnum"
},
"pallets": {
"type": "number",
"format": "float",
"description": "Number of pallets for the item."
},
"palletSpaces": {
"type": "number",
"format": "float",
"description": "Amount of pallet space the item takes up."
},
"trailerLengthUsed": {
"type": "number",
"format": "float",
"description": "Trailer feet the item takes up."
},
"trailerLengthUsedUnitOfMeasure": {
"$ref": "#/$defs/linearUomEnum"
},
"referenceNumbers": {
"type": "array",
"description": "Any additional reference numbers that are contained on the order.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
},
"isHazardous": {
"type": "boolean",
"description": "Indicates whether the item is hazardous or not."
},
"hazardousProperties": {
"$ref": "#/$defs/ordersEventsHazardousProperties"
}
}
},
"orderEventLocation": {
"type": "object",
"description": "Location information specific to the service.",
"properties": {
"chrLocationId": {
"type": "string",
"description": "C.H. Robinson defined location identifier."
},
"customerLocationId": {
"type": "string",
"description": "Customer generated location identifier."
},
"type": {
"$ref": "#/$defs/orderEventLocationType"
},
"style": {
"$ref": "#/$defs/orderEventLocationStyle"
},
"name": {
"type": "string",
"description": "Name of the location."
},
"address": {
"$ref": "#/$defs/eventAddress"
},
"referenceNumbers": {
"type": "array",
"description": "Any additional reference numbers that are specific to the stop.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"orderEventLocationStyle": {
"type": "string",
"description": "identifies the style of the stop.",
"enum": [
"Customers",
"Distributor",
"Warehouse",
"Plant",
"Pool",
"CrossDock",
"WarehouseSpecial",
"Agent",
"Terminal",
"RailRamp",
"Port"
]
},
"orderEventLocationType": {
"type": "string",
"description": "Identifies the type of stop the location is.",
"enum": [
"Pick",
"Drop",
"Intermediate",
"OriginPort",
"DestinationPort",
"IntermediatePort"
]
},
"orderEventMode": {
"type": "string",
"description": "Identifies the mode of the service.",
"enum": [
"Van",
"TemperatureControlled",
"Flatbed",
"Tank",
"Hopper",
"LessThanTruckload",
"LessThanTruckloadTemperatureControlled",
"LessThanTruckloadFlatbed",
"Parcel",
"HeavyAir",
"Carload",
"Intermodal",
"AllModes",
"Consolidation",
"ConsolidatedTemperatureControlled",
"Bulk",
"IntermodalTemperatureControlled",
"Air",
"Ocean",
"Tautliner"
]
},
"orderEventOrderDetail": {
"type": "object",
"description": "Contains order number and order tracking information.",
"properties": {
"navisphereTrackingNumber": {
"type": "string",
"description": "C.H. Robinson reference number that allows you to track your order through Navisphere® Online."
},
"navisphereTrackingLink": {
"type": "string",
"description": "Link that takes user straight to the Navisphere® Online webpage for the order's tracking information."
},
"orderNumber": {
"type": "integer",
"description": "C.H. Robinsons defined order number."
},
"condition": {
"$ref": "#/$defs/condition"
},
"services": {
"type": "array",
"description": "Services associated to this event.",
"items": {
"$ref": "#/$defs/orderEventService"
}
}
}
},
"orderEventService": {
"type": "object",
"properties": {
"condition": {
"$ref": "#/$defs/condition"
},
"mode": {
"$ref": "#/$defs/orderEventMode"
},
"description": {
"type": "string",
"description": "The description of the mode.",
"enum": [
"LTL Transportation",
"Truckload Transportation",
"Consolidated Transportation",
"Truckload Temp Controlled Transportation",
"Truckload Flatbed Transportation",
"Small Parcel",
"LTL Temp Controlled Transportation",
"Consolidated Temp Controlled Transportation",
"LTL Europe",
"Produce Truckload Temp Controlled Transportation",
"Intermodal Full Container Transportation",
"International Ocean NVOCC",
"Produce LTL Temp Controlled Transportation",
"Domestic Air Transportation",
"Bulk Transportation",
"Ocean",
"Truckload Tautliner Europe",
"Broker - Inventory Freight",
"International Air House",
"Produce Consolidation Temp Controlled Transportation",
"Intermodal Full Temp Controlled Transportation",
"LTL Flatbed Transportation",
"Truckload Europe Box",
"Truckload Bulk Europe",
"International Air Direct",
"Intermodal Europe",
"Tautliner",
"Broker Produce Freight Partial Dry Van"
]
},
"serviceLevel": {
"$ref": "#/$defs/orderEventServiceLevel"
},
"locations": {
"type": "array",
"description": "Locations associated to this shipment.",
"items": {
"$ref": "#/$defs/orderEventLocation"
}
},
"items": {
"type": "array",
"description": "Items associated to this shipment.",
"items": {
"$ref": "#/$defs/orderEventItem"
}
},
"suggestedScac": {
"type": "string",
"minimum": 1,
"maximum": 10,
"description": "Indicates a specific carrier SCAC customer wishes to associate to the order."
},
"suggestedCarrierPartyCode": {
"type": "string",
"minimum": 1,
"maximum": 25,
"description": "C.H. Robinson identifier for a carrier customer wishes to associate to the order."
}
}
},
"orderEventServiceLevel": {
"type": "string",
"description": "Identifies the level of service.",
"enum": [
"Standard",
"Expedited",
"TimeDefinite",
"SameDayNextFlightOut",
"SameDayCharter",
"NextDayDeliveryAM",
"NextDayDeliveryPM",
"ThreeDayDelivery",
"Economic",
"NextFlightOut",
"SameDayDelivery",
"NextDayCargoService",
"PriorityAM",
"SecondDayCargoService",
"SecondDayAM",
"SecondDayPM",
"NextDayTimeDefiniteDelivery",
"SecondDayTimeDefiniteDelivery",
"ThirdDayTimeDefiniteDelivery",
"EconomicTimeDefiniteDelivery",
"CharterService"
]
},
"orderNumber": {
"type": "object",
"properties": {
"orderNumber": {
"type": "integer",
"description": "C.H. Robinson defined order number."
}
}
},
"ordersEventsHazardousProperties": {
"type": "object",
"description": "Object containing hazardous material information.",
"required": [
"description"
],
"properties": {
"description": {
"type": "string",
"minimum": 1,
"maximum": 500,
"description": "Description of the hazardous material."
},
"technicalName": {
"type": "string",
"minimum": 1,
"maximum": 50,
"description": "Technical name of the hazardous material."
},
"unNumber": {
"type": "string",
"minimum": 1,
"maximum": 10,
"description": "Four-digit numbers that identify dangerous goods, hazardous substances and articles (such as explosives, flammable liquids, toxic substances, etc.) in the framework of international transport."
},
"classCode": {
"type": "string",
"minimum": 1,
"maximum": 10,
"description": "Code for hazardous material in the framework of international transport."
},
"packagingGroup": {
"$ref": "#/$defs/hazardousGroupEnum"
},
"emergencyPhone": {
"type": "string",
"minimum": 1,
"maximum": 50,
"description": "Emergency phone number."
},
"authCode": {
"$ref": "#/$defs/hazmatCodeEnum"
},
"isPlacarded": {
"type": "boolean",
"description": "Does hazardous material have a placard."
},
"isReportableQuantity": {
"type": "boolean",
"description": "Hazardous material is defined as a reportable quantity."
},
"isPrimaryCommodity": {
"type": "boolean",
"description": "Is hazardous material considered a primary commodity."
},
"isNOSCommodity": {
"type": "boolean",
"description": "Is hazardous material considered a NOS commodity."
},
"flashpoint": {
"type": "number",
"format": "float",
"description": "Hazmat flash point is the minimum temperature at which a liquid gives off vapor within a test vessel in sufficient concentration to form an ignitable mixture with air near the surface of the liquid."
},
"flashpointTemperatureUnitOfMeasure": {
"type": "string",
"description": "Unit of measure for temperature parameters.",
"enum": [
"Fahrenheit",
"Celsius"
]
},
"isEnvironmentallyHazardous": {
"type": "boolean",
"description": "Is hazardous material considered environmentally hazardous."
},
"subsidiaryHazmatClasses": {
"type": "string",
"minimum": 1,
"maximum": 50,
"description": "Subsidiary Code for hazardous material in the framework of international transport."
},
"vesselStowageCategory": {
"$ref": "#/$defs/vesselStowageCategoryEnum"
},
"specialProvisions": {
"type": "string",
"minimum": 1,
"maximum": 50,
"description": "Indicates the Special Provisions for Hazardous Materials."
},
"marinePollutantCategory": {
"type": "string",
"description": "Indicates the Marine Pollutant Category for Hazardous Materials.",
"$ref": "#/$defs/marinePollutantCategory",
"enum": [
"SevereMarinePollutant",
"MarinePollutant"
]
},
"emergencyResponseGuidePage": {
"type": "string",
"minimum": 1,
"maximum": 50,
"description": "Indicates the Emergency Response Guidebook Page for first responders during the initial Phase of Hazardous Materials Transportation Incident."
},
"passengerLimitation": {
"type": "string",
"minimum": 1,
"maximum": 50,
"description": "Indicates the passenger limitation for Hazardous Materials."
},
"cargoAircraftLimitation": {
"type": "string",
"minimum": 1,
"maximum": 50,
"description": "Indicates the Cargo Aircraft Limitation for Hazardous Materials."
},
"exemptionNotes": {
"type": "string",
"minimum": 1,
"maximum": 4000,
"description": "Indicates the exemption notes for Hazardous Materials."
}
}
},
"packageCodeEnum": {
"type": "string",
"description": "C.H. Robinson defined code for packaging type/code. Here is a list of the most commonly used packagingCodes: \n\n`BAL` - Bale, `BAG` - Bags, `BIN` - Bin, `BOX` - Boxes, `CTN` - Cartons \n`CAS` - Case, `CRT` - Crates, `PKG` - Package, `EAC` - Eaches, `PLT` - Pallet, `PCS` - Pieces \n\nFor a detailed description of all enumerated codes please find them here.",
"enum": [
"BAL",
"BIN",
"BOT",
"BXT",
"JAR",
"LSE",
"LUG",
"OTHR",
"REL",
"SAK",
"SKD",
"SKE",
"SLP",
"TLD",
"TRY",
"Empty",
"BAG",
"BOX",
"BDL",
"CTN",
"CAS",
"CRT",
"DZ",
"DRM",
"EAC",
"GYL",
"HDW",
"LNFT",
"PKG",
"PAL",
"PLT",
"PCS",
"LBS",
"ROL",
"TOT",
"YD",
"Skids",
"GAL",
"KIT",
"FT",
"PAD",
"PR",
"SET",
"SHT",
"M",
"KG",
"IBC",
"BAT",
"AST",
"CUB",
"RKS",
"PCK",
"TH",
"24BIN",
"30BIN",
"36BIN",
"40BIN",
"BSHL",
"CLLPK",
"DRC",
"ECO",
"EURO",
"FLAT",
"HFBIN",
"HFCTN",
"HVYPK",
"IFCO",
"I6408",
"I6411",
"I6413",
"I6416",
"I6419",
"I6423",
"I6425",
"I6428",
"ORBIS",
"O6409",
"O6411",
"O6413",
"O6416",
"O6419",
"O6425",
"O6428",
"P4311",
"P4317",
"P6408",
"P6411",
"P6413",
"P6416",
"P6419",
"P6423",
"P6425",
"P6428",
"RPC",
"R6411",
"R6413",
"R6416",
"TNBIN",
"TOSCA",
"T6408",
"T6411",
"T6413",
"T6416",
"T6419",
"T6423",
"T6425",
"T6428",
"WDCRT",
"BRL",
"RCK",
"TUB",
"CG",
"DSP",
"SQF",
"CYL",
"KEG",
"IFCLB",
"PLT1",
"PLT2",
"PLT3",
"CAR",
"COIL",
"PI",
"GOH",
"BLK",
"POG",
"L",
"IPLT",
"RORO",
"45HC",
"45HR",
"40HC",
40,
"40OT",
"40HR",
"40RF",
"40FR",
"20HC",
20,
"20OT",
"20FR",
"45GP"
]
},
"packageInTransitAddress": {
"type": "object",
"description": "Contains address information",
"properties": {
"city": {
"type": "string",
"description": "City name of address."
},
"stateProvinceCode": {
"$ref": "#/$defs/stateProvinceCodeEnum"
},
"postalCode": {
"type": "string",
"description": "Postal code of address."
},
"country": {
"$ref": "#/$defs/countryCodeEnum"
},
"latitude": {
"type": "number",
"format": "float",
"minimum": -90,
"maximum": 90,
"description": "The latitude of reported update in decimal format."
},
"longitude": {
"type": "number",
"format": "float",
"minimum": -180,
"maximum": 180,
"description": "The longitude of reported update in decimal format."
}
}
},
"packageInTransitEvent": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "A periodic location update during the transport cycle of the shipment.",
"enum": [
"PACKAGE IN TRANSIT"
]
},
"orderDetails": {
"type": "array",
"description": "Contains order number and order tracking information.",
"items": {
"$ref": "#/$defs/orderDetail"
}
},
"loadNumber": {
"type": "integer",
"description": "C.H. Robinson defined shipment number."
},
"carrier": {
"$ref": "#/$defs/carrier"
},
"location": {
"$ref": "#/$defs/packageInTransitAddress"
},
"packages": {
"type": "array",
"description": "Array of the eventPackage object.",
"items": {
"$ref": "#/$defs/eventPackage"
}
},
"deliveryEta": {
"type": "string",
"description": "The date/time in ISO8601 UTC format of the delivery ETA."
}
}
},
"packageStopEvent": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "Indicates an event has occured at one of the designated stops.\n* `PACKAGE PICKED UP` - Carrier has departed the shipper location with the package. \n* `PACKAGE DELIVERED` - Carrier has delivered package to final destination.",
"enum": [
"PACKAGE PICKED UP",
"PACKAGE DELIVERED"
]
},
"orderDetails": {
"type": "array",
"description": "Contains order number and order tracking information.",
"items": {
"$ref": "#/$defs/orderDetail"
}
},
"loadNumber": {
"type": "integer",
"description": "C.H. Robinson defined shipment number."
},
"carrier": {
"$ref": "#/$defs/carrier"
},
"location": {
"$ref": "#/$defs/eventLocation"
},
"packages": {
"type": "array",
"description": "List of packages associated to the stop.",
"items": {
"$ref": "#/$defs/eventPackage"
}
}
}
},
"proposedCarrier": {
"type": "object",
"description": "Carrier CHR is proposing to use for this shipment (Only available for Small Parcel Mode).",
"properties": {
"carrierCode": {
"type": "string",
"description": "C.H. Robinson defined carrier code."
}
}
},
"rateCodeEnum": {
"type": "string",
"description": "C.H. Robinson defined code for rating code. Here is a list of the most commonly used rate codes: \n\n`400` - Line Haul, `405` - Fuel Surchage, `260` - Deliver Surchage, `IDL` - Inside Delivery, `IPU` - Inside Pickup \n`LFT` - Lift Gate or Forklift Service, `DET` - Detention, `DLA` - Delivery Limited Access, `PLA` - Pickup Limited Access \n`RES` - Residential Delivery Fee, `REP` - Residential Pickup Fee, `CSD` - Construction Site Delivery here.",
"enum": [
"Customer",
"20",
"55",
"65",
"115",
"170",
"180",
"205",
"215",
"230",
"260",
"275",
"280",
"285",
"300",
"315",
"350",
"360",
"365",
"370",
"385",
"400",
"405",
"420",
"425",
"445",
"450",
"455",
"470",
"485",
"495",
"497",
"510",
"520",
"540",
"545",
"590",
"593",
"605",
"635",
"665",
"670",
"685",
"690",
"695",
"740",
"761",
"800",
"801",
"802",
"803",
"804",
"898",
"899",
"900",
"901",
"902",
"903",
"904",
"905",
"906",
"907",
"908",
"909",
"910",
"911",
"ACC",
"AGR",
"AGS",
"AIR",
"ALH",
"AMC",
"AMS",
"APT",
"ATR",
"BAT",
"BIO",
"BLC",
"BLK",
"BND",
"BRD",
"BSC",
"CAA",
"CEX",
"CHE",
"CHN",
"CIS",
"CLA",
"CLN",
"CLS",
"CNS",
"COA",
"COL",
"COU",
"CPC",
"CPE",
"CRE",
"CRS",
"CSE",
"CTC",
"CTG",
"CTL",
"CUF",
"CUS",
"DAM",
"DCF",
"DEL",
"DEN",
"DEP",
"DET",
"DFD",
"DFG",
"DHF",
"DIC",
"DIS",
"DMC",
"DOC",
"DOV",
"DRC",
"DRF",
"DSC",
"DTC",
"DTL",
"DTU",
"DTV",
"DUT",
"DYA",
"EBD",
"EEX",
"EMT",
"ENC",
"ESD",
"EUC",
"EXC",
"EXD",
"EXL",
"EXM",
"EXP",
"EXR",
"EXW",
"FDA",
"FDT",
"FFR",
"FLP",
"FTH",
"FTW",
"FTZ",
"FWA",
"FWC",
"GST",
"HMF",
"HOL",
"HST",
"IDL",
"IFS",
"IHT",
"INC",
"INS",
"INV",
"IPU",
"ISO",
"IST",
"ITS",
"LAA",
"LAY",
"LEC",
"LFT",
"LMF",
"LOA",
"LOC",
"MIC",
"MPF",
"MRK",
"MSG",
"NDD",
"NYD",
"NYP",
"OFU",
"OHF",
"OPT",
"ORD",
"ORF",
"ORM",
"OVR",
"PAE",
"PCS",
"PEC",
"PER",
"PFA",
"PKG",
"PMT",
"POD",
"PPH",
"PPN",
"PRT",
"PSC",
"PSH",
"PSS",
"PST",
"PUC",
"QST",
"RAJ",
"RCC",
"RCL",
"REC",
"REF",
"REP",
"RES",
"RET",
"SAT",
"SCL",
"SCS",
"SDL",
"SEC",
"SEG",
"SER",
"SET",
"SOC",
"SPS",
"SPT",
"SRA",
"SRG",
"SUR",
"SYA",
"TAK",
"TAL",
"TAR",
"TDT",
"THC",
"TMF",
"TRC",
"TRL",
"TTC",
"UNL",
"URC",
"VOR",
"WAR",
"WBF",
"WBL",
"WCT",
"WDC",
"WFL",
"WHC",
"WHF",
"WIO",
"WIS",
"WKT",
"WLB",
"WLC",
"WLS",
"WMS",
"WOP",
"WOT",
"WPC",
"WPK",
"WPL",
"WPP",
"WRC",
"WRE",
"WRI",
"WRS",
"WSS",
"WSW",
"WTV",
"WWT",
"WXD",
"XTN",
"496",
"BYD",
"BYP",
"DCV",
"ICT",
"PDD",
"PDO",
"TSA",
"UND",
"HAZ",
"ISF",
"913",
"914",
"915",
"916",
"316",
"BPC",
"BPR",
"BPS",
"BPT",
"CEM",
"CMX",
"COT",
"CUV",
"MXC",
"MXH",
"MXR",
"MXV",
"OVT",
"PEN",
"CTS",
"LRC",
"AMF",
"BPI",
"SCR",
"AES",
"NAV",
"DLA",
"PLA",
"PSF",
"CSF",
"894",
"895",
"896",
"897",
"EMN",
"SPF",
"TSC",
"HCR",
"CNT",
"CMM",
"RNT",
"PRF",
"CSD",
"HCD",
"CSP",
"GVP",
"GVD",
"HCP",
"NCP",
"NCD",
"BUV",
"COW",
"HOS",
"INP",
"RAP",
"SIE",
"TAW",
"OTD",
"MES",
"ENS",
"ACF",
"SLF",
"BLR",
"FLT",
"917",
"FCP",
"GSI",
"SMA",
"CFI",
"EXT",
"EXY",
"AAI",
"CAS",
"CCF",
"CMC",
"DCC",
"DOF",
"EDC",
"EMS",
"ERF",
"FLC",
"FUC",
"GAS",
"GTA",
"HBL",
"LBE",
"LUC",
"MLC",
"PAC",
"PCH",
"PRC",
"PRS",
"PUD",
"SCH",
"STR",
"STU",
"TPA",
"OCT",
"STC",
"EPC",
"DPC",
"STD",
"RFC",
"SYC",
"SED",
"MEC",
"SUF",
"IAC",
"CFS",
"BTF",
"ESS",
"AMD",
"ORC",
"LIF",
"PCF",
"GIO",
"TLX",
"GAT",
"LBL",
"LCG",
"LBF",
"HLS",
"IMP",
"CIF",
"CCE",
"EDN",
"HET",
"PMU",
"HEL",
"STM",
"TOL",
"VAC",
"PRP",
"PDC",
"SBC",
"PFC",
"TDR",
"OTH",
"DTH",
"ODO",
"DDO",
"AWB",
"CYC",
"DEC",
"FAF",
"GRI",
"LCL",
"PCC",
"PPF",
"TPF",
"WVF",
"CSR",
"27",
"GSC",
"ATC",
"ECV",
"GAR",
"BTR",
"CRD",
"IVT",
"TAP",
"SEN",
"IVP",
"IBP",
"COC",
"DRY",
"FOB",
"EWC",
"HTS",
"DSB",
"HTC",
"FAH",
"EIC",
"NPC",
"LSF",
"AHD",
"ESV",
"FCC",
"PEP",
"OGA",
"MFE",
"CAH",
"GOA",
"75",
"CBT",
"DCT",
"921",
"922",
"COV",
"DBR",
"IAT",
"POM",
"ACI",
"ASF",
"BOK",
"CDD",
"CDF",
"COF",
"CVE",
"DCH",
"DDP",
"DKF",
"DMI",
"ESC",
"EXA",
"EXO",
"LCH",
"PES",
"VMS",
"SRC",
"CFE",
"CDA",
"IEC",
"DGS",
"HAS",
"701",
"750",
"751",
"753",
"754",
"755",
"756",
"1401",
"1402",
"1403",
"DTF",
"OTF",
"SRD",
"SRO",
"1900",
"2000",
"2100",
"INF",
"DDT",
"DUF",
"EMF",
"LYO",
"LYD",
"999",
"145",
"ADV",
"AMB",
"ARB",
"BEY",
"BKA",
"BSS",
"CBL",
"CFL",
"CTF",
"DAA",
"DEM",
"FAK",
"FCB",
"GSS",
"HAN",
"HHB",
"HRS",
"HZC",
"IFC",
"LAB",
"LFC",
"MIN",
"MNC",
"MSC",
"OCH",
"PIR",
"POS",
"PTS",
"PWT",
"PYS",
"RAM",
"RLS",
"RMC",
"SPC",
"SSF",
"STO",
"STP",
"SWC",
"TAY",
"TER",
"TRM",
"WEA",
"WFG",
"WFH",
"IFF",
"CME",
"MDF",
"CPV",
"EMA",
"EPF",
"TPC",
"GOF",
"LOM",
"ISE",
"STF",
"CSU",
"AHF",
"MEF",
"FID",
"LCK",
"BYC",
"BCD",
"SO1",
"SO2",
"SO3",
"COR",
"TRE",
"LSK",
"DON",
"CTM",
"DCK",
"RPK",
"FGT",
"CHF",
"BRF",
"MKF",
"FES",
"CLM",
"PDR",
"AVP",
"GBB",
"GLF",
"GLT",
"MOTLF",
"MOTMF",
"TROLF",
"TROMF",
"REBAT",
"ASCMB",
"SPCRV",
"SPCAS",
"PENNY",
"WELLF",
"WELMF",
"BAMLF",
"BAMMF",
"SWTLF",
"ECOLF",
"ECOMF",
"SRVLF",
"SRVMF",
"N22LF",
"N23LF",
"OURLF",
"GLYLF",
"GLYMF",
"PNKLF",
"PECLF",
"GRNLF",
"SWTMF",
"MKU",
"EVC",
"APA",
"ARA",
"GAV",
"REB",
"SEL",
"ABG",
"ICG",
"TET",
"PAF",
"OSO",
"RSP",
"MIF",
"SPL",
"SPA",
"SPO",
"AFS",
"NCH",
"ASM",
"LGP",
"444",
"CNA",
"DEB",
"DOM",
"EGY",
"FER",
"FIM",
"FOR",
"FRA",
"FUM",
"HRT",
"MAU",
"PCD",
"PNL",
"PPC",
"RED",
"REI",
"SLU",
"VET",
"WAS",
"WAT",
"BIN",
"206",
"PLS",
"OCS",
"TPS",
"BUP",
"RBU",
"CMR",
"SPQ",
"IMF",
"IMV",
"BLD",
"1404",
"1405",
"1406",
"ENF",
"ENV",
"PRO",
"PRV",
"WAF",
"WAV",
"EPS",
"AKS",
"CCT",
"ECC",
"HIS",
"PRD",
"TRR",
"RIT",
"GIT",
"BAC",
"CCR",
"CLC",
"DCR",
"SC1",
"FCH",
"AFC",
"WMF",
"IFP",
"OSP",
"OCP",
"DSP",
"DCP",
"CBC",
"BRT",
"ECH",
"OID",
"OCR",
"RPT",
"SOS",
"TGS",
"TKP",
"WSC",
"SFA",
"HHC",
"RHC",
"IFA",
"FLB",
"LWS",
"MFD",
"SEP",
"SCA",
"PHL",
"JAM",
"VGM",
"HSB",
"PFS",
"CCS",
"DTY",
"RNR",
"RCD",
"DRP",
"PKU",
"EBP",
"LFD",
"CPL",
"AGM",
"APH",
"FSI",
"FWS",
"NHT",
"EPA",
"CPS",
"USL",
"NMF",
"RCO",
"ROS",
"OVS",
"TIV",
"TMR",
"RER",
"FTA",
"RBY",
"RBI",
"RBV",
"RBE",
"WAC",
"ABT",
"CON",
"QCC",
"SUN",
"SBS",
"SDV",
"NGT",
"GTD",
"ASR",
"SGR",
"SOG",
"1013",
"101",
"1014",
"DTZ",
"919",
"923",
"WTT"
]
},
"referenceNumber": {
"type": "object",
"required": [
"type",
"value"
],
"properties": {
"type": {
"type": "string",
"description": "C.H. Robinson defined code for reference number types. Here is a list of the most commonly used reference number types: \n\n`SHID` - Shipment ID #, `MBOL` - Master Bill of Lading #, `PO` - Purchase Order #, `BOL` - Bill of Lading #, `CRID` - Customer Specific Ref Number, `CUSTPO` - Customer PO Number, `DEL` - Delivery #, `JNO` - Job Number, `PU` - Pickup #, `CON` - Customer Order Number, `APPT` - Appointment Number \n\nFor a detailed description of all enumerated codes please find them here.",
"enum": [
"SHID",
"MBOL",
"PO",
"BOL",
"CFRM",
"CRID",
"CUSTPO",
"DEL",
"DIST",
"FIN",
"GL",
"JNO",
"PU",
"RANumber",
"RLPRO",
"MREF",
"Empty",
"PRO",
"CCN",
"SBOL",
"CON",
"APPT",
"CHRW_ID",
"FDA",
"IREF",
"LIC",
"ORD",
"PLU",
"SCAC",
"SEAL",
"SKU",
"SREF",
"STCC",
"TEB",
"VPO",
"WB",
"XXXX",
"TRIA",
"TRANS",
"GCC",
"SDATE",
"CDATE",
"ACCT",
"CCTR",
"IGM",
"GIGM",
"LIGM",
"SMTP",
"PERMIT",
"RNO",
"DVCN",
"PRCL",
"CPUC",
"SHPMD",
"AFR",
"BUYID",
"VNDID",
"DIV",
"DEPT",
"POTYPE",
"GRGI",
"DUNS",
"PALLETREF",
"CITTN",
"CIN",
"SHIPWITH",
"PN",
"UPC",
"PRCD",
"VESSEL",
"VOYAGE",
"FN",
"FEEDVESS",
"FEEDVOY",
"SHIPREF",
"CBL",
"SPAC",
"POLN",
"VPOLN",
"EIN",
"CNSG",
"PROFITCTR",
"MFGPART",
"PACKSLIP",
"THIRDPRTY",
"DEFATTR",
"FSTRK",
"FOItemID",
"POLineNum",
"PARCELSPC",
"CNS1",
"CNS2",
"CNS3",
"CNS4",
"CNS5",
"CNS6",
"CNS7",
"TREF",
"VREF",
"UPRICE",
"FWPARTY",
"BYPARTY",
"HBL",
"CBP",
"TRANSFER",
"SO",
"ORDTRK",
"QUOTEID",
"EQT",
"BOOTH",
"TS",
"OH #",
"CNTNR",
"VAS",
"Size",
"Color",
"Style",
"HCERT",
"B#",
"ETMSID",
"214-IMO",
"SHPWeight",
"SHPVolume",
"SHPDims",
"SERIALIZED",
"SERIALNUM",
"CPSIA",
"EDIINVREF",
"SQID",
"QSeqNum",
"OuterPkStu",
"GLC",
"COMP",
"COST",
"DTYGL",
"DTYCC",
"BRKGL",
"BRKCC",
"GPS",
"IAC",
"WHRCT",
"ERGUID",
"SONUM",
"CCNUM",
"PrimCCNUM",
"PrevCCNUM",
"CMRN",
"TRANSSHIP",
"PGIDATE",
"AESFIL",
"CUSTQUOTID",
"QUOTETRACE",
"ODATE",
"FRCLS",
"NMFC",
"OrderItemId"
]
},
"value": {
"type": "string",
"minimum": 1,
"maximum": 100,
"description": "The actual value of the reference number."
}
}
},
"stateProvinceCodeEnum": {
"type": "string",
"description": "Indicate the state or province of the location. \n\nFor a detailed description of all enumerated codes please find them here.",
"enum": [
"1",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"2",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"3",
"30",
"31",
"32",
"33",
"34",
"35",
"36",
"37",
"38",
"39",
"4",
"40",
"41",
"42",
"43",
"44",
"45",
"46",
"47",
"48",
"49",
"5",
"50",
"51",
"52",
"53",
"54",
"6",
"61",
"62",
"63",
"64",
"65",
"67",
"7",
"71",
"76",
"79",
"8",
"81",
"84",
"86",
"89",
"9",
"91",
"92",
"95",
"A",
"AA",
"AB",
"AC",
"AE",
"AG",
"AGU",
"AI",
"AK",
"AL",
"AM",
"AN",
"AO",
"AP",
"AQ",
"AR",
"AS",
"AT",
"AUK",
"AV",
"AZ",
"B",
"BA",
"BC",
"BCN",
"BCS",
"BG",
"BI",
"BL",
"BM",
"BN",
"BO",
"BOP",
"BR",
"BS",
"BT",
"BZ",
"C",
"CA",
"CAM",
"CAN",
"CB",
"CE",
"CH",
"CHH",
"CHP",
"CI",
"CL",
"CN",
"CO",
"COA",
"COL",
"CR",
"CS",
"CT",
"CZ",
"D",
"DC",
"DD",
"DE",
"DF",
"DL",
"DN",
"DUR",
"E",
"EN",
"ES",
"F",
"FC",
"FE",
"FG",
"FI",
"FL",
"FM",
"FR",
"G",
"GA",
"GE",
"GIS",
"GJ",
"GO",
"GR",
"GRO",
"GU",
"GUA",
"H",
"HI",
"HID",
"HKB",
"HP",
"HR",
"IA",
"ID",
"IL",
"IM",
"IN",
"IS",
"J",
"JAL",
"JH",
"JK",
"K",
"KA",
"KL",
"KR",
"KS",
"KY",
"L",
"LA",
"LC",
"LD",
"LE",
"LI",
"LL",
"LO",
"LT",
"LU",
"M",
"MA",
"MB",
"MBH",
"MC",
"MD",
"ME",
"MEX",
"MG",
"MH",
"MI",
"MIC",
"ML",
"MN",
"MO",
"MOR",
"MP",
"MS",
"MT",
"MWT",
"MZ",
"N",
"NA",
"NAY",
"NB",
"NC",
"ND",
"NE",
"NH",
"NJ",
"NL",
"NLE",
"NM",
"NO",
"NS",
"NSN",
"NSW",
"NT",
"NTL",
"NU",
"NV",
"NY",
"O",
"OAX",
"OG",
"OH",
"OI",
"OK",
"ON",
"OR",
"OT",
"OTA",
"P",
"PA",
"PB",
"PC",
"PD",
"PE",
"PG",
"PI",
"PN",
"PO",
"PR",
"PT",
"PU",
"PUE",
"PV",
"PY",
"PZ",
"Q",
"QC",
"QLD",
"QU",
"QUE",
"R",
"RA",
"RC",
"RE",
"RG",
"RI",
"RJ",
"RM",
"RN",
"RO",
"ROO",
"RR",
"RS",
"S",
"SA",
"SC",
"SD",
"SE",
"SI",
"SIN",
"SJ",
"SK",
"SLP",
"SO",
"SON",
"SP",
"SR",
"SS",
"STL",
"SV",
"T",
"TA",
"TAB",
"TAM",
"TAS",
"TE",
"TG",
"TKI",
"TLA",
"TN",
"TO",
"TP",
"TR",
"TS",
"TV",
"TX",
"U",
"UD",
"UL",
"UM",
"UP",
"UT",
"V",
"VA",
"VB",
"VC",
"VE",
"VER",
"VI",
"VIC",
"VR",
"VS",
"VT",
"VV",
"W",
"WA",
"WB",
"WGN",
"WI",
"WKO",
"WTC",
"WV",
"WY",
"X",
"Y",
"YT",
"YUC",
"Z",
"ZAC"
]
},
"stopEvent": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "Indicates an event has occured at one of the designated stops.\n* `CARRIER ARRIVED` - Carrier has arrived at a stop location.\n* `CARRIER DEPARTED` - Carrier has departed at a stop location. \n* `LOAD PICKED UP` - Carrier has departed the last pick up stop.\n* `LOAD DELIVERED` - Carrier has departed the last drop off stop.",
"enum": [
"CARRIER ARRIVED",
"CARRIER DEPARTED",
"LOAD PICKED UP",
"LOAD DELIVERED"
]
},
"orderDetails": {
"type": "array",
"description": "Contains order number and order tracking information.",
"items": {
"$ref": "#/$defs/orderDetail"
}
},
"loadDetails": {
"$ref": "#/$defs/loadDetails"
},
"loadNumber": {
"type": "integer",
"description": "C.H. Robinson defined shipment number."
},
"deliveryAvailableByDate": {
"type": "string",
"format": "date-time",
"description": "Earliest date, local to location, carrier can deliver the shipment."
},
"deliveryByDate": {
"type": "string",
"format": "date-time",
"description": "Latest date, local to location, carrier can deliver the shipment."
},
"proofOfDelivery": {
"type": "string",
"description": "Individual or entity that signed for the items upon delivery."
},
"carrier": {
"$ref": "#/$defs/carrier"
},
"location": {
"$ref": "#/$defs/stopEventLocation"
},
"loadStops": {
"type": "array",
"description": "An array that offers all stops on the load with key stop details.",
"items": {
"$ref": "#/$defs/loadStopInformation"
}
},
"items": {
"type": "array",
"description": "List of items associated to the stop.",
"items": {
"$ref": "#/$defs/eventItem"
}
},
"packages": {
"type": "array",
"description": "List of packages associated to the stop.",
"items": {
"$ref": "#/$defs/eventLoadPackage"
}
}
}
},
"stopEventLocation": {
"type": "object",
"description": "Location information specific to the event.",
"properties": {
"chrLocationId": {
"type": "string",
"description": "C.H. Robinson defined location identifier."
},
"customerLocationId": {
"type": "string",
"description": "Customer generated location identifier."
},
"type": {
"type": "string",
"description": "Identifies the type of stop the location is."
},
"style": {
"type": "string",
"description": "identifies the style of the stop."
},
"stopSequenceNumber": {
"type": "integer",
"description": "Number to indicate where in the order of stops the location is. C.H. Robinson uses a zero index. This means the \\\"0\\\" will indicate the first stop in the sequence of stops."
},
"sequenceNumber": {
"type": "integer",
"description": "System generated number applied to the location when it is entered into the system."
},
"name": {
"type": "string",
"description": "Name of the location."
},
"address": {
"$ref": "#/$defs/eventAddress"
},
"pickUpNumber": {
"type": "string",
"description": "Pick-Up number."
},
"deliveryNumber": {
"type": "string",
"description": "Delivery number."
},
"isOrderStop": {
"type": "boolean",
"description": "Indicates if this is an order service stop. False indicates this location was not included as part of the customer order."
},
"locationContact": {
"type": "object",
"description": "Contact information for the location.",
"properties": {
"name": {
"type": "string",
"description": "Name of contact at the location."
},
"phoneNumber": {
"type": "string",
"description": "Phone number of contact at the location."
},
"email": {
"type": "string",
"description": "E-mail address of the contact at the location."
}
}
},
"referenceNumbers": {
"type": "array",
"description": "Reference numbers associated to this location.",
"items": {
"$ref": "#/$defs/referenceNumber"
}
}
}
},
"trackingNumberEvent": {
"type": "object",
"properties": {
"eventType": {
"type": "string",
"description": "Indicates CHR Tracking Number has been associated to the order/shipment. \n* `CHR TRACKING NUMBER PUBLISHED` - CHR Tracking Number has been associated to the order/shipment.",
"enum": [
"CHR TRACKING NUMBER PUBLISHED"
]
},
"chrTrackingNumber": {
"type": "string",
"description": "CHR Number available for tracking on Customer Platform."
},
"trackingType": {
"type": "string",
"description": "Identifies the core system and phase of transaction producing the number.",
"enum": [
"order",
"shipment"
]
},
"customerCode": {
"type": "string",
"description": "CH Robinson defined customer code."
},
"referenceNumber": {
"type": "string",
"description": "CHR order number or shipment (load) number."
}
}
},
"vesselStowageCategoryEnum": {
"type": "string",
"description": "Indicates the HazMat Stowage category code according stowage requirements listed in the IMDG Code Dangerous Goods List.\n * `A` - Stowage category code A\n * `B` - Stowage category code B\n * `C` - Stowage category code C\n * `D` - Stowage category code D\n * `E` - Stowage category code E\n * `01` - Stowage category code 1\n * `02` - Stowage category code 2\n * `03` - Stowage category code 3\n * `04` - Stowage category code 4\n * `05` - Stowage category code 5\n",
"enum": [
"A",
"B",
"C",
"D",
"E",
"01",
"02",
"03",
"04",
"05"
]
},
"volumeUomEnum": {
"type": "string",
"description": "Unit of measure for volume parameters.",
"enum": [
"CubicFeet",
"CubicMeters"
]
},
"weightUomEnum": {
"type": "string",
"description": "Unit of measure for weight parameters.",
"enum": [
"Pounds",
"Kilograms"
]
}
}
}