Coyote Logistics · Schema

LoadCommodity

Commodity

freight brokeragelogisticstruckloadLTLless-than-truckloadshippingsupply chainfreight quotesshipment trackingload management3PLcustoms brokeragecarrier APIshipper API

Properties

Name Type Description
description string Item Description (Description must be 100 characters or less.)
poNumber string PO Number
packagingType object
quantity integer Number of units
palletCount integer Number of pallets relevant to commodity item **Required for LTL**
weightUnit object
weight number Pallet weight in lbs(default) if not specified **Required for LTL**
lengthUnit object
length number Pallet length in inches **Required for LTL**
height number Pallet height in inches **Required for LTL**
width number Pallet width in inches **Required for LTL**
freightClass object
nmfcNumber integer NMFC Number
nmfcSubNumber integer NMFC Sub number
cargoValue number Cargo value
stackable boolean Stackable
temperatureUnit object
temperatureSetting object
preCoolTemperature number PreCool temperature if required
minimumTemperature number Minimum temperature setting
maximumTemperature number Maximum temperature setting
pickUpStopNumber integer Pick up stop number for commodity
deliveryStopNumber integer Delivery stop number for commodity
hazMatProperties object
View JSON Schema on GitHub

JSON Schema

loadcommodity.json Raw ↑ 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "LoadCommodity",
  "x-source-schema": "Coyote.Systems.ExternalApi.Contracts.Models.LoadBuilding.LoadCommodity",
  "required": [
    "cargoValue",
    "description",
    "packagingType",
    "quantity",
    "weight"
  ],
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Item Description (Description must be 100 characters or less.)"
    },
    "poNumber": {
      "type": "string",
      "description": "PO Number",
      "nullable": true
    },
    "packagingType": {
      "$ref": "#/components/schemas/Coyote.Systems.ExternalApi.Contracts.Models.PackagingType"
    },
    "quantity": {
      "type": "integer",
      "description": "Number of units",
      "format": "int32"
    },
    "palletCount": {
      "type": "integer",
      "description": "Number of pallets relevant to commodity item\r\n\r\n**Required for LTL**",
      "format": "int32"
    },
    "weightUnit": {
      "$ref": "#/components/schemas/Coyote.Systems.ExternalApi.Contracts.Models.Enums_WeightUnitType"
    },
    "weight": {
      "type": "number",
      "description": "Pallet weight in lbs(default) if not specified\r\n\r\n**Required for LTL**",
      "format": "double"
    },
    "lengthUnit": {
      "$ref": "#/components/schemas/Coyote.Systems.ExternalApi.Contracts.Models.Enums_LengthUnitType"
    },
    "length": {
      "type": "number",
      "description": "Pallet length in inches\r\n\r\n**Required for LTL**",
      "format": "double"
    },
    "height": {
      "type": "number",
      "description": "Pallet height in inches\r\n\r\n**Required for LTL**",
      "format": "double"
    },
    "width": {
      "type": "number",
      "description": "Pallet width in inches\r\n\r\n**Required for LTL**",
      "format": "double"
    },
    "freightClass": {
      "$ref": "#/components/schemas/Coyote.Systems.ExternalApi.Contracts.Models.Enums_FreightClass"
    },
    "nmfcNumber": {
      "type": "integer",
      "description": "NMFC Number",
      "format": "int32",
      "nullable": true
    },
    "nmfcSubNumber": {
      "type": "integer",
      "description": "NMFC Sub number",
      "format": "int32",
      "nullable": true
    },
    "cargoValue": {
      "type": "number",
      "description": "Cargo value",
      "format": "double"
    },
    "stackable": {
      "type": "boolean",
      "description": "Stackable"
    },
    "temperatureUnit": {
      "$ref": "#/components/schemas/Coyote.Systems.ExternalApi.Contracts.Models.TemperatureUnit"
    },
    "temperatureSetting": {
      "$ref": "#/components/schemas/Coyote.Systems.ExternalApi.Contracts.Models.TemperatureSettingType"
    },
    "preCoolTemperature": {
      "type": "number",
      "description": "PreCool temperature if required",
      "format": "double",
      "nullable": true
    },
    "minimumTemperature": {
      "type": "number",
      "description": "Minimum temperature setting",
      "format": "double",
      "nullable": true
    },
    "maximumTemperature": {
      "type": "number",
      "description": "Maximum temperature setting",
      "format": "double",
      "nullable": true
    },
    "pickUpStopNumber": {
      "type": "integer",
      "description": "Pick up stop number for commodity",
      "format": "int32"
    },
    "deliveryStopNumber": {
      "type": "integer",
      "description": "Delivery stop number for commodity",
      "format": "int32"
    },
    "hazMatProperties": {
      "$ref": "#/components/schemas/Coyote.Systems.ExternalApi.Contracts.Models.LoadBuilding.HazMatProperties"
    }
  },
  "additionalProperties": false,
  "description": "Commodity"
}