--- title: "Award shipment to carrier" method: POST path: "/v2.0/shipments/truckload/{shipmentId}/award" tags: ["Truckload"] --- # Award shipment to carrier `POST /v2.0/shipments/truckload/{shipmentId}/award` ## Request - Base URL: `https://api.freightview.dev` - URL: `https://api.freightview.dev/v2.0/shipments/truckload/{shipmentId}/award` - Auth: OAuth 2 (client credentials, token URL `/v2.0/auth/token`) This endpoint can be used to award a truckload shipment to a carrier. - Add full address detail for each location. - Add contact information for each location. - Add location appointment times (if needed). - If creating a bill of lading, include all handling unit information in the `items` array. ## Path parameters - `shipmentId` string, required ## Request body - ExternalAwardLoadDTO - `quoteId` string, required: The unique identifier for the quote in Freightview. - `items` ExternalHandlingUnitDTO[]: The items (handling units) being transported as part of the shipment.
Note
Required if createBOL is true.
- `itemId` string: The identifier for the handling unit in Freightview. - `customsValue` number: The customs value of the handling unit. - `customsValueCurrency` 'usd': The currency code for the customs value. - `declaredValue` number: The declared value of the handling unit. - `declaredValueCurrency` 'usd': The currency code for the declared value. - `dimensionsUOM` 'in': The unit of measure for the handling unit dimensions (`length`, `width`, `height`). - `freightClass` 50 | 55 | 60 | 65 | 70 | 77.5 | 85 | 92.5 | 100 | 110 | 125 | 150 | 175 | 200 | 250 | 300 | 400 | 500: The freight class of the handling unit. - `height` number: The height of the handling unit. - `length` number: The length of the handling unit.
Note
Dimensions may be required depending on account settings. If one dimension value (length, width, or height) is specified, then all other dimension values must also be specified.
- `nmfcNumber` number: The NMFC code for the handling unit. - `nmfcSubNumber` number: The NMFC sub-code for the handling unit. - `quantity` number, required: The quantity of handling units in this `items` object. - `refNums` ItemRefNum[]: The reference numbers associated with the handling unit. - `type` 'other', required - `value` string, required - `width` number: The width of the handling unit. - `pickupLocationSequence` number, required: The location `sequence` number where the handling unit will be picked up. - `dropLocationSequence` number, required: The location `sequence` number where the handling unit will be dropped off. - `stackable` boolean: A flag to indicate whether the handling unit can be stacked. - `turnable` boolean: A flag to indicate whether the handling unit can be turned (not in use). - `weight` number, required: The weight of the handling unit. - `weightUOM` 'lbs', required: The unit of measure for the weight. - `description` string, required: A description of the handling unit contents. - `type` 'bag' | 'bale' | 'barrel' | 'basket' | 'beam' | 'bin' | 'box' | 'bucket' | 'bulkhead' | 'bulkfloor' | 'bundle' | 'can' | 'carboy' | 'carpet' | 'carton' | 'case' | 'cask' | 'chest' | 'coil' | 'container' | 'crate' | 'cylinder' | 'drum' | 'firkin' | 'gallon' | 'gaylord' | 'hamper' | 'hogshead' | 'jar' | 'jerrican' | 'keg' | 'kit' | 'liter' | 'loose' | 'ounce' | 'package' | 'pail' | 'pallet' | 'piece' | 'platform' | 'rack' | 'reel' | 'roll' | 'skid' | 'slipsheet' | 'spool' | 'stack' | 'tank' | 'tote' | 'trunk' | 'tub' | 'tube' | 'unit', required: The type of handling unit. - `contains` ExternalItemDTO[]: The contents of the handling unit. - `customsValue` number, nullable: The customs value of the item. - `customsValueCurrency` 'usd': The currency code of the customs value. - `declaredValue` number, nullable: The declared value of the item. - `declaredValueCurrency` 'usd': The currency code for the declared value. - `description` string, required: A description of the item contents. - `dimensionsUOM` 'in': The unit of measure for the item dimensions (`length`, `width`, `height`). - `freightClass` 50 | 55 | 60 | 65 | 70 | 77.5 | 85 | 92.5 | 100 | 110 | 125 | 150 | 175 | 200 | 250 | 300 | 400 | 500: The freight class of the item contents. - `height` number, nullable: The height of the item. - `length` number, nullable: The length of the item.
Note
Dimensions may be required depending on account settings. If one dimension value (length, width, or height) is specified, then all other dimension values must also be specified.
- `nmfcNumber` number: The NMFC code for the item contents. - `nmfcSubNumber` number: The NMFC sub-code for the item contents. - `quantity` number: The quantity of item contents. - `refNums` ItemRefNum[]: The reference numbers associated with the item. - `type` 'other', required - `value` string, required - `type` 'bag' | 'bale' | 'barrel' | 'basket' | 'beam' | 'bin' | 'box' | 'bucket' | 'bulkhead' | 'bulkfloor' | 'bundle' | 'can' | 'carboy' | 'carpet' | 'carton' | 'case' | 'cask' | 'chest' | 'coil' | 'container' | 'crate' | 'cylinder' | 'drum' | 'firkin' | 'gallon' | 'gaylord' | 'hamper' | 'hogshead' | 'jar' | 'jerrican' | 'keg' | 'kit' | 'liter' | 'loose' | 'ounce' | 'package' | 'pail' | 'pallet' | 'piece' | 'platform' | 'rack' | 'reel' | 'roll' | 'skid' | 'slipsheet' | 'spool' | 'stack' | 'tank' | 'tote' | 'trunk' | 'tub' | 'tube' | 'unit', required: The type of packaging for the item contents. - `weight` number: The weight of the item contents. - `weightUOM` 'lbs': The unit of measure for the weight of the item contents. - `width` number: The width of the item. - `hazardous` ExternalHazardousDetail[]: The hazardous material details. - `hazmatId` string, required: The UN/NA number for the hazardous material. - `permitNumber` string: The US DOT special permit number provided to a shipper as authorization to transport the hazardous material. - `primaryClass` '1.1A' | '1.1B' | '1.1C' | '1.1D' | '1.1E' | '1.1F' | '1.1G' | '1.1J' | '1.1L' | '1.2B' | '1.2C' | '1.2D' | '1.2E' | '1.2F' | '1.2G' | '1.2H' | '1.2J' | '1.2K' | '1.2L' | '1.3C' | '1.3F' | '1.3G' | '1.3H' | '1.3J' | '1.3K' | '1.3L' | '1.4B' | '1.4C' | '1.4D' | '1.4E' | '1.4F' | '1.4G' | '1.4S' | '1.5D' | '1.6N' | '2.1' | '2.2' | '2.3' | '3' | '4.1' | '4.2' | '4.3' | '5.1' | '5.2' | '6.1' | '6.2' | '7' | '8' | '9' | '9.2': Primary hazard class of the hazardous material. - `secondaryClass` '' | '2.1' | '2.2' | '2.3' | '3' | '4.1' | '4.2' | '4.3' | '5.1' | '5.2' | '6.1' | '6.2' | '7' | '8' | '9' | '9.2': Secondary hazard class of the hazardous material. - `tertiaryClass` '' | '2.1' | '2.2' | '2.3' | '3' | '4.1' | '4.2' | '4.3' | '5.1' | '5.2' | '6.1' | '6.2' | '7' | '8' | '9' | '9.2': Tertiary hazard class of the hazardous material. - `packingGroup` 'I' | 'II' | 'III': The packing group of the hazardous material. - `properShippingName` string: The authorized name designated by regulatory bodies (such as USDOT, IMDG, or IATA) to identify the hazardous material on shipping papers (e.g., "Aerosols, flammable"). - `technicalName` string: The specific chemical or technical name of the hazardous constituent. This is typically required in parentheses alongside the proper shipping name for generic or "Not Otherwise Specified" (N.O.S.) entries. - `reportableQuantity` boolean: Set to `true` if the shipment contains a hazardous substance in a quantity that equals or exceeds the Reportable Quantity (RQ) threshold as defined by environmental regulations. - `residueLastContained` boolean: Set to `true` if the packaging or bulk container is empty but still contains residue of the hazardous material from its last cargo. This is often required for shipping paper descriptions of empty bulk packagings. - `limitedQuantity` boolean: Set to `true` if the hazardous material is packaged and shipped under the "Limited Quantity" (LTD QTY) exception, which permits alternative packaging, labeling, and marking rules. - `marinePollutant` boolean: Set to `true` if the material is classified as a marine pollutant (an environmentally hazardous substance harmful to aquatic life), requiring specific package markings and shipping paper declarations. - `hazardous` ExternalHazardousDetail[]: The hazardous material details. - `hazmatId` string, required: The UN/NA number for the hazardous material. - `permitNumber` string: The US DOT special permit number provided to a shipper as authorization to transport the hazardous material. - `primaryClass` '1.1A' | '1.1B' | '1.1C' | '1.1D' | '1.1E' | '1.1F' | '1.1G' | '1.1J' | '1.1L' | '1.2B' | '1.2C' | '1.2D' | '1.2E' | '1.2F' | '1.2G' | '1.2H' | '1.2J' | '1.2K' | '1.2L' | '1.3C' | '1.3F' | '1.3G' | '1.3H' | '1.3J' | '1.3K' | '1.3L' | '1.4B' | '1.4C' | '1.4D' | '1.4E' | '1.4F' | '1.4G' | '1.4S' | '1.5D' | '1.6N' | '2.1' | '2.2' | '2.3' | '3' | '4.1' | '4.2' | '4.3' | '5.1' | '5.2' | '6.1' | '6.2' | '7' | '8' | '9' | '9.2': Primary hazard class of the hazardous material. - `secondaryClass` '' | '2.1' | '2.2' | '2.3' | '3' | '4.1' | '4.2' | '4.3' | '5.1' | '5.2' | '6.1' | '6.2' | '7' | '8' | '9' | '9.2': Secondary hazard class of the hazardous material. - `tertiaryClass` '' | '2.1' | '2.2' | '2.3' | '3' | '4.1' | '4.2' | '4.3' | '5.1' | '5.2' | '6.1' | '6.2' | '7' | '8' | '9' | '9.2': Tertiary hazard class of the hazardous material. - `packingGroup` 'I' | 'II' | 'III': The packing group of the hazardous material. - `properShippingName` string: The authorized name designated by regulatory bodies (such as USDOT, IMDG, or IATA) to identify the hazardous material on shipping papers (e.g., "Aerosols, flammable"). - `technicalName` string: The specific chemical or technical name of the hazardous constituent. This is typically required in parentheses alongside the proper shipping name for generic or "Not Otherwise Specified" (N.O.S.) entries. - `reportableQuantity` boolean: Set to `true` if the shipment contains a hazardous substance in a quantity that equals or exceeds the Reportable Quantity (RQ) threshold as defined by environmental regulations. - `residueLastContained` boolean: Set to `true` if the packaging or bulk container is empty but still contains residue of the hazardous material from its last cargo. This is often required for shipping paper descriptions of empty bulk packagings. - `limitedQuantity` boolean: Set to `true` if the hazardous material is packaged and shipped under the "Limited Quantity" (LTD QTY) exception, which permits alternative packaging, labeling, and marking rules. - `marinePollutant` boolean: Set to `true` if the material is classified as a marine pollutant (an environmentally hazardous substance harmful to aquatic life), requiring specific package markings and shipping paper declarations. - `equipment` ApiEquipmentDTO: The equipment for the shipment. - `accessorials` ApiEquipmentAccessorialDTO[]: The accessorials associated with the equipment. - `chains` - Only applicable for flatbed equipment. - `e-track` - Only applicable for dry van equipment. - `food-grade` - Only applicable for dry van and refrigerated equipment. - `load-bars` - Only applicable for dry van equipment. - `tarps` - Only applicable for flatbed equipment. - `temp` - Only applicable for refrigerated equipment. - `straps` - Only applicable for dry van, box truck, straight truck, and flatbed equipment. - `protect-from-freezing` Only applicable for LTL equipment. - `single-shipment` Only applicable for LTL equipment. - `liftgate` - Only applicable for dry van, straight truck, and box truck equipment. - `team-driver` - Applicable for all equipment types. - `tanker-endorsement` - Only applicable for dry van, flatbed, and refrigerated equipment. - `oversize-overweight` - Only applicable for flatbed equipment. - `key` 'chains' | 'e-track' | 'food-grade' | 'load-bars' | 'tarps' | 'temp' | 'straps' | 'protect-from-freezing' | 'single-shipment' | 'liftgate' | 'team-driver' | 'tanker-endorsement' | 'oversize-overweight', required: The identifier for the accessorial. - `locations` BookedLocationDTO[], required: The shipment's locations, e.g. origin, destination and any stops in between. - `company` string, required: Company name for the location. - `address` string, required: Address line 1 for the location. - `address2` string: Address line 2 for the location. - `address3` string: Address line 3 for the location (Only valid for MX locations). - `city` string: City for the location. - `state` string: Two character US state / CA province abbreviation for the location. Three character abbreviation for MEX states (https://www.iso.org/obp/ui/#iso:code:3166:MX). - `postalCode` string, required: Postal code of the location in US, Canadian or Mexican format. Valid formats (USA): - `10111` - `10111-1111` Valid formats (Canada): - `A9A9A9` - `A9A 9A9` - `A9A-9A9` - `country` 'us' | 'ca' | 'mx', required: Two character country code for the location. ("mx" must be enabled on account) - `stopDate` string, date: The date of the stop at the location. - `stopDateType` 'on' | 'by': An indicator of whether the stop should be made on the stop date, or by the stop date. - `stopType` 'pickup' | 'delivery' | 'both', required: An indicator of whether freight will be picked up, delivered, or both at this stop. - `sequence` number, required: The sequence of the location within the shipment, starting at 0. - `accessorials` LocationAccessorialDTO[]: The accessorials associated with the location. - `key` 'schedule' | 'driver-assist' | 'notify' | 'limited-access' | 'inside' | 'tradeshow' | 'residential' | 'sort-and-segregate' | 'construction-site' | 'farm' | 'military' | 'airport' | 'place-of-worship' | 'school' | 'mine' | 'pier' | 'liftgate' | 'twic': An accessorial associated with the location. Can be the type of location (e.g. `residential` and/or an activity to be performed at the location (e.g. `schedule`, `sort-and-segregate`). - `opensAt` string: The start time of the appointment in 24-hr time. (Only for accessorial key of `schedule`). - `closesAt` string: The end time of the appointment in 24-hr time. (Only for accessorial key of `schedule`). - `refNums` LocationRefNum[]: Reference numbers for the location. - `type` 'other', required: The type of reference number. - `value` string, required: The value of the reference number. - `opensAt` string, required: The time the location will open in 24-hr format. - `closesAt` string, required: The time the location will close in 24-hr format. - `contactName` string: The name of a contact person at the location. - `contactEmail` string: The email address for the contact at the location. - `contactPhone` string: The phone number for the contact at the location. - `contactPhoneExt` string: The phone number extension for the contact at the location. - `instructions` string: The special instructions for the location. - `flatbedHandlingType` 'crane' | 'dock-height' | 'rear' | 'rear-side' | 'side' | 'string' | 'string-and-tow' | 'top-side': The type of handling required for flatbed shipments at this location. - `createBOL` boolean: A flag to indicate whether a Bill of Lading should be created for the shipment. - `schedulePickup` boolean: A flag to indicate whether the shipment should be scheduled with the carrier for pickup. - `customsBroker` ExternalCustomsBroker: The customs broker information for the shipment.
Note
Required to book shipment if the shipment crosses international borders.
- `address` string: The address line 1 of the customs broker. - `address2` string: The address line 2 of the customs broker. - `city` string: The city of the customs broker. - `companyName` string, required: The company name of the customs broker. - `country` 'us': The two-digit country code for the customs broker. - `email` string, email: The email address of the customs broker. - `phone` string, required: The phone number of the customs broker. - `phoneExt` string: The phone number extension of the customs broker. - `postalCode` string: The postal code of the customs broker in US or Canadian format. Valid formats (USA): - `10111` - `10111-1111` Valid formats (Canada): - `A9A9A9` - `A9A 9A9` - `A9A-9A9` - `state` string: The two-digit state / province code for the customs broker. - `type` 'import' | 'export': The role of the customs broker. - `customsBrokers` ExternalCustomsBroker[]: The customs broker information for the shipment.
Note
Required to book shipment if the shipment crosses international borders.
- `address` string: The address line 1 of the customs broker. - `address2` string: The address line 2 of the customs broker. - `city` string: The city of the customs broker. - `companyName` string, required: The company name of the customs broker. - `country` 'us': The two-digit country code for the customs broker. - `email` string, email: The email address of the customs broker. - `phone` string, required: The phone number of the customs broker. - `phoneExt` string: The phone number extension of the customs broker. - `postalCode` string: The postal code of the customs broker in US or Canadian format. Valid formats (USA): - `10111` - `10111-1111` Valid formats (Canada): - `A9A9A9` - `A9A 9A9` - `A9A-9A9` - `state` string: The two-digit state / province code for the customs broker. - `type` 'import' | 'export': The role of the customs broker. - `emergencyContact` ApiEmergencyContactDTO: The emergency contact information for the shipment
Note
Required to book shipment if any items on the shipment are hazardous.
- `name` string, required: The emergency contact name. - `phone` string, required: The emergency contact phone number. - `phoneExt` string: The emergency contact phone number extension. - `contractNumber` string: The contract number with the emergency contact. - `billTo` ApiBillToDTO: The bill-to information for the shipment. - `company` string, required: The company name for the billing party. - `address` string, required: The address line 1 for the billing party. - `address2` string: The address line 2 for the billing party. - `address3` string: The address line 3 for the billing party (only valid for MX addresses). - `city` string, required: The city for the billing party. - `state` string, required: Two character state / province abbreviation for the location. - `postalCode` string, required: Postal code of for the billing party in US or Canadian format. Valid formats (USA): - `10111` - `10111-1111` Valid formats (Canada): - `A9A9A9` - `A9A 9A9` - `A9A-9A9` - `country` 'us' | 'ca' | 'mx': The two character country code for the billing party. ("mx" must be enabled on account) - `contactName` string, required: The contact name for the billing party. - `contactPhone` string: The phone number for the billing party. - `contactPhoneExt` string: The phone number extension for the billing party. - `contactEmail` string, email, required: The email address for the billing party. - `bolNumber` string: The Bill of Lading number for the shipment. Auto-generated by Freightview upon awarding unless value provided by shipper. - `shareShipmentEmails` string[]: An array of email addresses with which to share the shipment. This will allow the email recipient to view the shipment bill of lading and tracking status. ## Response `204` No Content ## Other responses - `400`: Bad Request - `401`: Unauthorized - `402`: Payment Required - `403`: Forbidden - `404`: Not Found - `429`: Rate Limit Exceeded - `500`: Internal Server Error --- [API](https://skmtc.dev/freightview/apis/freightview-api-v2-0.md) · [All operations](https://skmtc.dev/freightview/apis/freightview-api-v2-0/llms.txt) · [OpenAPI document](https://skmtc.dev/freightview/apis/freightview-api-v2-0/revisions/8f35f3ad0a29?raw)