quotes

{
  "$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-quotes-schema.json",
  "title": "quotes",
  "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/quotes",
  "type": "array",
  "minimum": 1,
  "items": {
    "$ref": "#/$defs/quote"
  },
  "$defs": {
    "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 <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"
      ]
    },
    "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"
        }
      }
    },
    "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"
          }
        }
      }
    },
    "quote": {
      "type": "object",
      "description": "Object containing information for quote order.",
      "required": [
        "quoteId"
      ],
      "properties": {
        "quoteId": {
          "type": "integer",
          "format": "int64",
          "description": "Quote ID that was received from the rating API call."
        },
        "customer": {
          "$ref": "#/$defs/orderCustomer"
        },
        "billTo": {
          "$ref": "#/$defs/quoteBillTo"
        },
        "service": {
          "$ref": "#/$defs/quoteService"
        },
        "origin": {
          "$ref": "#/$defs/quoteLocation"
        },
        "destination": {
          "$ref": "#/$defs/quoteLocation"
        },
        "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."
              }
            }
          }
        },
        "notes": {
          "type": "string",
          "minimum": 1,
          "maximum": 4000,
          "description": "A place for customer to put quote order level notes."
        },
        "referenceNumbers": {
          "type": "array",
          "description": "Additional reference number objects pertaining to the order.",
          "items": {
            "$ref": "#/$defs/referenceNumber"
          }
        }
      }
    },
    "quoteBillTo": {
      "type": "object",
      "description": "Object containing bill to information.",
      "properties": {
        "currencyCode": {
          "$ref": "#/$defs/currencyCodeEnum"
        },
        "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"
          }
        }
      }
    },
    "quoteLocation": {
      "type": "object",
      "description": "Object containing quote location information.",
      "properties": {
        "customerLocationId": {
          "type": "string",
          "description": "Customer specified ID for the location."
        },
        "locationName": {
          "type": "string",
          "description": "Name of the location.",
          "deprecated": true
        },
        "name": {
          "type": "string",
          "description": "Name of the location."
        },
        "address": {
          "$ref": "#/$defs/orderAddress"
        },
        "phone": {
          "type": "string",
          "description": "Phone number associated to quote location."
        },
        "emailAddress": {
          "type": "string",
          "description": "E-mail address associated to quote location."
        },
        "contactName": {
          "type": "string",
          "description": "Contact name associated to quote location."
        },
        "requestedShipDateOpen": {
          "type": "string",
          "format": "date-time",
          "description": "An ISO8601 UTC date-time of the earliest time carrier can arrive at the location.",
          "deprecated": true
        },
        "openDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "An ISO8601 UTC date-time of the earliest time carrier can arrive at the location."
        },
        "requestedShipDateClose": {
          "type": "string",
          "format": "date-time",
          "description": "An ISO8601 UTC date-time of the latest time carrier can arrive at the location.",
          "deprecated": true
        },
        "closeDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "An ISO8601 UTC date-time of the latest time carrier can arrive at the location."
        },
        "specialInstructions": {
          "type": "string",
          "description": "A place for customer to put location specific instructions."
        },
        "referenceNumbers": {
          "type": "array",
          "description": "Additional reference number objects pertaining to this location.",
          "items": {
            "$ref": "#/$defs/referenceNumber"
          }
        }
      }
    },
    "quoteService": {
      "type": "object",
      "description": "Object containing quote service information.",
      "properties": {
        "referenceNumbers": {
          "type": "array",
          "description": "Additional reference number objects pertaining to this service.",
          "items": {
            "$ref": "#/$defs/referenceNumber"
          }
        },
        "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."
        },
        "isHot": {
          "type": "boolean",
          "description": "Indicates if the item is hot."
        }
      }
    },
    "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 <a href=\"https://api.navisphere.com/api/B2B/Portal/v1/documents/descriptions/ReferenceNumberTypes.xlsx\" target=\"_blank\">here</a>.",
          "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 <a href=\"https://api.navisphere.com/api/B2B/Portal/v1/documents/descriptions/StateProvinceCodes.xlsx\" target=\"_blank\">here</a>.",
      "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"
      ]
    }
  }
}