{ "$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-order-schema.json", "title": "order", "x-generated": "2026-10-20", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/ch-robinson-worldwide-orders-and-booking-api-openapi.yml#/components/schemas/order", "type": "object", "required": [ "customers", "billTos", "services" ], "properties": { "orderNumber": { "type": "integer", "description": "C.H. Robinson order number received on successful order create.\n ### This would only be used on an Order Update." }, "customers": { "type": "array", "minimum": 1, "maximum": 1, "description": "The customer(s) on the order.", "items": { "$ref": "#/$defs/orderCustomer" } }, "billTos": { "type": "array", "minimum": 1, "description": "The bill to(s) on the order.", "items": { "$ref": "#/$defs/orderBillTo" } }, "services": { "type": "array", "minimum": 1, "description": "The service(s) on the order.", "items": { "$ref": "#/$defs/orderService" } }, "measurementSystem": { "type": "string", "description": "Indicates the unit of measure.", "enum": [ "Metric", "Standard" ] }, "referenceNumbers": { "type": "array", "description": "Additional reference number objects pertaining to the whole order.", "items": { "$ref": "#/$defs/referenceNumber" } }, "additionalLocations": { "type": "array", "description": "List of additional Locations for Ocean/Air transport Mode.", "items": { "$ref": "#/$defs/additionalLocation" } }, "internationalParcelShippingSpecs": { "type": "object", "description": "Elements specific to international parcel shipping scenarios.", "properties": { "isDutiable": { "type": "boolean", "description": "A flag required for DHL international shipments indicating whether or not the shipment is dutiable." }, "dutyPayerType": { "$ref": "#/$defs/payerTypeEnum" }, "dutyPayerAccountNumber": { "$ref": "#/$defs/dutyPayerAccountNumber" }, "exportReasonCode": { "$ref": "#/$defs/exportReasonCode" }, "AESTransactionNumber": { "$ref": "#/$defs/AESTransactionNumber" }, "isAESExempt": { "type": "boolean", "description": "Indicates that goods being shipped are exempt from AES Export Filing; FedEx only, Optional." }, "countryOfOriginCode": { "description": "Indicates country of origin of the items; Required for all international shipments.", "$ref": "#/$defs/countryCodeEnum" } } }, "parcelLabelReferenceNumbers": { "type": "object", "description": "Reference data to be used on the label pertaining to the whole order.", "properties": { "labelReferenceData1": { "$ref": "#/$defs/labelReferenceData1" }, "labelReferenceData2": { "$ref": "#/$defs/labelReferenceData2" }, "labelReferenceData3": { "$ref": "#/$defs/labelReferenceData3" } } }, "parcelSpecs": { "type": "object", "description": "Elements specific to parcel shipping scenarios.", "properties": { "isDocumentsOnly": { "type": "boolean", "description": "Used on DHL parcel shipments to indicate if the parcel order only contains documents." }, "bookingNumber": { "$ref": "#/$defs/bookingNumber" } } }, "loadValues": { "type": "object", "description": "Values for the freight and/or trailer that will be used for an executed order.", "properties": { "equipmentLength": { "type": "integer", "description": "The desired length of trailer in feet." }, "equipmentWidth": { "type": "integer", "description": "The desired width of trailer in inches." }, "equipmentHeight": { "type": "integer", "description": "The desired height of trailer in inches." }, "trailerNum": { "type": "string", "description": "The trailer number to be used for the freight." }, "movementType": { "$ref": "#/$defs/movementTypeEnum" } } }, "onlineParties": { "type": "array", "description": "Contains data which allows a third party visibility to an order belonging to their associated shipper via the Navisphere Online 2.0 product.", "items": { "type": "object", "properties": { "partyType": { "type": "string", "description": "Represents the type of order party requesting visibility for the third party.", "enum": [ "CUSTOMER", "BILLTO" ] }, "partyCode": { "type": "string", "description": "Represents the CHR customer code linked to the online/third party." }, "relationshipIdentifier": { "type": "string", "description": "An identifier mutually recognized by all concerned parties interested in the progress of the shipment." } } } }, "shippingContainerValues": { "type": "object", "description": "Contains data about containers.", "properties": { "shippingContainers": { "$ref": "#/$defs/shippingContainers" }, "shippingContainerItems": { "$ref": "#/$defs/shippingContainerItems" } } }, "notes": { "type": "string", "minimum": 1, "maximum": 4000, "description": "Order level notes." } }, "$defs": { "AESTransactionNumber": { "type": "string", "description": "AES ITN may be required if shipping internationally from the US and the value is over 2,500.00 USD; must be exactly 14 digits and prefixed with X." }, "additionalLocation": { "type": "object", "description": "List of additional Locations for Ocean/Air transport Mode.", "required": [ "additionalLocationType." ], "properties": { "additionalLocationType": { "$ref": "#/$defs/additionalLocationTypeEnum" }, "customerAPILocationNumber": { "type": "string", "minimum": 1, "maximum": 80, "description": "Customer defined identifier associated to a specific location. If C.H. Robinson maintains a list of the customer's location IDs, then customerLocationId can be provided in lieu of address information." }, "locationName": { "type": "string", "minimum": 1, "maximum": 200, "description": "Name of the location." }, "address1": { "type": "string", "minimum": 1, "maximum": 200, "description": "Indicate address line one of the location." }, "address2": { "type": "string", "minimum": 1, "maximum": 200, "description": "Indicate address line two of the location." }, "address3": { "type": "string", "minimum": 1, "maximum": 200, "description": "Indicate address line three of the location." }, "address4": { "type": "string", "minimum": 1, "maximum": 200, "description": "Indicate address line four of the location." }, "city": { "type": "string", "minimum": 1, "maximum": 100, "description": "Indicate the city of the location." }, "county": { "type": "string", "minimum": 1, "maximum": 100, "description": "Indicate the county of the location." }, "lat": { "type": "number", "format": "float", "minimum": -90, "maximum": 90, "description": "Indicate the latitude of the location." }, "long": { "type": "number", "format": "float", "minimum": -180, "maximum": 180, "description": "Indicate the longitude of the location" }, "stateProvinceCode": { "$ref": "#/$defs/stateProvinceCodeEnum" }, "postalCode": { "type": "string", "minimum": 1, "maximum": 20, "description": "Indicate the postal code of the location, sometime refered to as the zip code." }, "country": { "$ref": "#/$defs/countryCodeEnum" } } }, "additionalLocationTypeEnum": { "type": "string", "description": "The additional locations types on the order.\n * `BailmentWarehouse` - Bailment Warehouse\n * `BillToParty` - Bill To Party\n * `Consignee` - Consignee\n * `DeliveryAddress` - Delivery Address\n * `Depositor` - Depositor\n * `Exporter` - Exporter\n * `NotifyParty1` - Notify Party 1\n * `NotifyParty2` - Notify Party 2\n * `PickupAddress` - Pickup Address\n * `Plant` - Plant\n * `SellingParty` - Selling Party\n * `ShipFrom` - Ship From\n * `ShipTo` - Ship To\n * `Shipper` - Shipper\n * `SoldToandShipTo` - Sold To and Ship To\n * `SoldTo` - Sold To if different from Bill To\n * `Supplier` - Supplier\n * `ThirdPartyAdministrator` - Third Party Administrator\n * `UltimateConsignee` - Ultimate Consignee\n * `Vendor` - Vendor\n * `Warehouse` - Warehouse\n" }, "blindLocation": { "type": "object", "description": "A \"blind shipment\" is a shipment, regardless of mode, in which the party paying the freight charges requests that either the actual \"shipper\" or actual \"consignee\" not be disclosed on the bill of lading or other shipping documentation in order to shield such party's identity from another party. This is the address that will be displayed on the Bill of Lading.", "properties": { "blindName": { "type": "string", "description": "Indicate name of blind location." }, "blindAddress": { "type": "string", "description": "Indicate address of blind location." }, "blindCity": { "type": "string", "description": "Indicate city of blind location." }, "blindState": { "type": "string", "description": "indicate state of blind location." } } }, "bookingNumber": { "type": "string", "description": "The booking number for FedEx heavy air shipments." }, "charge": { "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." } } }, "collectOnDelivered": { "type": "object", "description": "Information relating to payment.", "required": [ "amount", "paymentType", "payableTo", "mailTo", "address" ], "properties": { "amount": { "type": "number", "description": "The currency amount to be paid.", "format": "float" }, "paymentType": { "type": "string", "minimum": 1, "maximum": 25, "description": "Method of payment." }, "payableTo": { "type": "string", "minimum": 1, "maximum": 50, "description": "Individual or entity receiving payment." }, "mailTo": { "type": "string", "minimum": 1, "maximum": 50, "description": "Individual or entity payment is mailed to." }, "address": { "$ref": "#/$defs/orderAddress" }, "referenceNumbers": { "type": "array", "description": "Additional reference number objects pertaining to this service.", "items": { "$ref": "#/$defs/referenceNumber" } } } }, "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" ] }, "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" ] }, "dutyPayerAccountNumber": { "type": "string", "description": "Account number of the party paying the duty charges; Required for a dutyPayerType of Third_Party or if C.H. Robinson does not have the billing account to use on file." }, "exportReasonCode": { "type": "string", "description": "A value required for DHL international shipments indicating why the shipment is being exported.", "enum": [ "Permanent", "Temporary", "Re_Export" ] }, "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" ] }, "freightTermEnum": { "type": "string", "description": "Code to indicate the freight term type:\n\n* `CL` - Collect\n* `PP` - Prepaid \n* `TP` - Third Party\n* `PC` - Prepaid and Add\n* `CC` - The Bill To is paying via a Credit Card\n\n", "enum": [ "CL", "PP", "TP", "PC", "CC" ] }, "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" ] }, "hazardousProperties": { "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." }, "flashpointTemperatureUnit": { "$ref": "#/$defs/temperatureUomEnum" }, "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." } } }, "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" ] }, "incoTermsEnum": { "type": "string", "description": "The Incoterms or International Commercial Terms are a series of pre-defined commercial terms published by the International Chamber of Commerce (ICC) relating to international commercial law.\n * `DAT` - Delivered at Terminal\n * `DAP` - Delivered at Place\n * `CIF` - Cost Insurance & Freight\n * `CPT` - Carriage Paid To\n * `CIP` - Carriage & Insurance Paid To\n * `DDP` - Delivered duty paid\n * `EXW` - EX works\n * `FCA` - Free carrier at\n * `DPU` - Delivered at place unloaded\n * `FAS` - Free alongside ship\n * `FOB` - Free on Board\n * `CFR` - Cost and Freight\n * `PPD` - Prepaid\n * `COL` - Collect\n * `DAF` - Delivery at Frontier\n * `DDU` - Delivery Duty Unpaid\n * `DEQ` - Delivery Ex-Quay, Duty Unpaid\n * `DES` - Delivery Ex-Ship\n", "enum": [ "DAT", "DAP", "CIF", "CPT", "CIP", "DDP", "EXW", "FCA", "DPU", "FAS", "FOB", "CFR", "PPD", "COL", "DAF", "DDU", "DEQ", "DES" ] }, "isResidential": { "type": "boolean", "description": "A flag indicating whether or not this is a residential location. Used ONLY FOR PARCEL Shipments. For FedEx, FedEx_Ground_Home_Delivery or Fedex_Home_Delivery must be used if the destination is residential." }, "itemEquipment": { "type": "object", "description": "Additional information as to the specific equipment needs.", "properties": { "itemEquipmentCode": { "$ref": "#/$defs/itemEquipmentTypeEnum" }, "maxTrailerAge": { "type": "integer", "description": "Defines the how old a trailer can be to ship items." }, "tarpTypeCode": { "$ref": "#/$defs/tarpTypeEnum" }, "loadingTypeCode": { "$ref": "#/$defs/loadingTypeEnum" }, "requiredStrapsCount": { "type": "integer", "description": "Indicates number of straps needed." }, "requiredChainsCount": { "type": "integer", "description": "Indicates number of chains needed" }, "coilRacks": { "type": "integer", "description": "Indicates number of coil racks needed." }, "locksBars": { "type": "integer", "description": "Indicates number of locks or bars needed." }, "isOwOd": { "type": "boolean", "description": "Indicates overweight or over dimensional." }, "safetyEquipmentRequired": { "type": "boolean", "description": "Indicates if safety equipment is required." } } }, "itemEquipmentTypeEnum": { "type": "string", "description": "Indicates the equipment type needed to move the item.\n\nFor a detailed description of all enumerated codes please find them here.", "enum": [ "B", "BT", "CN", "CV", "DD", "F", "FA", "FD", "FO", "FS", "HS", "MX", "RGN", "SD", "SF", "ST", "SDC", "DDC", "V", "W", "STR", "SS", "TK", "P", "FV", "R", "IC", "IR", "IT", "RM", "BDPT", "BEND", "BFGD", "BHOP", "BST", "BVT", "BLAT", "BLFGT", "BLFRPT", "BLRL", "BLSS", "PU", "OT", "TT", "MF", "SA", "TP", "TM", "SSD", "PRT", "SETT", "BEAM", "BLADE", "BARGE", "VS" ] }, "labelReferenceData1": { "type": "string", "description": "First piece of reference data to be used on the package label. This is used as the customer/shipper reference number on the label for FedEx, UPS, DHL, and TNT.", "minLength": 1, "maxLength": 35 }, "labelReferenceData2": { "type": "string", "description": "Second piece of reference data to be used on the package label. This is used as the PO Number for FedEx or Reference Number 2 for UPS (not used for DHL or TNT).", "minLength": 1, "maxLength": 35 }, "labelReferenceData3": { "type": "string", "description": "Third piece of reference data to be used on the package label. This is used as the Invoice Number for FedEx (not used for UPS, DHL, or TNT).", "minLength": 1, "maxLength": 35 }, "linearUomEnum": { "type": "string", "description": "Unit of measure for height, width, and length parameters.", "enum": [ "Inches", "Feet", "Centimeters", "Meters" ] }, "loadingTypeEnum": { "type": "string", "description": "Describes how trailer will need to be loaded.\n * `CRANE` - Top/crane\n * `REAR` - Rear\n * `SIDE` - Side\n * `REAR/SIDE` - Rear/side\n * `TOP/SIDE` - Top/side\n * `DOCK` - Dock\n * `STRING` - String\n * `STRING/TOW` - String/tow\n", "enum": [ "CRANE", "REAR", "SIDE", "REAR/SIDE", "TOP/SIDE", "DOCK", "STRING", "STRING/TOW" ] }, "marinePollutantCategory": { "type": "string", "description": "Indicates the Marine Pollutant Category for Hazardous Materials.\n * `Severe Marine Pollutant`\n * `Marine Pollutant`\n", "enum": [ "SevereMarinePollutant", "MarinePollutant" ] }, "movementTypeEnum": { "type": "string", "description": "Specifies movement type of the shipment:\n * `OD` - \"Origin Dray\"\n * `DD` - \"Destination Dray\"\n * `OPDP` - \"Origin Port to Destination Port\"\n * `OPDD` - \"Origin Port to Destination Door\"\n * `ODDP` - \"Origin Door to Destination Port\"\n * `ODDD` - \"Origin Door to Destination Door\"\n * `ORDP` - \"Origin Ramp to Destination Port\"\n * `OPDR` - \"Origin Port to Destination Ramp\"\n * `ORDD` - \"Origin Ramp to Destination Door \"\n * `ODDR` - \"Origin Door to Destination Ramp\"\n * `ORDR` - \"Origin Ramp to Destination Ramp\"\n * `OADA` - \"Origin Airport to Destination Airport\"\n * `OADD` - \"Origin Airport to Destination Door\"\n * `ODDA` - \"Origin Door to Destination Airport\"\n * `ODOC` - \"Origin Door to Origin CFS\"\n * `ODDC` - \"Origin Door to Destination CFS\"\n * `OCDC` - \"Origin CFS to Destination CFS\"\n * `OCDD` - \"Origin CFS to Destination Door\"\n * `DCDD` - \"Destination CFS to Destination Door\"\n * `OCDP` - \"Origin CFS to Destination Port\"\n * `OPDC` - \"Origin Port to Destination CFS\"\n", "enum": [ "OD", "DD", "OPDP", "OPDD", "ODDP", "ODDD", "ORDP", "OPDR", "ORDD", "ODDR", "ORDR", "OADA", "OADD", "ODDA", "ODOC", "ODDC", "OCDC", "OCDD", "DCDD", "OCDP", "OPDC" ] }, "orderAddress": { "type": "object", "description": "Object that contains address specific information.", "required": [ "address1", "city", "stateProvinceCode", "postalCode", "country" ], "properties": { "address1": { "type": "string", "minimum": 1, "maximum": 200, "description": "Indicate address line one of the location." }, "address2": { "type": "string", "minimum": 1, "maximum": 200, "description": "Indicate address line two of the location." }, "address3": { "type": "string", "minimum": 1, "maximum": 200, "description": "Indicate address line three of the location." }, "address4": { "type": "string", "minimum": 1, "maximum": 200, "description": "Indicate address line four of the location." }, "city": { "type": "string", "minimum": 1, "maximum": 100, "description": "Indicate the city of the location." }, "county": { "type": "string", "minimum": 1, "maximum": 100, "description": "Indicate the county of the location." }, "lat": { "type": "number", "format": "float", "minimum": -90, "maximum": 90, "description": "Indicate the latitude of the location." }, "long": { "type": "number", "format": "float", "minimum": -180, "maximum": 180, "description": "Indicate the longitude of the location" }, "stateProvinceCode": { "$ref": "#/$defs/stateProvinceCodeEnum" }, "postalCode": { "type": "string", "minimum": 1, "maximum": 20, "description": "Indicate the postal code of the location, sometime refered to as the zip code." }, "country": { "$ref": "#/$defs/countryCodeEnum" } } }, "orderBillTo": { "type": "object", "description": "Object containing bill to information.", "required": [ "customerCode", "currencyCode" ], "properties": { "customerCode": { "type": "string", "minimum": 1, "maximum": 50, "description": "C.H. Robinson defined bill to customer code. **This will be provided by your C.H. Robinson rep**." }, "charges": { "type": "array", "description": "Charges", "items": { "$ref": "#/$defs/charge" } }, "currencyCode": { "$ref": "#/$defs/currencyCodeEnum" }, "freightTerms": { "$ref": "#/$defs/freightTermEnum" }, "contacts": { "type": "array", "description": "Contacts", "items": { "$ref": "#/$defs/contact" } }, "referenceNumbers": { "type": "array", "description": "Additional reference number objects pertaining to this bill to object.", "items": { "$ref": "#/$defs/referenceNumber" } } } }, "orderCustomer": { "type": "object", "description": "Object containing customer information.", "required": [ "customerCode" ], "properties": { "customerCode": { "type": "string", "minimum": 1, "maximum": 50, "description": "C.H. Robinson defined customer code. **This will be provided by your C.H. Robinson rep**." }, "contacts": { "type": "array", "description": "Contacts", "items": { "$ref": "#/$defs/contact" } }, "referenceNumbers": { "type": "array", "description": "Additional reference number objects pertaining to the customer object.", "items": { "$ref": "#/$defs/referenceNumber" } } } }, "orderItem": { "required": [ "packagingType", "quantity" ], "type": "object", "properties": { "packagingType": { "$ref": "#/$defs/packageCodeEnum" }, "itemId": { "type": "integer", "description": "Indicates the itemId. Distinct value by item that should only be used when sending shippingContainers, to link containers to their respective items." }, "quantity": { "type": "number", "format": "float", "description": "Quantity is the number of packagingType's." }, "description": { "type": "string", "minimum": 1, "maximum": 200, "description": "Customer defined description of the item." }, "productCode": { "type": "string", "minimum": 1, "maximum": 20, "description": "Customer defined code of the item." }, "freightClass": { "$ref": "#/$defs/freightClassEnum" }, "weight": { "type": "number", "description": "Total Weight of the line item. This represents to total weight of the all quantities. For example, if the indvidual weight of 1 quantity is 100 pounds, and the quantity of the line item is 2, then 200 is the value for this field.", "format": "float" }, "weightUnitOfMeasure": { "$ref": "#/$defs/weightUomEnum" }, "packagingLength": { "type": "number", "description": "The length of the line item packaging.", "format": "float" }, "packagingWidth": { "type": "number", "description": "The width of the line item packaging.", "format": "float" }, "packagingHeight": { "type": "number", "description": "The height of the line item packaging.", "format": "float" }, "packagingUnitOfMeasure": { "$ref": "#/$defs/linearUomEnum" }, "relationships": { "$ref": "#/$defs/relationships" }, "equipmentLength": { "type": "number", "format": "float", "description": "Indicates the length of the equipment needed to transport the item." }, "equipmentHeight": { "type": "number", "format": "float", "description": "Indicates the height of the equipment needed to transport the item." }, "equipmentWidth": { "type": "number", "format": "float", "description": "Indicates the width of the equipment needed to transport the item." }, "equipmentUnitOfMeasure": { "$ref": "#/$defs/linearUomEnum" }, "totalTrailerFeetUsed": { "type": "integer", "description": "Total feet item(s) will utilize inside the trailer." }, "itemEquipment": { "$ref": "#/$defs/itemEquipment" }, "packagingVolume": { "type": "number", "format": "float", "description": "Volume of the item." }, "packagingVolumeUnitOfMeasure": { "$ref": "#/$defs/volumeUomEnum" }, "insuranceValue": { "type": "number", "format": "float", "description": "Customer specified declared value of the item." }, "pallets": { "type": "number", "format": "float", "description": "Identifies how many pallets for the item." }, "palletSpaces": { "type": "number", "format": "float", "description": "Indentifies how many pallet spaces the item will use in the cargo space." }, "nationalMotorFreightClass": { "type": "string", "minimum": 1, "maximum": 50, "description": "The National Motor Freight Traffic Association publishes the National Motor Freight Classification® (NMFC®), a standard that provides a comparison of commodities moving in commerce. The NMFC® is developed and maintained by the Commodity Classification Standards Board (CCSB)." }, "hazardousProperties": { "$ref": "#/$defs/hazardousProperties" }, "upcNumber": { "type": "string", "minimum": 1, "maximum": 50, "description": "Universal Product Code. The barcode consists of a five digit manufacturer number and a five digit product number." }, "skuNumber": { "type": "string", "minimum": 1, "maximum": 50, "description": "Stock Keeping Unit. A number assigned to a product by a the customer." }, "pluNumber": { "type": "string", "minimum": 1, "maximum": 50, "description": "Price Look-up Number. A system of numbers the customer uses that uniquely identifies bulk produce" }, "isStackable": { "type": "boolean", "description": "Parameter to indicate if item(s) can be stacked one on top of the other." }, "isTemperatureSensitive": { "type": "boolean", "description": "Parameter to indicate if item(s) needs to be kept between specific temperatures." }, "temperatureType": { "$ref": "#/$defs/temperatureSensitiveEnum" }, "temperatureUnit": { "$ref": "#/$defs/temperatureUomEnum" }, "requiredTemperatureHigh": { "type": "number", "description": "The highest temperature the item(s) can be.", "format": "float" }, "requiredTemperatureLow": { "type": "number", "description": "The lowest temperature the item(s) can be.", "format": "float" }, "notes": { "type": "string", "minimum": 1, "maximum": 4000, "description": "Allows customer to add notes about the item." }, "referenceNumbers": { "type": "array", "description": "Additional reference number objects pertaining to this item.", "items": { "$ref": "#/$defs/referenceNumber" } } } }, "orderLocation": { "type": "object", "required": [ "type" ], "description": "Indicates the locations assigned to this service. All service objects only have two location objects. If you have multiple stops, they need to broken into single pick, single drop pairs, each under its own service object.", "properties": { "customerLocationId": { "type": "string", "minimum": 1, "maximum": 50, "description": "Customer defined identifier associated to a specific location. \n\n### If C.H. Robinson maintains a list of the customer's location IDs, then customerLocationId can be provided in lieu of address information." }, "type": { "type": "string", "description": "Indicates the type of stop.", "enum": [ "origin", "destination" ] }, "name": { "type": "string", "minimum": 1, "maximum": 100, "description": "Name of the location. If the address of the location is not in C.H. Robinson's system, it is mandatory to include the `name` parameter so\n C.H. Robinson can auto-create the location in our system on order create.\n" }, "address": { "$ref": "#/$defs/orderAddress" }, "blindLocation": { "$ref": "#/$defs/blindLocation" }, "openDateTime": { "type": "string", "format": "date-time", "description": "ISO8601 UTC date-time of the earliest time carrier can arrive at the stop." }, "closeDateTime": { "type": "string", "format": "date-time", "description": "ISO8601 UTC date-time of the latest time carrier can arrive at the stop." }, "arrivalDate": { "type": "string", "format": "date-time", "description": "ISO8601 UTC date-time that carrier has arrived. \n\n ### Would only ever be sent on an order update if customer received the information instead of C.H. Robinson." }, "departureDate": { "type": "string", "format": "date-time", "description": "ISO8601 UTC date-time that carrier has departed. \n\n ### Would only ever be sent on an order update if customer received the information instead of C.H. Robinson." }, "scheduledOpenDateTime": { "type": "string", "format": "date-time", "description": "ISO8601 UTC date-time of the earliest recommended appointment time for your carrier." }, "scheduledCloseDateTime": { "type": "string", "format": "date-time", "description": "ISO8601 UTC date-time of the latest recommended appointment time for your carrier." }, "readyAvailableDateTime": { "type": "string", "format": "date-time", "description": "ISO8601 UTC date-time when location is ready to receive the shipment. \n\n ### Would only be sent if the location type is destination." }, "rsDateTime": { "type": "string", "format": "date-time", "description": "An ISO8601 UTC date-time when location is ready for shipment to be picked up.\n\n ### Would only be sent if the location type is origin." }, "specialRequirement": { "$ref": "#/$defs/specialRequirementOrder" }, "scalesRequired": { "type": "boolean", "description": "Indicates if order requires weighing at this location." }, "hasDropTrailer": { "type": "boolean", "description": "Indicates if this location is drop trailer." }, "loadingTypeCode": { "$ref": "#/$defs/loadingTypeEnum" }, "specialInstructions": { "type": "string", "minimum": 1, "maximum": 500, "description": "Customer defined instructions for this location." }, "contacts": { "type": "array", "description": "Contacts", "items": { "$ref": "#/$defs/contact" } }, "referenceNumbers": { "type": "array", "description": "Additional reference number objects pertaining to this location.", "items": { "$ref": "#/$defs/referenceNumber" } }, "isResidential": { "$ref": "#/$defs/isResidential" }, "sequenceNumber": { "type": "integer", "description": "Drives sequence of multistop orders; 1-based (does not start with 0)" } } }, "orderPackage": { "required": [ "packagingType" ], "type": "object", "properties": { "packageType": { "$ref": "#/$defs/packageCodeEnum" }, "parcelPackageType": { "$ref": "#/$defs/parcelPackageCodeEnum" }, "weight": { "type": "number", "description": "Total weight of the package.", "format": "float" }, "length": { "type": "number", "description": "The length of the package.", "format": "float" }, "width": { "type": "number", "description": "The width of the package.", "format": "float" }, "height": { "type": "number", "description": "The height of the package.", "format": "float" }, "packageUnitOfMeasure": { "$ref": "#/$defs/linearUomEnum" }, "volume": { "type": "number", "format": "float", "description": "Volume of the package." }, "packageVolumeUnitOfMeasure": { "$ref": "#/$defs/volumeUomEnum" }, "weightLb": { "type": "number", "description": "Total weight of the package in standard pounds.", "format": "float" }, "declaredValue": { "type": "number", "format": "float", "description": "Insurance valuation of package." }, "codAmount": { "type": "number", "format": "float", "description": "Cash on deliver amount for the package." }, "trackingNumber": { "type": "string", "minimum": 1, "maximum": 100, "description": "Tracking number assigned to package." }, "notes": { "type": "string", "minimum": 1, "maximum": 100, "description": "A place for customer to put package level notes." } } }, "orderService": { "type": "object", "description": "Object containing service information.", "required": [ "locations", "items" ], "properties": { "dateCalculationRule": { "type": "string", "description": "Selected promise date.\n\n* `promisedShipDate` - Identifies the pick up date as promised to customer. \n* `promisedDeliveryDate` - Identifies the delivery date as promised to customer.", "enum": [ "promisedShipDate", "promisedDeliveryDate" ] }, "serviceLevel": { "$ref": "#/$defs/serviceLevelEnum" }, "suggestedScac": { "type": "string", "minimum": 1, "maximum": 10, "description": "Indicates a specific carrier SCAC customer wishes to associate to the order." }, "isCritical": { "type": "boolean", "description": "Indicates if the order is critical." }, "isDangerous": { "type": "boolean", "description": "Indicates if the order contains dangerous item." }, "isHot": { "type": "boolean", "description": "Indicates if the item is hot." }, "isHighValue": { "type": "boolean", "description": "Indicates if the item is high value." }, "isPartial": { "type": "boolean", "description": "Indicates if the item is partial." }, "suggestedCarrierPartyCode": { "type": "string", "minimum": 1, "maximum": 25, "description": "C.H. Robinson identifier for a carrier customer wishes to associate to the order." }, "routeCode": { "type": "string", "description": "Identifies the routing pattern needed to deliver this order." }, "sellMode": { "$ref": "#/$defs/sellModeEnum" }, "locations": { "type": "array", "minimum": 2, "maximum": 2, "description": "The locations on the order.", "items": { "$ref": "#/$defs/orderLocation" } }, "items": { "type": "array", "description": "The item(s) on the order.", "items": { "$ref": "#/$defs/orderItem" } }, "packages": { "type": "array", "description": "The package(s) on the order.", "items": { "$ref": "#/$defs/orderPackage" } }, "collectOnDelivered": { "type": "array", "description": "Collect on Deliver", "items": { "$ref": "#/$defs/collectOnDelivered" } }, "referenceNumbers": { "type": "array", "description": "Additional reference number objects pertaining to this service.", "items": { "$ref": "#/$defs/referenceNumber" } }, "isTeam": { "type": "boolean", "description": "Indicates if the order requires team service." }, "incoTerms": { "$ref": "#/$defs/incoTermsEnum" }, "incoTermsNamedLocation": { "type": "string", "description": "Name of Inco term location." }, "customEquipmentType": { "type": "string", "description": "This field represents a custom value used to describe equipment. The list is specific to each customer and is coordinated with the C.H Robinson account team. Only agreed upon values will function properly in Navisphere®. It is the responsibility of the customer to supply correct values. This field is used primarily by TMC customers. Reach out to your TMC Representative for more information." }, "parcelDeliveryServices": { "type": "object", "description": "Used to specify special delivery service options (these services may incur additional charges).", "properties": { "saturdayDelivery": { "type": "boolean", "description": "Used to indicate Saturday Delivery Service (this service may incur additional charges)." }, "deliveryConfirmation": { "type": "string", "description": "Used on specify if signature is required on delivery (this service may incur additional charges).", "enum": [ "SignatureRequired", "AdultSignatureRequired", "NotRequired" ] } } } } }, "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" ] }, "parcelPackageCodeEnum": { "type": "string", "default": "CUSTPKG", "description": "Used to specify if carrier-specific branded packaging is used for a parcel shipment. \n\nFor a detailed description of all enumerated codes please find them here.", "enum": [ "FDXNVLP", "FDXPK", "FDXBX", "FDXTB", "FDX10KGBX", "FDX25KGBX", "UPSLTTR", "UPSTUB", "UPSPK", "UPSXPRSSBX", "UPS25KGBX", "UPS10KGBX", "UPSPLLT", "USPSPCKG", "USPSCRD", "USPSLTTR", "USPSPRCL", "USPSMDUMFLTRTBX", "USPSFLTRTNVLP", "USPSRRGULRPRCL", "USPSLRGFLTRTBX", "USPSLRGPRCL", "USPSVRSZDPRCL", "USPSSMLLFLTRTBX", "USPSFLTRTLGLNVLP", "USPSFLTRTPDDDNVLP", "USPSFLTRTGFTCRDNVLP", "USPSFLTRTWNDWNVLP", "USPSFLTRTCRDBRDNVLP", "USPSSMLLFLTRTNVLP", "USPSDVDFLTRTBX", "USPSLRGVDFLTRTBX", "USPSRGNLRTBX", "USPSRGNLRTBXB", "DHLLBPK", "DHLBX", "DHLLTTR", "CUSTPKG", "UPSSmallExpressBox", "UPSMediumExpressBox", "UPSLargeExpressBox" ] }, "payerTypeEnum": { "type": "string", "description": "Indicates which party involved in the shipment is responsible for payment.", "enum": [ "Sender", "Recipient", "Third_Party" ] }, "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." } } }, "relationships": { "type": "object", "description": "Object to specify master and inner pack qantities.", "properties": { "innerPackQuantity": { "type": "number", "format": "float", "description": "Indicates smallest unit that will be sold." }, "innerPackUomCode": { "$ref": "#/$defs/packageCodeEnum" }, "masterPackQuantity": { "type": "number", "format": "float", "description": "Indicates quantity that contains total quantity of innerpack items." } } }, "sellModeEnum": { "type": "string", "description": "Defines the mode:\n * `LTL` - Less than Truckload Transportation\n * `TL` - Truckload Transportation\n * `DomesticAir` - Domestic Air Transportation\n * `Ocean` - Ocean Transportation\n * `IMDL` - Intermodal Full Container Transportation\n * `Bulk` - Bulk Transportation\n * `Consolidated` - Consolidated Transportation\n * `LTLFlatbed` - Less than Truckload Flatbed Transportation\n * `TLFlatbed` - Truckload Flatbed Transportation\n * `SmallParcel` - Small Parcel Transportation\n * `Tautliner` - Tatliner Transportation\n", "enum": [ "LTL", "TL", "LTLFlatbed", "TLFlatbed", "IMDL", "Bulk", "Consolidated", "DomesticAir", "SmallParcel,", "Ocean", "Tautliner" ] }, "serviceLevelEnum": { "type": "string", "description": "C.H. Robinson defined code for a service offering.\n\nFor a detailed description of all enumerated codes please find them here.", "enum": [ "S", "P", "EXP", "T/R", "DED", "TD", "SD-NFO", "SD-CH", "ND-AM", "ND-PM", "3RD", "ECON", "BOX", "BTC", "HOP", "ISO", "COFC", "TOFC", "LB", "PC", "S-AIR", "FCL", "LCL", "MCL", "RORO", "NFO", "SAMEDAY", "NEXT-CARGO", "PRTY AM", "SD-CARGO", "SD-AM", "SD-PM", "TD-NEXT", "TD-2D", "TD-3D", "TD-ECO", "CHARTER", "CORP-ND", "SEC-ND", "ECON-ND", "DEF", "PRTY", "DC", "OGC", "CARGO", "COMM", "SD-US", "ND-8", "ND-10", "ND-3", "2D-AM", "2D-PM", "3D", "DEF-R", "DEF-G", "DEF-CAD", "INTL-S", "INTL-3", "INTL-5", "FDXSTNDRDVRNGHT", "FDXFRSTVRNGHT", "FDX2DY", "FDXXPRSSSVR", "FDXINTLPRRTY", "FDXINTLCNMY", "FDXINTLFRST", "FDX1DYFRGHT", "FDX2DYFRGHT", "FDX3DYFRGHT", "FDXGRND", "FDXGRNDHMDLVRY", "FDXINTLPRRTYFRGHT", "FDXINTLCNMYFRGHT", "FDXRPFRSTINTLPRRTY", "UPSNXTDYR", "UPS2NDDYR", "UPSGRUND", "UPSWRLDWDXPRSSSM", "UPSWRLDWDXPDTDSM", "UPSSTNDRD", "UPS3DYSLCT", "UPSNXTDYRSVR", "UPSNXTDYRRLY.M.", "UPSWRLDWDXPRSSPLUSSM", "UPS2NDDYR.M.", "UPSSVR", "USPSFRST-CLSSML", "USPSPRRTYML", "USPSMDML(SNGL-PC)", "USPSNTLRMLM-BGS", "USPSPRRTYMLINTL", "USPSXPRSSML", "DHLINTLDOCSRVC", "DHLINTLDOCLTTRSRVC", "DHLWRLDWDPRRTYXPRSS", "PRLTRAIR9:00A", "PRLTRAIR10:30A", "PRLTRR", "PRLTRGRND", "PRLTRGRND9:00A", "PRLTRGRND10:30A", "PRLTRAIRUSA", "PRLTRGRNDUSA", "PRLTRINTLAIR", "FDXPRRTYVRNGHT", "Same", "Next", "2Day", "3Day", "Ground", "FDXHOMEDEL", "FDX2DYAM", "UPSWRLDWDXPRSSS", "UPSBSC", "UPSSP", "UPSSPU1LB", "UPSSPM", "UPSSPBPM", "UPSRTRNSFLEX", "USPSLibraryMail", "USPSStandardPost", "USPSFirstClassMailInt", "USPSPriorityMailInt", "USPSParcelSelect", "USPSStandardMail", "USPSCriticalMail", "USPSFirstClassPkgInt", "FDXSMPSTSELECT", "FDXSMPSTMEDIA", "FDXSMPSTBOUND", "FDXSMPSTPRESORT", "BARTOLINIXPRSS", "SEURXPRSS", "DHLDOMXPRSS", "DHLDOMXPRSS9", "DHLDOMXPRSS12", "DHLXPRSS9", "DHLXPRSS12", "DHLECONSELECT", "DHLXPRSSWWDOCECX", "DHLXPRSSWWDOCDOX", "DHLECONSELECTDOC", "DHLXPRSS9DOC", "DHLXPRSS12DOC", "FDXINTLPRRTYDIRECT", "TNTXPRSS9", "TNTXPRSS10", "TNTXPRSS12", "TNTXPRSS", "TNTECONXPRSS", "TNTDOMXPRSS", "TNTECONXPRSS12", "TNTNEXTDAY9", "TNTNEXTDAY10", "TNTNEXTDAY12", "TNTNEXTDAY", "DHLPEPFORYOU", "DHLPEPEUROPACK", "DHLPEPEUROPLUS", "DHLDOMECONSELECT", "UPSEXPEDITED", "SINGPOST", "CORREIOS", "TNTXPRSS8", "TNTBUSPAK8", "TNTBUSPAK9", "TNTBUSPAK10", "TNTBUSPAK12", "TH", "IHRC", "IHPR", "IHPA", "QSEZPRRTYDM", "SPPRRTYSGI", "SPPRRTYSGO", "SFXSTANDARD", "SFXSSAMEDAY", "SFXNEXTDAY", "SFXECON", "QSDSTD", "CHD", "OHD" ] }, "shipmentContainerTypeEnum": { "type": "string", "description": "Type of shipping container. \n\nFor a detailed description of all enumerated codes please find them here.", "enum": [ "20CO", "20FR", "20FT", "20HC", "20HD", "20HP", "20IS", "20IT", "20NR", "20OT", "20PL", "20RE", "20RF", "20SD", "20SO", "20UG", "24FT", "24HC", "28FB", "30IS", "40CA", "40CO", "40DR", "40FB", "40FR", "40FT", "40H0", "40HC", "40HD", "40HP", "40MA", "40NR", "40OT", "40RE", "40RF", "40RH", "40RR", "43FT", "45HC", "45HR", "45RF", "45TR", "48FB", "48TR", "53TR", "55TR", "BBLK", "LCL", "PAR", "RORO", "20GH", "40GH", "20FC", "20DR", "20FG", "20RH", "40FG", "40HF", "40HH", "40HL", "40HS", "40IN", "40RQ", "40TK", "42GP", "45DR", "45FR", "45GP", "45HD", "45HT", "45RH", "48HC", "53HC", "20PF", "20SL", "40HR", "42TR", "LOLO", "20PW", "40PW", "40PH", "45PH", "40OH", "28TR" ] }, "shippingContainerItems": { "type": "object", "required": [ "containerId", "itemId" ], "properties": { "containerId": { "type": "integer", "description": "ID of the container." }, "itemId": { "type": "integer", "description": "Indicates the item ID." } } }, "shippingContainers": { "type": "object", "required": [ "containerId" ], "properties": { "containerId": { "type": "integer", "description": "ID of the container." }, "containerType": { "$ref": "#/$defs/shipmentContainerTypeEnum" }, "containerStatus": { "type": "string", "description": "Indicates the container status.", "enum": [ "Booking Confirmed", "Arrived Pick Up Location", "Departed Pick Up Location", "In-Gate", "Rail Departure", "Loaded On Vessel", "Vessel Arrived", "Vessel Departed", "Unloaded from Vessel", "Out Gate", "Loaded on Rail", "Rail Arrived at Destination", "Arrived at Delivery Location", "Unloaded at Delivery Location", "Ordered", "Wheels Up", "Wheels Down" ] }, "declaredValue": { "type": "number", "format": "currency", "description": "Indicates the container declared value." }, "weightNet": { "type": "number", "format": "float", "description": "indicates the container net weight." }, "weightGross": { "type": "number", "format": "float", "description": "Indicates the container gross weight." }, "vgm": { "type": "number", "format": "float", "description": "VGM" }, "sealNum": { "type": "string", "description": "Indicates the container seal number." }, "containerNumber": { "type": "string", "description": "Indicates the container number." }, "weightUnit": { "$ref": "#/$defs/weightUomEnum" }, "currency": { "$ref": "#/$defs/currencyCodeEnum" }, "referenceNumbers": { "$ref": "#/$defs/referenceNumber" } } }, "specialRequirementOrder": { "type": "object", "properties": { "liftGate": { "type": "boolean", "description": "Indicates that a lift gate is needed." }, "insidePickup": { "type": "boolean", "description": "Indicates that inside pickup is needed. **Only used on the origin/pick stop**" }, "insideDelivery": { "type": "boolean", "description": "Indicates that inside delivery is needed. **Only used on the destination/drop stop**" }, "residentialNonCommercial": { "type": "boolean", "description": "Indicates that a stop is residential non-commercial." }, "limitedAccess": { "type": "boolean", "description": "Indicates that stop has limited access." }, "tradeShoworConvention": { "type": "boolean", "description": "Indicates that stop is a trade show or convention." }, "constructionSite": { "type": "boolean", "description": "Indicates that stop is a construction site." }, "dropOffAtCarrierTerminal": { "type": "boolean", "description": "Indicates that customer will drop off at carrier terminal. **Only used on the origin/pick stop**" }, "pickupAtCarrierTerminal": { "type": "boolean", "description": "Indicates that customer will pickup at carrier terminal. **Only used on the destination/drop stop**" }, "appointmentNotification": { "type": "boolean", "description": "Indicates that stop has an appointment notification. **Only used on the destination/drop stop**" }, "sortAndSegregate": { "type": "boolean", "description": "Indicates that items will need to be sorted at stop. **Only used on the destination/drop stop**" } } }, "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" ] }, "tarpTypeEnum": { "type": "string", "description": "Details the type of tarp required for flat bed trailer.\n * `10` - Ten Feet\n * `2` - Two Feet\n * `4` - Four Feet\n * `6` - Six Feet\n * `8` - Eight Feet\n * `MESH` - Nursery/Mesh\n * `NO TARP` - No Tarp Required\n * `SMOKE` - Smoke Tarp\n * `TOP` - Top\n", "enum": [ "10", "2", "4", "6", "8", "MESH", "NO TARP", "SMOKE", "TOP" ] }, "temperatureSensitiveEnum": { "type": "string", "description": "Indicates if temperature control is needed, and what level:\n * `Dry` - Dry\n * `Fresh` - Fresh (25 to 32 degrees)\n * `Frozen` - Frozen (-10 to 0 degrees)\n * `Chilled` - Chilled (40 to 60 degrees)\n * `DeepFrozen` - Deep Frozen (-20 to -20 degrees)\n * `Refrigerated` - Refrigerated (33 to 39 degrees)\n * `Protect` - Protect (33 to 60 degrees)\n * `Custom` - Custom\n * `Produce` - Produce\n * `Mixed` - Mixed\n * `Empty` - Empty\n", "enum": [ "Dry", "Fresh", "Frozen", "Chilled", "DeepFrozen", "Refrigerated", "Protect", "Produce", "Mixed", "Empty" ] }, "temperatureUomEnum": { "type": "string", "description": "Unit of measure for temperature parameters.", "enum": [ "Fahrenheit", "Celsius", "Empty" ] }, "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" ] } } }