C.H. Robinson · Schema

loadBookV2

JSON payload to book a carrier to an available shipment.

FreightLogisticsShippingSupply ChainTransportationTransportation ManagementFortune 500

Properties

Name Type Description
loadNumber integer C.H. Robinson provided shipment identifier.
carrierCode string C.H. Robinson defined code for the carrier.
emptyDateTime string ISO8601 UTC date-time the trailer is empty and driver is on his way to the pick up.
emptyLocation object
availableLoadCosts array Array of the bin cost object. The fields for this object are informed by the avaialble shipments response message (availableLoadCost)
rateConfirmation object
View JSON Schema on GitHub

JSON Schema

ch-robinson-worldwide-load-book-v2-schema.json Raw ↑
{
  "$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-load-book-v2-schema.json",
  "title": "loadBookV2",
  "description": "JSON payload to book a carrier to an available shipment.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ch-robinson-worldwide-shipments-api-openapi.yml#/components/schemas/loadBookV2",
  "type": "object",
  "required": [
    "loadNumber",
    "carrierCode",
    "emailAddress",
    "availableLoadCosts",
    "rateConEmail",
    "rateConName"
  ],
  "properties": {
    "loadNumber": {
      "type": "integer",
      "format": "base32 integer",
      "description": "C.H. Robinson provided shipment identifier."
    },
    "carrierCode": {
      "type": "string",
      "description": "C.H. Robinson defined code for the carrier."
    },
    "emptyDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "ISO8601 UTC date-time the trailer is empty and driver is on his way to the pick up."
    },
    "emptyLocation": {
      "$ref": "#/$defs/emptyLocationV2"
    },
    "availableLoadCosts": {
      "type": "array",
      "description": "Array of the bin cost object. The fields for this object are informed by the avaialble shipments response message (availableLoadCost)",
      "minimum": 1,
      "items": {
        "$ref": "#/$defs/binCost"
      }
    },
    "rateConfirmation": {
      "$ref": "#/$defs/rateConfirmation"
    }
  },
  "$defs": {
    "binCost": {
      "type": "object",
      "description": "Book it now cost object that is informed by the avaialble shipments response message (availableLoadCost).",
      "required": [
        "currencyCode",
        "sourceCostPerUnit",
        "units"
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Indicates the type of cost."
        },
        "code": {
          "$ref": "#/$defs/rateCodeEnum"
        },
        "description": {
          "type": "string",
          "description": "Cost description."
        },
        "currencyCode": {
          "$ref": "#/$defs/currencyCodeEnum"
        },
        "sourceCostPerUnit": {
          "type": "number",
          "format": "float",
          "description": "Amount of cost by unit."
        },
        "units": {
          "type": "integer",
          "description": "Count of the cost."
        }
      }
    },
    "countryCodeEnum": {
      "type": "string",
      "description": "Indicate the country of the location. \n\nFor a detailed description of all enumerated codes please find them <a href=\"https://api.navisphere.com/api/B2B/Portal/v1/documents/descriptions/CountryCodes.xlsx\" target=\"_blank\">here</a>.",
      "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 <a href=\"https://api.navisphere.com/api/B2B/Portal/v1/documents/descriptions/CurrencyCodeDescriptions.xlsx\" target=\"_blank\">here</a>.",
      "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"
      ]
    },
    "emptyLocationV2": {
      "type": "object",
      "required": [
        "city",
        "state",
        "country"
      ],
      "description": "Indicates the location of the carrier where they are empty and moving towards the pick up location.",
      "properties": {
        "city": {
          "type": "string",
          "description": "Indicates the city the carrier is empty."
        },
        "state": {
          "type": "string",
          "description": "Indicates the state/province code where the carrier is empty."
        },
        "country": {
          "$ref": "#/$defs/countryCodeEnum"
        },
        "zip": {
          "type": "string",
          "description": "Indicates the postal code the carrier is empty."
        }
      }
    },
    "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 <a href=\"https://api.navisphere.com/api/B2B/Portal/v1/documents/descriptions/RateCodeDescriptions.xlsx\" target=\"_blank\">here</a>.",
      "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"
      ]
    },
    "rateConfirmation": {
      "type": "object",
      "required": [
        "name",
        "emailAddress"
      ],
      "description": "Indicates the individual who is confirming the rate.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the person who is confirming the rate.",
          "minimum": 1,
          "maximum": 50
        },
        "email": {
          "type": "string",
          "description": "E-mail address of the person who is confirming the rate.",
          "minimum": 1,
          "maximum": 50
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/ch-robinson-worldwide-load-book-v2"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.