---
title: "Create & rate shipment"
method: POST
path: "/v2.0/shipments/parcel"
tags: ["Parcel"]
---
# Create & rate shipment
`POST /v2.0/shipments/parcel`
## Request
- Base URL: `https://api.freightview.dev`
- URL: `https://api.freightview.dev/v2.0/shipments/parcel`
- Auth: OAuth 2 (client credentials, token URL `/v2.0/auth/token`)
This endpoint can be used to create a parcel shipment.
- A successfully created shipment returns a `shipmentId` with a `status` of
`pending`, and echoes the shipment data passed in.
- The `shipmentId` should be used as the path parameter for the [book shipment](#tag/Parcel/operation/parcelBookShipment) endpoint.
- The response also includes any additional default data from Freightview (e.g. a location's latitude, longitude, & timezone, and the bill-to information (based on the direction of the shipment if none was specified in the create request).
Important
The
quotes array in the response will only be populated if
returnQuotes=true was specified as a query parameter.
## Query parameters
- `carriers` string
- `returnQuotes` boolean
- `waitDuration` integer
## Request body
- CreateParcelShipment
- `pickupDate` string, date, required: The date when the shipment should be picked up. Must be ISO 8601 format. **YYYY-MM-DD** Must be today or later.
- `schedulePickup` boolean: A flag that determines whether a pickup request is sent to the parcel carrier when the shipment is booked. Tip
If the origin location has a daily/recurring pickup with the carrier, set to
false.
- `origin` object, required: The origin information for the shipment.
- `company` string: Company name for the pickup location.
- `address` string: Address line 1 for the pickup location.
- `address2` string: Address line 2 for the pickup location.
- `city` string: City for the pickup location.
- `state` string: Two character state abbreviation for the pickup location.
- `postalCode` string, required: Postal code of the shipment's origin location.
- `country` string, required: Country code for the pickup location.
- `shipType` 'business dock' | 'residential': For parcel, a location is assumed to be a business, unless this field is set to `residential`.
- `contactName` string: Name of a contact person at the pickup location.
- `contactEmail` string, email: Email for the contact at the pickup location.
- `contactPhone` string: Phone number for the contact at the pickup location.
- `contactPhoneExt` string: Phone extension for the contact at the pickup location.
- `refNums` object[]: An array of reference numbers associated with the origin location. _(Only one reference number for the origin location is currently supported)._
- `type` 'other', required: The reference number type.
- `value` string, required: The reference number value.
- `opensAt` string: The time the origin location will be open for pickups in 24-hour format. Format **(08:00)**
- `closesAt` string: The time the origin location will close for pickups in 24-hour format. Format **(17:00)**
- `destination` object, required: The destination information for the shipment.
- `company` string: Company name for the destination location.
- `address` string: Address line 1 for the destination location.
- `address2` string: Address line 2 for the destination location.
- `city` string: City for the destination location.
- `state` string: Two character state abbreviation for the destination location.
- `postalCode` string, required: Postal code of the shipment's destination location.
- `country` string, required: Country code for the destination location.
- `shipType` 'business dock' | 'residential': For parcel, a location is assumed to be a business, unless this field is set to `residential`.
- `contactName` string: Name of a contact person at the destination location.
- `contactEmail` string, email: Email for the contact at the destination location.
- `contactPhone` string: Phone number for the contact at the destination location.
- `contactPhoneExt` string: Phone extension for the contact at the destination location.
- `refNums` object[]: An array of reference numbers associated with the origin location. _(Only one reference number for the destination location is currently supported)._
- `type` 'other', required: The reference number type.
- `value` string, required: The reference number value.
- `signature` 'none' | 'required' | 'adult' | 'indirect': Signature requirement for delivery. Note
indirect signature is only supported by FedEx, and only for
residential shipments.
- `items` ParcelItem[], required: Each parcel package must be a separate object in the `items` array.
- union
- object
- `description` string: Description of this item.
- `type` 'custom', required: Custom packaging type for this item.
- `weight` integer, required: Total weight of this item in pounds.
- `length` integer: The length of the this item in inches. 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.
- `width` integer: Width of this item in inches.
- `height` integer: Height of this item in inches.
- `nonStandard` boolean: Indicates that the packaging is non-standard (i.e. un-boxed/crated, not fully enclosed in cardboard).
- `declaredValue` number: The declared value amount (in US dollars) for this item.
- object
- `description` string: Description of this item.
- `type` 'fedex-envelope' | 'fedex-pak' | 'fedex-box' | 'fedex-small-box' | 'fedex-medium-box' | 'fedex-large-box' | 'fedex-extra-large-box' | 'fedex-tube' | 'fedex-10kg-box' | 'fedex-25kg-box' | 'ups-letter' | 'ups-tube' | 'ups-pak' | 'ups-express-box-small' | 'ups-express-box-medium' | 'ups-express-box-large' | 'ups-10kg-box' | 'ups-25kg-box', required: Packaging type for this item. See [list of parcel packaging types](#tag/Reference/Parcel-Packaging-Types) for more information.
- `weight` integer, required: Total weight of this item in pounds.
- `declaredValue` number: The declared value amount (in US dollars) for this item.
- `shareShipmentEmails` string[]: An array of email addresses with which to share the shipment. This will allow the email recipient to view the shipping labels and tracking status.
## Response `201`
Created
- RatingResponse
- `shipmentId` string: The unique identifier in Freightview for this shipment.
- `createdDate` string, date-time: Date / time when shipment was created.
- `pickupDate` string, date: The requested date for pickup of the shipment.
- `quotes` LTLExternalQuoteDTO[]: The quotes for the shipment. Important
Only populated if
returnQuotes=true was specified as a query parameter.
- `quoteId` string: The unique identifier for the quote in Freightview.
- `carrierId` string: The unique identifier for the carrier in Freightview.
- `createdDate` string: The date/time the quote was added to the shipment.
- `assetCarrierName` string: The name of the carrier transporting the shipment.
- `assetCarrierCode` string: The 4-digit SCAC code for the carrier transporting the shipment.
- `providerName` string: The name of the carrier providing the quote for the shipment. If the quote is provided by a broker, then this is different than the `assetCarrierName`, which is the carrier actually providing transportation of the freight.
- `providerCode` string: The 4-digit SCAC code for the carrier providing the quote for the shipment.
- `expirationDate` string, date: The expiration date of the quote.
- `quoteNum` string: The quote number specified by the carrier providing the quote.
- `serviceId` string: An identifier for the service.
- `serviceDescription` string: A description of the service.
- `pricingMethod` 'contracted' | 'capacity': The method of the pricing used for the quote.
- `pricingType` 'pallet' | 'dimensional' | 'spot' | 'tariff' | 'density': The type of pricing used for the quote.
- `pricingDescription` string: A description of the pricing used to calculate the quote.
- `amount` number: The total amount of this quote. Includes linehaul, fuel, and all additional charges.
- `currency` 'usd': The currency of the quote amount.
- `refNums` QuoteRefNum[]: The reference numbers associated with the quote.
- `type` 'contract-num' | 'other': The type of reference number.
- `value` string: The value of the reference number.
- `status` 'active' | 'awarded' | 'retracted' | 'error': The status of the quote within Freightview. - `active` - The quote is active in Freightview. - `awarded` - The shipper has selected the quote and awarded the shipment to the carrier. - `retracted` - The carrier has retracted the quote. - `error` - There was an error retrieving the quote.
- `method` 'api' | 'upload' | 'email' | 'manual': The method by which the quote was added to the shipment.
- `source` 'shipper' | 'carrier': The source of the quote.
- `charges` ExternalQuoteCharge[]: The breakdown of the various charges that make up the quote `amount`. _Not supported by all carriers._
- `name` string, required: The name of the charge. Examples: - `linehaul` - `discount` - `fuel` - `guaranteed` - `arrival schedule` - `liftgate delivery`
- `amount` number, required: The amount of the charge. Can be positive (for most charges), or negative (for discount amount).
- `type` string: The type of charge.
- `code` string: The code for the charge. Examples: - `LNH` - `linehaul` - `DSC` - `discount` - `FSC` - `fuel` - `GRS` - `guaranteed` - `APT` - `arrival schedule` - `LGD` - `liftgate delivery`
- `currency` 'usd', required: The currency of the charge.
- `transitDaysMin` number: The minimum number of transit days for the transport of the shipment.
- `transitDaysMax` number: The maximum number of transit days for the transport of the shipment.
- `interline` boolean: A flag that indicates whether another carrier will be used to provide a portion of the transportation of the shipment.
- `mode` 'truckload' | 'parcel' | 'ltl' | 'intermodal' | 'consolidated' | 'air' | 'ocean' | 'bulk': The mode of transport used for the shipment.
- `paymentTerms` 'outbound-prepaid' | 'outbound-collect' | 'inbound-collect' | 'third-party-prepaid' | 'third-party-collect': The payment terms used for the quote.
- `errors` ExternalQuoteError[]: The errors encountered when retrieving the quote.
- `type` string: The type of error.
- `message` string: The error message.
- `shipmentBookPageUrl` string: A direct link to book the shipment with this rate within Freightview.
- `equipmentType` 'ltl' | 'pup' | 'refrigerated-ltl' | 'volume-ltl': The type of equipment the carrier will use to transport the shipment.
- `time` integer: The provider rate response time in milliseconds.
- `status` 'pending': Shipment has been created.
- `locations` ExternalLocationDTO[]: The shipment's locations, e.g. origin & destination.
- `company` string: Company name for the location.
- `address` string: 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': Two character country code for the location. (`mx` must be enabled on account)
- `shipType` 'airport' | 'business dock' | 'business no dock' | 'construction' | 'farm' | 'grocery' | 'limited access' | 'military' | 'mine' | 'prison' | 'pier' | 'place of worship' | 'residential' | 'school' | 'trade show': The location type.
- `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': 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.
- `type` 'origin' | 'destination' | 'stop', required: An indicator of whether the location is the origin / destination of the shipment, or a stop in between.
- `lat` number: The latitude of the location.
- `lng` number: The longitude of the location.
- `timezone` string: The timezone of the location in [IANA timezone](https://www.iana.org/time-zones) format. e.g. `America/New_York`
- `opensAt` string: The time the location will open in 24-hr format.
- `closesAt` string: 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.
- `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.
- `equipment` 'box-truck-16' | 'box-truck-24' | 'hotshot' | 'ltl' | 'partial-dry-van' | 'partial-flatbed' | 'partial-refrigerated' | 'pup' | 'refrigerated-ltl' | 'sprinter-van' | 'straight-truck-20' | 'straight-truck-26' | 'volume-ltl': The type of equipment used for the transport of the shipment.
- `customsBrokers` ExternalCustomsBroker[]: The customs broker information for the shipment.
- `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.
- `items` LTLItem[]: The items (handling units) being transported as part of the shipment.
- `dimensionsUOM` 'in': The unit of measure for the dimensions values (`length`, `width`, `height`).
- `freightClass` 50 | 55 | 60 | 65 | 70 | 77.5 | 85 | 92.5 | 100 | 110 | 125 | 150 | 175 | 200 | 250 | 300 | 400 | 500: Freight class for the freight being shipped on the handling unit. Tip
Many carriers require freight class.
- `height` integer: The height of the handling unit.
- `length` integer: 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` integer: The NMFC code for the handling unit.
- `nmfcSubNumber` integer: The NMFC sub-code for the handling unit.
- `quantity` integer, required: The quantity of handling units in this `items` object.
- `width` integer: The width of the handling unit.
- `weight` integer, required: The weight of the handling unit. When omitted from the request, this is the sum of the commodity weights in `contains`.
- `weightUOM` 'lbs': The unit of measure for the weight.
- `description` string: A description of the handling unit contents.
- `type` 'bag' | 'bale' | 'basket' | 'box' | 'bundle' | 'carpet' | 'case' | 'coil' | 'crate' | 'cylinder' | 'drum' | 'jerrican' | 'keg' | 'pail' | 'pallet' | 'piece' | 'reel' | 'roll' | 'tote' | 'tube' | 'unit', required: The type of handling unit being shipped.
- `stackable` boolean: A flag to indicate whether the handling unit can be stacked.
- `contains` union: The contents of the handling unit. Provide a single commodity object, or an array of commodities for a mixed pallet. Note
Multiple commodities require access to mixed pallets. When there are multiple commodities,
weight,
freightClass,
nmfcNumber,
nmfcSubNumber,
isHazardous, and
hazardous must be set on each commodity and omitted from the handling unit. Responses return a single commodity as an object and multiple commodities as an array.
- LTLContainsItem: A commodity on the handling unit. Note
weight,
freightClass,
nmfcNumber,
nmfcSubNumber,
isHazardous, and
hazardous are only allowed on a commodity when your account has access to mixed pallets. Otherwise, set them on the handling unit.
- `quantity` integer, required: The number of pieces of this commodity on the handling unit.
- `type` 'bag' | 'bale' | 'basket' | 'box' | 'bundle' | 'carpet' | 'case' | 'coil' | 'crate' | 'cylinder' | 'drum' | 'gallon' | 'jerrican' | 'keg' | 'liter' | 'ounce' | 'pail' | 'piece' | 'reel' | 'roll' | 'tote' | 'tube', required: The type of commodity being shipped on the handling unit.
- `description` string: A description of the commodity.
- `weight` integer: The weight of the commodity. Note
Required on every commodity when the handling unit has multiple commodities. The handling unit weight is the sum of its commodity weights.
- `freightClass` 50 | 55 | 60 | 65 | 70 | 77.5 | 85 | 92.5 | 100 | 110 | 125 | 150 | 175 | 200 | 250 | 300 | 400 | 500: Freight class for the freight being shipped on the handling unit. Tip
Many carriers require freight class.
- `nmfcNumber` integer: The NMFC code for the commodity.
- `nmfcSubNumber` integer: The NMFC sub-code for the commodity.
- `isHazardous` boolean: A flag to indicate whether the commodity has hazardous materials.
- `hazardous` LTLHazardousDetail: The details of the hazardous material. Note
Required to book shipment when
isHazardous is
true.
- `hazmatId` string, required: The UN/NA hazardous material identification number for the item.
- `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': The primary hazard classification 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': The sub-risk hazard classification 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': The sub-risk hazard classification of the hazardous material.
- `packingGroup` 'I' | 'II' | 'III': The packing group that accords with the degree of danger of the hazardous material.
- `permitNumber` string: US DOT special permit number.
- `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.
- LTLContainsItem[]
- `quantity` integer, required: The number of pieces of this commodity on the handling unit.
- `type` 'bag' | 'bale' | 'basket' | 'box' | 'bundle' | 'carpet' | 'case' | 'coil' | 'crate' | 'cylinder' | 'drum' | 'gallon' | 'jerrican' | 'keg' | 'liter' | 'ounce' | 'pail' | 'piece' | 'reel' | 'roll' | 'tote' | 'tube', required: The type of commodity being shipped on the handling unit.
- `description` string: A description of the commodity.
- `weight` integer: The weight of the commodity. Note
Required on every commodity when the handling unit has multiple commodities. The handling unit weight is the sum of its commodity weights.
- `freightClass` 50 | 55 | 60 | 65 | 70 | 77.5 | 85 | 92.5 | 100 | 110 | 125 | 150 | 175 | 200 | 250 | 300 | 400 | 500: Freight class for the freight being shipped on the handling unit. Tip
Many carriers require freight class.
- `nmfcNumber` integer: The NMFC code for the commodity.
- `nmfcSubNumber` integer: The NMFC sub-code for the commodity.
- `isHazardous` boolean: A flag to indicate whether the commodity has hazardous materials.
- `hazardous` LTLHazardousDetail: The details of the hazardous material. Note
Required to book shipment when
isHazardous is
true.
- `hazmatId` string, required: The UN/NA hazardous material identification number for the item.
- `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': The primary hazard classification 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': The sub-risk hazard classification 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': The sub-risk hazard classification of the hazardous material.
- `packingGroup` 'I' | 'II' | 'III': The packing group that accords with the degree of danger of the hazardous material.
- `permitNumber` string: US DOT special permit number.
- `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.
- `isHazardous` boolean
- `itemId` string: A unique identifier for the specific item in Freightview. Should be used in requests to the [Edit LTL shipment endpoint](/#tag/LTL/operation/ltlEditShipment) to ensure that changes are made to the correct items array object.
- `hazardous` object: 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.
- `packingGroup` 'I' | 'II' | 'III': The packing group that accords with the degree of danger of 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': The primary hazard classification 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': The sub-risk hazard classification 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': The sub-risk hazard classification 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.
- `direction` 'inbound' | 'outbound' | 'third-party': The direction of the the shipment (based on the locations setup for the account).
- `documents` ExternalDocumentDTO[]: The documents for the shipment.
- `fileName` string: The name of the file.
- `mimeType` 'application/pdf' | 'application/zpl' | 'image/jpeg' | 'image/png': The MIME type of the file.
- `source` 'carrier' | 'shipper' | 'system': The source of the document.
- `type` 'appointment-confirmation' | 'authorization-for-special-service' | 'bol' | 'commercial-invoice' | 'contact-time-critical' | 'corrected-bol' | 'customer-quote' | 'customs-document' | 'delivery-photo' | 'delivery-return-receipt' | 'detention-certificate' | 'dimension-certificate' | 'freight-forwarding-delivery-order' | 'inspection-certificate' | 'inspection-report' | 'invoice' | 'label' | 'label-combined' | 'letter-of-authority' | 'lumper-certificate' | 'mtr' | 'nmfc-certificate' | 'other' | 'packing-slip' | 'pickup-photo' | 'proof-of-delivery' | 'quote' | 'rate-confirmation' | 'rate-detail' | 'reconsignment-authorization' | 'refused-delivery-receipt' | 'signed-bol' | 'tally-record-signature' | 'weight-and-research-inspection' | 'weight-cert' | 'weights-and-corrections' | 'weights-and-research-photos': The type of the file.
- `uploadDate` string, date-time: The date the document was added to the shipment.
- `itemId` string: The associated shipment item this file is in reference to.
- `url` string: A link to the document (intended for end users using a web browser). **Accessing this link requires the end user to be logged into Freightview in a web browser.**
- `downloadUrl` string: A link to download the document (intended for automated systems). **This link requires authentication - use the same HTTP Bearer token authentication header as used to authenticate requests to the Freightview v2.0 API.**
- `glCode` string: The GL (General Ledger) code assigned to the shipment for accounting purposes.
- `quotedBy` string: The name of the user who quoted the shipment.
- `shipmentQuotePageUrl` string: A direct link to access all of the quotes for this shipment within Freightview.
## Other responses
- `400`: Bad Request
- `401`: Unauthorized
- `402`: Payment Required
- `403`: Forbidden
- `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)