C.H. Robinson · Schema

visibilityOrder

Order Created by the Shipper

FreightLogisticsShippingSupply ChainTransportationTransportation ManagementFortune 500

Properties

Name Type Description
customerName string Customer Name
orderNumber number Order Number
tenantId string This ID indicates who the underlying customer is.
accountType string Business unit or Product group associated to this order
orderStatus string Current status of order.
premiumFreightReasonCode string Reason code for order's expedited or premium service
metadata string meta data assoicted to the order
createdDateTime string An ISO8601 UTC date-time
sourceName string Source Name with the order
packagingType object
quantity number Quantities on the order.
weight number Total Weight of the order.
weightUnitOfMeasure object
orderLength number The length of the order's packaging.
ordergWidth number The width of the order's packaging.
orderHeight number The height of the order's packaging.
orderUnitOfMeasure object
volume number The volume of the order's packaging.
volumeUnitOfMeasure object
locations array
handlingUnits array
View JSON Schema on GitHub

JSON Schema

ch-robinson-worldwide-visibility-order-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-visibility-order-schema.json",
  "title": "visibilityOrder",
  "description": "Order Created by the Shipper",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ch-robinson-worldwide-visibility-api-openapi.yml#/components/schemas/visibilityOrder",
  "type": "object",
  "required": [
    "orderNumber",
    "createdDateTime",
    "tenantId"
  ],
  "properties": {
    "customerName": {
      "type": "string",
      "minimum": 1,
      "maximum": 20,
      "description": "Customer Name"
    },
    "orderNumber": {
      "type": "number",
      "minimum": 1,
      "maximum": 20,
      "description": "Order Number"
    },
    "tenantId": {
      "type": "string",
      "minimum": 1,
      "maximum": 20,
      "description": "This ID indicates who the underlying customer is."
    },
    "accountType": {
      "type": "string",
      "minimum": 1,
      "maximum": 10,
      "description": "Business unit or Product group associated to this order"
    },
    "orderStatus": {
      "type": "string",
      "minimum": 1,
      "maximum": 10,
      "description": "Current status of order.",
      "enum": [
        "active",
        "cancelled",
        "planned"
      ]
    },
    "premiumFreightReasonCode": {
      "type": "string",
      "minimum": 1,
      "maximum": 50,
      "description": "Reason code for order's expedited or premium service"
    },
    "metadata": {
      "type": "string",
      "description": "meta data assoicted to the order"
    },
    "createdDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "An ISO8601 UTC date-time"
    },
    "sourceName": {
      "type": "string",
      "minimum": 1,
      "maximum": 20,
      "description": "Source Name with the order"
    },
    "packagingType": {
      "$ref": "#/$defs/packageCodeEnum"
    },
    "quantity": {
      "type": "number",
      "description": "Quantities on the order."
    },
    "weight": {
      "type": "number",
      "description": "Total Weight of the order.",
      "format": "float"
    },
    "weightUnitOfMeasure": {
      "$ref": "#/$defs/weightUomEnum"
    },
    "orderLength": {
      "type": "number",
      "description": "The length of the order's packaging.",
      "format": "float"
    },
    "ordergWidth": {
      "type": "number",
      "description": "The width of the order's packaging.",
      "format": "float"
    },
    "orderHeight": {
      "type": "number",
      "description": "The height of the order's packaging.",
      "format": "float"
    },
    "orderUnitOfMeasure": {
      "$ref": "#/$defs/linearUomEnum"
    },
    "volume": {
      "type": "number",
      "description": "The volume of the order's packaging."
    },
    "volumeUnitOfMeasure": {
      "$ref": "#/$defs/volumeUomEnum"
    },
    "locations": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/visibilityLocation"
      }
    },
    "handlingUnits": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/handlingUnit"
      }
    }
  },
  "$defs": {
    "commodity": {
      "required": [
        "pickLocSequenceNumber",
        "dropLocSequenceNumber"
      ],
      "type": "object",
      "properties": {
        "commodityId": {
          "type": "string",
          "minimum": 1,
          "maximum": 20,
          "description": "Unique identifier"
        },
        "orderNumber": {
          "type": "string",
          "minimum": 1,
          "maximum": 20,
          "description": "Indicates the order number associated to the item."
        },
        "name": {
          "type": "string",
          "minimum": 1,
          "maximum": 50,
          "description": "Name of the commodity."
        },
        "units": {
          "type": "number",
          "minimum": 1,
          "maximum": 50,
          "description": "Number of commodities."
        },
        "sku": {
          "type": "string",
          "minimum": 1,
          "maximum": 50,
          "description": "Indicates the sku of the commodity."
        },
        "plannerCode": {
          "type": "string",
          "minimum": 1,
          "maximum": 50,
          "description": "The Planners Code associated to the commodity."
        },
        "value": {
          "type": "number",
          "minimum": 1,
          "maximum": 50,
          "description": "Value of the commodity."
        },
        "currencyCode": {
          "type": "string",
          "minimum": 1,
          "maximum": 10,
          "description": "ISO 4217 currency code"
        },
        "serialNumber": {
          "type": "string",
          "minimum": 1,
          "maximum": 50,
          "description": "Serial Number of the commodity."
        },
        "partNumber": {
          "type": "string",
          "minimum": 1,
          "maximum": 50,
          "description": "Part Number of the commodity."
        },
        "isHazMat": {
          "type": "boolean",
          "description": "Flag indicates if the commodity is Hazmat."
        },
        "pickLocSequenceNumber": {
          "type": "integer",
          "description": "The associated pick location sequence number."
        },
        "dropLocSequenceNumber": {
          "type": "integer",
          "description": "The associated drop location sequence number."
        },
        "category": {
          "type": "string",
          "minimum": 1,
          "maximum": 50,
          "description": "Category of the commodity, model number or other categorization descriptor."
        },
        "description": {
          "type": "string",
          "minimum": 1,
          "maximum": 100,
          "description": "Description of the item."
        },
        "packagingType": {
          "$ref": "#/$defs/packageCodeEnum"
        },
        "weight": {
          "type": "number",
          "description": "Total Weight of the item.",
          "format": "float"
        },
        "weightUnitOfMeasure": {
          "$ref": "#/$defs/weightUomEnum"
        },
        "packagingLength": {
          "type": "number",
          "description": "The length of the item's packaging.",
          "format": "float"
        },
        "packagingWidth": {
          "type": "number",
          "description": "The width of the item's packaging.",
          "format": "float"
        },
        "packagingHeight": {
          "type": "number",
          "description": "The height of the item's packaging.",
          "format": "float"
        },
        "packagingUnitOfMeasure": {
          "$ref": "#/$defs/linearUomEnum"
        },
        "packagingVolume": {
          "type": "number",
          "format": "float",
          "description": "Volume of the item."
        },
        "packagingVolumeUnitOfMeasure": {
          "$ref": "#/$defs/volumeUomEnum"
        },
        "packageQuantity": {
          "type": "number",
          "format": "float",
          "description": "Quantity of Packages."
        },
        "purchaseOrderNumber": {
          "type": "string",
          "minimum": 1,
          "maximum": 20,
          "format": "float",
          "description": "Purchase Order number for associated item."
        },
        "costCenterCode": {
          "type": "number",
          "minimum": 1,
          "maximum": 10,
          "format": "float",
          "description": "Cost center code associated to the items."
        },
        "referenceNumbers": {
          "type": "array",
          "description": "Reference number associated to the given level.",
          "items": {
            "$ref": "#/$defs/referenceNumber"
          }
        }
      }
    },
    "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"
      ]
    },
    "handlingUnit": {
      "type": "object",
      "description": "Object containing commodity (or group of commodities)",
      "required": [
        "locations",
        "items"
      ],
      "properties": {
        "handlingUnitId": {
          "type": "string",
          "minimum": 1,
          "maximum": 20,
          "description": "Handling unit ID"
        },
        "orderNumbers": {
          "type": "array",
          "description": "Array of the Order numbers associated to the handling units.",
          "minimum": 1,
          "maximum": 25,
          "items": {
            "type": "string"
          }
        },
        "packagingType": {
          "$ref": "#/$defs/packageCodeEnum"
        },
        "quantity": {
          "type": "number",
          "description": "Quantity of handling units"
        },
        "freightClass": {
          "$ref": "#/$defs/freightClassEnum"
        },
        "weight": {
          "type": "number",
          "description": "Total Weight of the item.",
          "format": "float"
        },
        "weightUnitOfMeasure": {
          "$ref": "#/$defs/weightUomEnum"
        },
        "packagingLength": {
          "type": "number",
          "description": "The length of the item's packaging.",
          "format": "float"
        },
        "packagingWidth": {
          "type": "number",
          "description": "The width of the item's packaging.",
          "format": "float"
        },
        "packagingHeight": {
          "type": "number",
          "description": "The height of the item's packaging.",
          "format": "float"
        },
        "packagingUnitOfMeasure": {
          "$ref": "#/$defs/linearUomEnum"
        },
        "packageTrackingNumber": {
          "type": "string",
          "minimum": 1,
          "maximum": 150,
          "description": "Package Tracking Number"
        },
        "volume": {
          "type": "number",
          "description": "The volume of the item's packaging"
        },
        "volumeUnitOfMeasure": {
          "$ref": "#/$defs/volumeUomEnum"
        },
        "containerNumber": {
          "type": "string",
          "minimum": 1,
          "maximum": 20,
          "description": "Container Number"
        },
        "description": {
          "type": "string",
          "minimum": 1,
          "maximum": 100,
          "description": "Description of the handling unit."
        },
        "pickLocSequenceNumber": {
          "type": "integer",
          "description": "The associated stop sequence number for which this handling unit will be picked up."
        },
        "dropLocSequenceNumber": {
          "type": "integer",
          "description": "The associated stop sequence number for which this handling unit will be delivered."
        },
        "commodities": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/commodity"
          }
        }
      }
    },
    "linearUomEnum": {
      "type": "string",
      "description": "Unit of measure for height, width, and length parameters.",
      "enum": [
        "Inches",
        "Feet",
        "Centimeters",
        "Meters"
      ]
    },
    "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 <a href=\"https://api.navisphere.com/api/B2B/Portal/v1/documents/descriptions/PackageDescriptions.xlsx\" target=\"_blank\">here</a>.",
      "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"
      ]
    },
    "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."
        }
      }
    },
    "visibilityLocation": {
      "type": "object",
      "description": "All locations associated with the order.",
      "required": [
        "locationId",
        "sequenceNumber",
        "stopRole",
        "name",
        "address1",
        "countryCode"
      ],
      "properties": {
        "locationId": {
          "type": "string",
          "minimum": 1,
          "maximum": 20,
          "description": "Unique Identifier"
        },
        "sequenceNumber": {
          "type": "number",
          "description": "Beginning at 0, increasing sequentially with each location in stop order"
        },
        "stopRole": {
          "type": "string",
          "description": "Stop role of the location",
          "enum": [
            "pick",
            "drop",
            "crossDock",
            "destinationAirport",
            "destinationPort",
            "destinationTerminal",
            "intermediaryAirport",
            "intermediaryPort",
            "intermediaryRamp",
            "originAirport",
            "originPort",
            "originRamp",
            "originTerminal",
            "originForwarder",
            "originCrossdock",
            "destinationForwarder",
            "destinationCrossdock",
            "destinationRamp",
            "dropyard",
            "supplier",
            "shipper",
            "consignee",
            "origin",
            "destination",
            "broker",
            "agent",
            "factory"
          ]
        },
        "name": {
          "type": "string",
          "minimum": 1,
          "maximum": 200,
          "description": "Name of the location"
        },
        "address1": {
          "type": "string",
          "minimum": 1,
          "maximum": 100,
          "description": "Indicate address line 1"
        },
        "address2": {
          "type": "string",
          "minimum": 1,
          "maximum": 100,
          "description": "Indicate address line 2"
        },
        "city": {
          "type": "string",
          "minimum": 1,
          "maximum": 100,
          "description": "Indicate City"
        },
        "stateProvinceCode": {
          "type": "string",
          "minimum": 1,
          "maximum": 50,
          "description": "Indicate State or Province"
        },
        "postalCode": {
          "type": "string",
          "minimum": 1,
          "maximum": 20,
          "description": "Indicate Postal codes"
        },
        "countryCode": {
          "type": "string",
          "minimum": 1,
          "maximum": 2,
          "description": "Indicate 2 digit country code utilizing ISO 3166-1 alpha-2"
        },
        "requested": {
          "type": "string",
          "format": "date-time",
          "description": "Order need by date, enter close date time if window time is provided in an ISO8601 format."
        },
        "openDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Beginning of order need by window, enter requested date if no window time is provided in an ISO8601 format."
        },
        "closeDateTime": {
          "type": "string",
          "format": "date-time",
          "description": "End of order need by window, enter requested date if no window time is provided in an ISO8601 format."
        },
        "unlocationCode": {
          "type": "string",
          "description": "The UN Location Code for the stop location.",
          "minimum": 1,
          "maximum": 10
        },
        "iata": {
          "type": "string",
          "description": "International Air Transport Association (IATA)",
          "minimum": 1,
          "maximum": 10
        },
        "referenceNumbers": {
          "type": "array",
          "description": "Array of the Stops associated to the shipment.",
          "items": {
            "$ref": "#/$defs/referenceNumber"
          }
        }
      }
    },
    "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"
      ]
    }
  }
}

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-visibility-order"
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.

GitHub Google LinkedIn

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