--- title: "Book customer routed shipment" method: POST path: "/v2.0/shipments/ltl/book/freight-collect" tags: ["LTL"] --- # Book customer routed shipment `POST /v2.0/shipments/ltl/book/freight-collect` ## Request - Base URL: `https://api.freightview.dev` - URL: `https://api.freightview.dev/v2.0/shipments/ltl/book/freight-collect` - Auth: OAuth 2 (client credentials, token URL `/v2.0/auth/token`) This endpoint can be used to create and book an LTL shipment that is billing the recipient or a third party. See [here](#tag/Reference/LTL-Customer-Routed-Requirements) for additional information on booking customer routed shipments. ## Query parameters - `labelSize` '2.25x4' | '3x4' | '3x5' | '3.5x5' | '4x1' | '4x2' | '4x3.3' | '4x6' | '4x8' | '5.5x8.5' | '8.5x11': The size of labels you would like to generate for the shipment. - `labelCount` 1 | 2 | 4: The number of labels (per shipping item e.g. pallet) you would like to have returned for the shipment. See [here](#section/Labels) for more details on labels. ## Request body - BookLTLCustomerRoutedShipment - `pickupDate` string, required: The date when the shipment should be picked up. Must be ISO 8601 format. **YYYY-MM-DD** - `origin` object, required: The origin information for the shipment. - `company` string, required: The company name for the origin location. - `address` string, required: The address line 1 for the origin. - `address2` string: The address line 2 for the origin. - `city` string, required: The city for the origin. - `state` string, required: Two character state / province abbreviation for the origin. - `postalCode` string, required: Postal code of for the origin in US or Canadian format. Valid formats (USA): - `10111` - `10111-1111` Valid formats (Canada): - `A9A9A9` - `A9A 9A9` - `A9A-9A9` - `country` 'us' | 'ca', required: The two-digit country code. - `opensAt` string, required: The local time the location opens for pickup, in 24-hour format (HH:MM).
Tip
Must be earlier than the closesAt time.
- `closesAt` string, required: The local time the location closes for pickup, in 24-hour format (HH:MM).
Tip
Must be later than the opensAt time.
- `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. - `contactName` string, required: The name of the contact person at the origin location. - `contactEmail` string: The email address of the contact person at the origin location. - `contactPhone` string, required: The phone number of the contact person at the origin location. - `contactPhoneExt` string: The phone number extension of the contact person at the origin location. - `instructions` string: Special instructions for pickup at the origin 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` union, required: The reference number value. - number - string - `accessorials` object: Accessorial services required for pickup at the origin location. - `inside` boolean: Indicates if inside pickup service is required. - `liftgate` boolean: Indicates if liftgate service is required. - `destination` object, required: The destination information for the shipment. - `company` string, required: The company name for the destination location. - `address` string, required: The address line 1 for the destination. - `address2` string: The address line 2 for the destination. - `city` string, required: The city for the destination. - `state` string, required: Two character state / province abbreviation for the destination. - `postalCode` string, required: Postal code of for the destination in US or Canadian format. Valid formats (USA): - `10111` - `10111-1111` Valid formats (Canada): - `A9A9A9` - `A9A 9A9` - `A9A-9A9` - `country` 'us' | 'ca', required: The two-digit country code. - `opensAt` string: The local time the location opens for delivery, in 24-hour format (HH:MM).
Tip
Must be earlier than the closesAt time.
- `closesAt` string: The local time the location closes for delivery, in 24-hour format (HH:MM).
Tip
Must be later than the opensAt time.
- `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. - `contactName` string, required: The name of the contact person at the destination location. - `contactEmail` string: The email address of the contact person at the destination location. - `contactPhone` string: The phone number of the contact person at the destination location. - `contactPhoneExt` string: The phone extension of the contact person at the destination location. - `instructions` string: Special instructions for delivery at the destination location. - `refNums` object[]: An array of reference numbers associated with the destination location. _(Only one reference number for the destination location is currently supported)._ - `type` 'other', required: The reference number type. - `value` union, required: The reference number value. - number - string - `accessorials` object: Accessorial services required for delivery at the destination location.
Note
notify and schedule are mutually exclusive, i.e. they cannot both be set to true.
- `liftgate` boolean: Indicates if liftgate service is required. - `inside` boolean: Indicates if inside delivery service is required. - `notify` boolean: Indicates if notification service is required. - `schedule` boolean: Indicates if a delivery appointment is required. - `sortAndSegregate` boolean: Indicates if sort and segregate service is required. - `equipment` object: An object to specify equipment type(s) that could be quoted. - `accessorials` object: The accessorials associated with the equipment. - `protect-from-freezing` boolean: Indicates if protect from freezing service is required. - `single-shipment` boolean: Indicates if single shipment service is required. - `items` object[], required: The items (handling units) being transported as part of the shipment. - `quantity` integer, required: The quantity of handling units in this `items` object. - `weight` integer: The weight of the freight being shipped on the handling unit (include the weight of the handling unit as well, if known).
Note
Required unless every contains commodity has a weight. Must be omitted when contains has multiple commodities.
- `weightUOM` 'lbs': The unit of measure for the weight. - `description` string, required: A description of the freight being shipped on the handling unit.
Note
Required to book shipment.
- `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. - `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.
- `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.
- `width` integer: The width of the handling unit. - `height` integer: The height of the handling unit. - `dimensionsUOM` 'in': The unit of measure for the dimensions values (`length`, `width`, `height`). - `nmfcNumber` integer: The NMFC code for the freight being shipped on the handling unit. - `nmfcSubNumber` integer: The NMFC sub-code for the freight being shipped on the handling unit. - `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: A flag to indicate whether the item has hazardous materials. - `hazardous` object: 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. - `customsBrokers` object[]: An array to hold customs broker information. For the LTL workflow, only 1 customs broker object is currently supported.
Note
Required to book shipment if the shipment crosses international borders.
- `companyName` string, required: The name for the customs broker. - `address` string: The address line 1 for the customs broker. - `address2` string: The address line 2 for the customs broker. - `city` string: The city for the customs broker. - `state` string: The two-digit state / province code for the customs broker. - `postalCode` string: Postal code of for the customs broker in US or Canadian format. Valid formats (USA): - `10111` - `10111-1111` Valid formats (Canada): - `A9A9A9` - `A9A 9A9` - `A9A-9A9` - `country` 'us' | 'ca', required: The two-digit country code. - `email` string: The email address for the customs broker. - `phone` string, required: The phone number for the customs broker. - `phoneExt` string: The phone number extension for the customs broker. - `type` 'import' | 'export': The role of the customs broker. - `value` number: The customs value of the shipment.
Note
Required by some carriers.
- `emergencyContact` object: Emergency contact information for the shipment.
Note
Required to book shipment if any items on the shipment are hazardous.
- `name` string, required: The name of the emergency contact. - `phone` string, required: The phone number of the emergency contact. - `phoneExt` string: The phone number extension of the emergency contact. - `contractNumber` string: The contract number associated with the emergency contact. - `bolNumber` string: The Bill of Lading number for the shipment. Auto-generated by Freightview upon booking the shipment unless a value is provided. - `glCode` string: The GL (General Ledger) code to assign to the shipment for accounting purposes. The GL code must already exist in your account's GL codes list. - `billTo` object, required: The billing information for the shipment. - `company` string, required: The company name of the billing party. - `address` string, required: The street address line 1 for the billing party. - `address2` string: The street address line 2 for the billing party. - `city` string, required: The city of the billing party. - `state` string, required: The state or province code for the billing party. - `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': The two-digit country code. - `contactName` string, required: The name of the contact person for billing purposes. - `contactPhone` string, required: The phone number of the contact person for billing purposes. - `contactPhoneExt` string: The phone extension of the contact person for billing purposes. - `contactEmail` string: The email address of the contact person for billing purposes. - `accountNumber` string: The account number of the billing party.
Note
Required by some carriers. See LTL Customer Routed Requirements for further details.
- `schedulePickup` boolean - `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. - `carrier` object, required: An object to specify which carrier & service to use to book the shipment. - `code` 'aact' | 'abfl' | 'abfs' | 'agce' | 'ancf' | 'avrt' | 'btvp' | 'ccyq' | 'cgoj' | 'cmfc' | 'cnwy' | 'cpu' | 'ctbv' | 'ctii' | 'dafg' | 'dbde' | 'dcha' | 'ddpp' | 'dhrn' | 'dlds' | 'dubl' | 'dylt' | 'eqxt' | 'exla' | 'fcsy' | 'fwdn' | 'fxfe' | 'gtjn' | 'hlnf' | 'hrcf' | 'hwep' | 'jlei' | 'jpxs' | 'ldtn' | 'mgul' | 'mihd' | 'mllr' | 'monc' | 'mtjg' | 'nmtf' | 'nopk' | 'numk' | 'oakh' | 'odfl' | 'paaf' | 'pana' | 'pens' | 'pfeg' | 'pitd' | 'pyle' | 'quca' | 'rdfs' | 'rlca' | 'rude' | 'rxic' | 'saia' | 'sctp' | 'sefl' | 'sfcl' | 'sfpa' | 'smtl' | 'taxa' | 'tfin' | 'totl' | 'ttfy' | 'usrd' | 'utpa' | 'valc' | 'ward' | 'warw' | 'wlon' | 'xgsi', required: The carrier's SCAC code as used in Freightview. - `serviceId` string, required: The supported services by carrier can be retrieved using the [get carrier metadata endpoint](#tag/Carriers/operation/getCarrierMetadata). - `paymentTerms` 'third-party-prepaid' | 'outbound-collect', required: The payment terms applicable for the billing of the shipment. - `outbound-collect` - the destination location is the responsible party for the shipping costs. - `third-party-prepaid` - a third party is the responsible party for the shipping costs. ## Response `200` Success - ExternalShipmentDTO - `shipmentId` string: The unique identifier in Freightview for this shipment. - `bookedDate` string, date-time: Date / time when shipment was awarded to carrier. - `createdDate` string, date-time: Date / time when shipment was created. - `pickupDate` string, date: The requested date for pickup of the shipment. - `status` 'pending' | 'awarded' | 'confirmed' | 'picked-up' | 'delivered' | 'canceled': - `pending` - Shipment has been created. - `awarded` - Shipment has been awarded to a carrier. - `confirmed` - Shipment has been confirmed by carrier. - `picked-up` - Shipment has been picked up. - `delivered` - Shipment has been delivered. - `canceled` - Shipment has been canceled by the shipper. - `locations` ExternalLocationDTO[]: The shipment's locations, e.g. origin, destination and any stops in between. - `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` ExternalEquipmentDTO: The equipment for the shipment. - `alternateTypes` string[]: The alternate types of equipment that could be quoted by the carrier. - `type` 'dry-van-53' | 'dry-van-48' | 'flatbed-53' | 'flatbed-48' | 'refrigerated-48' | 'refrigerated-53' | 'step-deck' | 'flatbed-lowboy' | 'air-freight' | 'box-truck-16' | 'box-truck-24' | 'bulk-aluminum' | 'bulk-auger-semi' | 'bulk-auger-straight-truck' | 'bulk-belt-trailer' | 'bulk-convertible-hopper' | 'bulk-end-dump' | 'bulk-hopper' | 'bulk-insulated' | 'bulk-lined' | 'bulk-one-tank' | 'bulk-pneumatic' | 'bulk-stainless' | 'bulk-three-hole' | 'bulk-four-hole' | 'bulk-two-hole' | 'bulk-walking-floor' | 'bulk-bag-combo' | 'conestoga' | 'consolidated' | 'crazy8-flatbed' | 'curtain-side-van' | 'drayage-20' | 'drayage-40' | 'drayage-45' | 'drayage-48' | 'drayage-53' | 'flatbed-48-double-drop' | 'flatbed-48-step' | 'flatbed-53-step' | 'flatbed-b-train' | 'flatbed-heavy-haul' | 'flatbed-removable-gooseneck(rgn)' | 'flatbed-self-unloader' | 'flatbed-with-piggyback' | 'flatbed-tri-axle' | 'hotshot' | 'intermodal-20' | 'intermodal-40' | 'intermodal-45' | 'intermodal-48' | 'intermodal-53' | 'logistics-van-53' | 'ltl' | 'padded-van' | 'partial-dry-van' | 'partial-flatbed' | 'partial-refrigerated' | 'power-only' | 'pup' | 'refrigerated-ltl' | 'sprinter-van' | 'straight-truck-20' | 'straight-truck-26' | 'tanker' | 'volume-ltl', required: The type of equipment used for the transport of the shipment. - `accessorials` EquipmentAccessorialDTO[]: 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. - `description` string, required: The description of the shipment. - `declaredValue` number: The declared value of the shipment provided when quoting. - `declaredValueCurrency` 'usd': The declared value currency. - `weight` number, required: The weight of the shipment. - `weightUOM` 'lbs', required: The unit of measure for the weight. - `isHazardous` boolean, required: A flag to indicate whether the shipment is hazardous. - `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 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. - `isLiveLoad` boolean: A flag to indicate whether the shipper considers the shipment a "live load". - `true` - This is a "live load" that will be shipped. - `false` - This shipment is "quote only". - `isArchived` boolean: A flag to indicate whether the shipment has been archived in Freightview. - `items` ExternalHandlingUnitDTO[]: The items (handling units) being transported as part of the shipment. - `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. - `direction` 'inbound' | 'outbound' | 'third-party': The direction of the the shipment (based on the locations setup for the account). - `refNums` ReadOnlyRefNum[]: The reference numbers associated with the shipment. - `type` 'load-num' | 'other': The type of reference number. - `value` string: The value of the reference number. - `selectedQuote` ExternalQuoteDTO: The details of the quote. - `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` 'dry-van-53' | 'dry-van-48' | 'flatbed-53' | 'flatbed-48' | 'refrigerated-48' | 'refrigerated-53' | 'step-deck' | 'flatbed-lowboy' | 'air-freight' | 'box-truck-16' | 'box-truck-24' | 'bulk-aluminum' | 'bulk-auger-semi' | 'bulk-auger-straight-truck' | 'bulk-belt-trailer' | 'bulk-convertible-hopper' | 'bulk-end-dump' | 'bulk-hopper' | 'bulk-insulated' | 'bulk-lined' | 'bulk-one-tank' | 'bulk-pneumatic' | 'bulk-stainless' | 'bulk-three-hole' | 'bulk-four-hole' | 'bulk-two-hole' | 'bulk-walking-floor' | 'bulk-bag-combo' | 'conestoga' | 'consolidated' | 'crazy8-flatbed' | 'curtain-side-van' | 'drayage-20' | 'drayage-40' | 'drayage-45' | 'drayage-48' | 'drayage-53' | 'flatbed-48-double-drop' | 'flatbed-48-step' | 'flatbed-53-step' | 'flatbed-b-train' | 'flatbed-heavy-haul' | 'flatbed-removable-gooseneck(rgn)' | 'flatbed-self-unloader' | 'flatbed-with-piggyback' | 'flatbed-tri-axle' | 'hotshot' | 'intermodal-20' | 'intermodal-40' | 'intermodal-45' | 'intermodal-48' | 'intermodal-53' | 'logistics-van-53' | 'ltl' | 'padded-van' | 'parcel' | 'partial-dry-van' | 'partial-flatbed' | 'partial-refrigerated' | 'power-only' | 'pup' | 'refrigerated-ltl' | 'sprinter-van' | 'straight-truck-20' | 'straight-truck-26' | 'tanker' | 'volume-ltl': The type of equipment used for the transport of the shipment. - `tracking` LoadTrackDetailDTO: The tracking information for the shipment. - `deliveryDateActual` string, date-time: The actual delivery date of the shipment. - `deliveryDateEstimate` string, date: The estimated delivery date of the shipment. - `lastUpdatedDate` string, date-time: The date the tracking detail was last updated. - `pickupDateActual` string, date-time: The actual pickup date of the shipment. - `status` 'pending' | 'enroute-to-pickup' | 'in-transit' | 'out-for-delivery' | 'delivered' | 'not-found' | 'error': The tracking status of the shipment. - `trackingNumber` string: The tracking number for the shipment. - `assetCarrierTrackingNumber` string: The asset carrier's tracking number.
Note
Only available if this shipment has been tendered to a broker.
- `items` ItemTrackDetail[]: If the carrier provides item-level tracking, this will contain the tracking details for the individual items of this shipment. - `deliveryDateActual` string, date-time: The actual delivery date of the shipment. - `deliveryDateEstimate` string, date: The estimated delivery date of the shipment. - `lastUpdatedDate` string, date-time: The date the tracking detail was last updated. - `pickupDateActual` string, date-time: The actual pickup date of the shipment. - `status` 'pending' | 'enroute-to-pickup' | 'in-transit' | 'out-for-delivery' | 'delivered' | 'not-found' | 'error': The tracking status of the shipment. - `trackingNumber` string: The tracking number for the shipment. - `assetCarrierTrackingNumber` string: The asset carrier's tracking number.
Note
Only available if this shipment has been tendered to a broker.
- `itemId` string: The identifier of the item in Freightview to which this tracking detail belongs. - `index` number: The zero-based index of the individual item for the given group of items specified by the itemId. - `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.** - `pickup` ExternalPickupDetailsDTO: The details for the pickup of the shipment. - `status` 'ok' | 'pending' | 'error' | 'not-requested' | 'requesting': The status of the pickup request. - `confirmationNumber` string: The pickup confirmation number provided by the carrier. - `requestedDate` string, date-time: The date/time the shipment was awarded to the carrier. - `confirmedDate` string, date-time: The date/time the pickup was confirmed by the carrier. - `bol` ExternalBOLDetailsDTO: The details for the retrieval of the bill of lading of the shipment. - `status` 'ok' | 'pending' | 'error' | 'not-requested' | 'requesting': The status of the bill of lading retrieval. - `bolNumber` string: The Bill of Lading number for the shipment. Auto-generated by Freightview upon awarding unless value provided by shipper. - `invoice` ExternalInvoiceDTO: An object with details of the invoice for the shipment.
Note
This object won't have data until the invoice details are either entered by a user via Freightview's Audit functionality, or retrieved by Freightview's invoice data automation tool.
- `createdDate` string, date-time: Date/time the invoice details were added by user in Freightview. - `invoiceAmount` number: The amount that was invoiced by the carrier. - `invoiceNumber` string: The carrier invoice number. - `invoiceDate` string, date: Date the invoice was issued by the carrier. - `acceptedDate` string, date: Date the invoice was accepted by the shipper. - `disputedAmount` number: The amount of the discrepancy between the invoiced rate and the quoted rate in Freightview. - `payments` ExternalPaymentDTO[] - `amount` number, required: The amount of the payment. - `remitted` boolean: A flag to indicate to indicate that this amount has been marked to be paid and exported out of the Freightview Audit tool (e.g. to an accounting group for payment to be sent to the carrier). - `createdDate` string, date-time, required: The date this payment was created. - `remittedDate` string, date-time: The date this payment was remitted, if applicable. - `addedBy` object: Who added this payment. - `type` 'system' | 'shipper': Whether the payment was added by the system or a shipper user. - `userId` string: The ID of the user who added the payment, if applicable. - `quotedBy` string: The name of the user who quoted the shipment. - `bookedBy` string: The name of the user who booked the shipment. - `notices` string[]: Notices from Freightview regarding the shipment. - `glCode` string: The GL (General Ledger) code assigned to the shipment for accounting purposes. - `shipmentDetailsUrl` string: A direct link to access the details for this shipment within Freightview. - `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 - `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)