--- title: "Get Rate Request" method: GET path: "/services/rating/v1/rate-requests/{id}" tags: ["Multi-Modal: Rating"] --- # Get Rate Request `GET /services/rating/v1/rate-requests/{id}` ## Request - Base URL: `https://na12.api.project44.com` - URL: `https://na12.api.project44.com/services/rating/v1/rate-requests/{id}` - Auth: OAuth 2 - Client credentials - Token URL: `/api/v4/oauth2/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Path parameters - `id` string, uuid, required ## Response `200` Successful Response - RateRequest: The general data model mirror what we stored in database - `attributes` CustomAttribute[]: An optional user-defined set of custom attributes to associate with this shipment. These are descriptors and identifiers which apply to the entire shipment and they are not shared with any carriers. - `name` string: The key (name) for the custom attribute. Must be unique. - `value` string - `values` string[]: The values for the custom attribute. - `apiConfiguration` RatingApiConfiguration - `enableSlotBooking` boolean: The flag to indicate if a slot booking in Appointment Manager is needed. - `ratingWebhookName` string: An optional name of the webhook that will receive updates for this quote. - `capacityProviderIdentifiers` BookingCapacityProviderIdentifier[]: References to the desired carriers to request quotes from for the shipment. - `type` 'FFW_SCAC' | 'CARRIER_SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU' | 'SYSTEM' | 'P44_GLOBAL': The type of identifier provided to distinguish the Capacity Provider. - `value` string: Capacity Provider identifier. - `carrierAccountGroups` CarrierAccountGroupReference[]: Named carrier account groups to include. Groups are resolved to individual carriers at request time. Can be combined with capacityProviderIdentifiers. - `code` string: Carrier account group code. - `createdDateTime` string, date-time: The date and time when this shipment was created. This value is read only. - `expirationDateTime` string, date-time: The datetime of expiration for quotes within this rate request. - `identifiers` LogisticsIdentifier[]: Shipper-supplied identifiers for the shipment to be transported. Fully mutable. - `type` 'AIR_WAYBILL' | 'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'BOOKING_NUMBER' | 'CARRIER_IATA' | 'CARRIER_ICAO' | 'CARRIER_NAME' | 'CARRIER_SCAC' | 'FFW_SCAC' | 'NVOCC_SCAC' | 'NVOCC_NAME' | 'FFW_NAME' | 'FFW_MASTER_ID' | 'NVOCC_MASTER_ID' | 'CONTAINER_ID' | 'CUSTOMER_REFERENCE' | 'DELIVERY_NUMBER' | 'EXTERNAL' | 'FLIGHT_NUMBER' | 'ORDER' | 'PICKUP' | 'PRO' | 'PURCHASE_ORDER' | 'RAIL_CAR_ID' | 'RAIL_WAYBILL' | 'TRACKING_NUMBER' | 'TRAILER_ID' | 'UNKNOWN' | 'VESSEL_IMO' | 'VESSEL_NAME' | 'WAYBILL' | 'VESSEL_CALL_SIGN' | 'VESSEL_MMSI' | 'CARRIER_US_DOT_NUMBER' | 'CARRIER_MC_NUMBER' | 'SUBSCRIPTION_ID' | 'HOUSE_AIR_WAYBILL' | 'SALES_ORDER' | 'WAREHOUSE_MOVEMENT_ORDER' | 'ADVANCED_SHIPMENT_NOTICE' | 'DRIVER_MOBILE_PHONE_NUMBER' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'TRAILER_LICENSE_PLATE' | 'SENSITECH_DEVICE_ID' | 'EMERSON_DEVICE_ID' | 'TIVE_DEVICE_ID' | 'ZILLION_DEVICE_ID' | 'VOYAGE_NUMBER' | 'CARRIER_MASTER_ID' | 'CARRIER_NMC_ID' | 'CONTAINER_TYPE' | 'TRAIN_NUMBER' | 'WAGON_ID' | 'TRAIN_ID' | 'CAPACITY_PROVIDER_ACCOUNT_GROUP' | 'CAPACITY_PROVIDER_ACCOUNT_CODE' | 'SERIAL_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER' | 'REFERENCE_NUMBER' | 'CONTAINER_PIN' | 'VESSEL_P44_ID' | 'EXPORT_CUSTOMS_BROKER' | 'IMPORT_CUSTOMS_BROKER' | 'POL_QUALITY_CONTROL_PROVIDER' | 'POD_QUALITY_CONTROL_PROVIDER' | 'AIRCRAFT_ICAO' | 'AIRLINE_NAME' | 'SEAL_NUMBER' | 'DRAYAGE_CARRIER_SCAC' | 'EXPORT_DRAYAGE_CARRIER_SCAC' | 'IMPORT_DRAYAGE_CARRIER_SCAC' | 'INBOUND_VOYAGE_NUMBER': The standard which defines who assigns the identifier and what it identifies. Required field. - `value` string: The value of this identifier. Required field. - `id` string, uuid: The project44-generated identifier for the rate request. - `lastModifiedDateTime` string, date-time: The date and time when this shipment was last modified. This value is read only. - `marketQuotes` MarketQuote[]: A list of market rate provider quotes associated to the rate request. - `capacityProviderIdentifier` BookingCapacityProviderIdentifier: A Capacity Provider identifier object used to identify a carrier or a broker responsible for transporting a shipment, containing two key-value pairs: type and value. - `type` 'FFW_SCAC' | 'CARRIER_SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU' | 'SYSTEM' | 'P44_GLOBAL': The type of identifier provided to distinguish the Capacity Provider. - `value` string: Capacity Provider identifier. - `capacityProviderName` string: The name of the capacity provider's company. - `carrierMetrics` CarrierMetrics - `carrierAssureScore` number: Score for the carrier provided by the Carrier Assure API. - `carrierAssureGrade` string: Grade for the carrier provided by the Carrier Assure API. - `onTimePercentage` number: Share of shipments which were on-time. - `shipmentCount` integer: Number of shipments considered in Calculations - `trackingPercentage` number: Share of shipments which had adequate tracking enabled. - `createdDateTime` string, date-time: The date and time when this quote was created. This value is read only. - `deliveryDate` string, date: Expected delivery date and time of the shipment. - `expirationDateTime` string, date-time: Quote expiration time set by the carrier. - `id` string, uuid: Project44-generated identifier for the quote. - `lastModifiedDateTime` string, date-time: The date and time when this quote was last modified. This value is read only. - `pickupDate` string, date: Expected pickup date and time of the shipment. - `respondByDateTime` string, date-time: Rate request expiration time that is set by the shipper. - `status` 'QUOTED' | 'PROCESSING' | 'CANCELLED' | 'DECLINED' | 'EXPIRED': An enumeration. - `type` 'MANUAL' | 'API' | 'CONTRACT': An enumeration. - `totalRate` MonetaryValue: A monetary value expressing amount and currency type. - `amount` number: The value of the shipment - `currency` 'USD' | 'CAD' | 'MXN' | 'EUR', enum: The currency of the shipment value - `transportationMode` 'OCEAN' | 'AIR' | 'RAIL' | 'TRUCKLOAD' | 'LTL' | 'VOLUME_LTL': An enumeration. - `name` string: The name or otherwise human-readable description of the shipment created. - `quotes` Quote[]: A list of quotes associated to the rate request. - `bookable` boolean: System flag that is set on creation to indicate if a quote is allowed to be booked; True for a carrier in-network, false for a carrier out-of-network. - `capacityProviderQuoteId` string: Matching quote id on the provider's side. - `capacityProviderIdentifier` BookingCapacityProviderIdentifier: A Capacity Provider identifier object used to identify a carrier or a broker responsible for transporting a shipment, containing two key-value pairs: type and value. - `type` 'FFW_SCAC' | 'CARRIER_SCAC' | 'DOT_NUMBER' | 'MC_NUMBER' | 'P44_EU' | 'SYSTEM' | 'P44_GLOBAL': The type of identifier provided to distinguish the Capacity Provider. - `value` string: Capacity Provider identifier. - `capacityProviderName` string: The name of the capacity provider's company. - `carrierMetrics` CarrierMetrics - `carrierAssureScore` number: Score for the carrier provided by the Carrier Assure API. - `carrierAssureGrade` string: Grade for the carrier provided by the Carrier Assure API. - `onTimePercentage` number: Share of shipments which were on-time. - `shipmentCount` integer: Number of shipments considered in Calculations - `trackingPercentage` number: Share of shipments which had adequate tracking enabled. - `createdDateTime` string, date-time: The date and time when this quote was created. This value is read only. - `carrierAccountGroups` CarrierAccountGroupReference[]: Carrier account group(s) this carrier belonged to when the quote was created. - `code` string: Carrier account group code. - `deliveryDate` string, date: Expected delivery date and time of the shipment. - `expirationDateTime` string, date-time: Quote expiration time set by the carrier. - `id` string, uuid: Project44-generated identifier for the quote. - `lastModifiedDateTime` string, date-time: The date and time when this quote was last modified. This value is read only. - `pickupDate` string, date: Expected pickup date and time of the shipment. - `respondByDateTime` string, date-time: Rate request expiration time that is set by the shipper. - `status` 'QUOTED' | 'PROCESSING' | 'CANCELLED' | 'DECLINED' | 'EXPIRED': An enumeration. - `type` 'MANUAL' | 'API' | 'CONTRACT': An enumeration. - `totalRate` MonetaryValue: A monetary value expressing amount and currency type. - `amount` number: The value of the shipment - `currency` 'USD' | 'CAD' | 'MXN' | 'EUR', enum: The currency of the shipment value - `transportationMode` 'OCEAN' | 'AIR' | 'RAIL' | 'TRUCKLOAD' | 'LTL' | 'VOLUME_LTL': An enumeration. - `rateDetail` RateRequestDetail - `attributes` CustomAttribute[]: A shipper-provided list of custom key-value list pairs relevant to the shipment which are shared with the carrier. - `name` string: The key (name) for the custom attribute. Must be unique. - `value` string - `values` string[]: The values for the custom attribute. - `deliveryDate` string, date: If provided, the delivery date must be on/after shipment date. - `distanceToTravel` RatingDistanceMeasurement: A measure of distance with a value and unit. - `unit` 'MI': An enumeration of distance units. - `value` string: The numeric value of this distance, expressed as a string. - `estimatedDeliveryDate` string, date: An estimated delivery date that is calculated by project44. - `pickupDate` string, date: The pickup date must be on/before delivery date. - `routeInfo` RatingRouteInfo - `routeSegments` RatingRouteSegment[]: Contains information about how the shipment moves from each stop to the next. - `fromStopId` string, uuid: The start stop id of the route segment. - `toStopId` string, uuid: The end stop id of the route segment. - `stops` RatingStop[]: All stops associated with this shipment, in sequential order. - `appointmentDetails` RatingAppointmentDetails - `appointmentWindow` ZonedDateTimeWindow: A date and time range, including a time zone, representing a window of availability. - `endDateTime` string, date-time: End date and time of this window in the applicable time zone. (format: yyyy-MM-dd'T'HH:mm:ss) - `localTimeZoneIdentifier` string: The time zone identifier (e.g., 'America/Chicago') for this date time window. - `startDateTime` string, date-time: Start date and time of this window in the applicable time zone.(default: current date, format: yyyy-MM-dd'T'HH:mm:ss) - `dockOperationWindow` ZonedDateTimeWindow: A date and time range, including a time zone, representing a window of availability. - `endDateTime` string, date-time: End date and time of this window in the applicable time zone. (format: yyyy-MM-dd'T'HH:mm:ss) - `localTimeZoneIdentifier` string: The time zone identifier (e.g., 'America/Chicago') for this date time window. - `startDateTime` string, date-time: Start date and time of this window in the applicable time zone.(default: current date, format: yyyy-MM-dd'T'HH:mm:ss) - `accessorials` union[]: Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier. - union - RefrigeratedAccessorial: Accessorial which defines the acceptable temperature range for a transportation container. - … - LiftgateAccessorial: Accessorial which flags the explicit need for liftgate service. - … - TarpsAccessorial: Accessorial which delineates the expected size and number of tarps used in shipping. - … - StrapsAccessorial: Accessorial which delineates the expected size and number of straps used in shipping. - … - ChainsAccessorial: Accessorial which delineates the expected size and number of chains used in shipping. - … - DeckHeightAccessorial: Accessorial which defined the expected height of the deck on the vehicle. - … - CraneAccessorial: Accessorial which flags the explicit need for crane service. - … - CallBeforeArrivalAccessorial: Accessorial which flags the explicit need for call before arrival to a stop service. - … - DockRequiredAccessorial: Accessorial which flags the explicit need for dock service. - … - LockedGateAccessorial: Accessorial which flags the explicit need for locked gate service. - … - FirstComeFirstServedAccessorial: Accessorial which flags the explicit need for first come, first served service. - … - AppointmentRequiredAccessorial: Accessorial which flags the explicit need for appointment service. - … - WhiteGloveAccessorial: Accessorial which flags the explicit need for white glove service. - … - HazmatAccessorial: Accessorial for describing the HAZMAT Class and UN Code for transportable goods. - … - ExcessiveLengthAccessorial: Accessorial which flags the explicit need for appointment service. - … - GuaranteedServiceLevelAccessorial: Accessorial which flags the explicit need for appointment service. - … - OtherAccessorial: Accessorial which does not require any additional details. - … - `contacts` StopContact[]: Shipper-supplied individuals who may be contacted for correspondence related to shipment handling at the stop. - `companyName` string: Name of the Company with whom the Contact is associated. - `email` string, email: The Contact's email address. - `familyName` string: The Contact's last or family name. - `givenName` string: The Contact's first or given name. - `mobilePhoneNumber` string: The Contact's mobile phone number. - `phoneNumber` string: The Contact's work or other primary phone number. - `id` string, uuid: The id of the stop. - `location` Location: A physical location. - `address` Address: A postal address. - `addressLines` string[]: Street name, number, direction, PO box, etc. Only three address lines are currently permitted. - `city` string: Name of city, town, etc. - `country` 'US' | 'CA' | 'MX' | 'AG' | 'BB' | 'BS' | 'BZ' | 'CR' | 'CU' | 'DM' | 'DO' | 'GD' | 'GT' | 'HN' | 'HT' | 'JM' | 'KN' | 'LC' | 'NI' | 'PA' | 'SV' | 'TT' | 'VC' | 'AI' | 'AW' | 'BL' | 'BM' | 'BQ' | 'CW' | 'GL' | 'GP' | 'KY' | 'MF' | 'MQ' | 'MS' | 'PM' | 'PR' | 'SX' | 'TC' | 'UM' | 'VG' | 'VI' | 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'DE' | 'EE' | 'ES' | 'FI' | 'FR' | 'GB' | 'GR' | 'HR' | 'HU' | 'IE' | 'IT' | 'LT' | 'LU' | 'LV' | 'MT' | 'NL' | 'PL' | 'PT' | 'RO' | 'SE' | 'SK' | 'SI' | 'CH' | 'IS' | 'LI' | 'NO' | 'AL' | 'ME' | 'MK' | 'RS' | 'TR' | 'AD' | 'AX' | 'BA' | 'BV' | 'BY' | 'FO' | 'GG' | 'GI' | 'IM' | 'IO' | 'JE' | 'MC' | 'MD' | 'SJ' | 'SM' | 'TF' | 'UA' | 'VA' | 'AE' | 'AF' | 'AM' | 'AZ' | 'BD' | 'BH' | 'BN' | 'BT' | 'CN' | 'GE' | 'HK' | 'ID' | 'IL' | 'IN' | 'IQ' | 'IR' | 'JO' | 'JP' | 'KG' | 'KH' | 'KP' | 'KR' | 'KW' | 'KZ' | 'LA' | 'LB' | 'LK' | 'MM' | 'MN' | 'MO' | 'MV' | 'MY' | 'NP' | 'OM' | 'PH' | 'PK' | 'PS' | 'QA' | 'RU' | 'SA' | 'SG' | 'SY' | 'TH' | 'TJ' | 'TL' | 'TM' | 'TW' | 'UZ' | 'VN' | 'YE' | 'AO' | 'BF' | 'BI' | 'BJ' | 'BW' | 'CD' | 'CF' | 'CG' | 'CI' | 'CM' | 'CV' | 'DJ' | 'DZ' | 'EG' | 'EH' | 'ER' | 'ET' | 'GA' | 'GH' | 'GM' | 'GN' | 'GQ' | 'GW' | 'HM' | 'KE' | 'KM' | 'LR' | 'LS' | 'LY' | 'MA' | 'MG' | 'ML' | 'MR' | 'MU' | 'MW' | 'MZ' | 'NA' | 'NE' | 'NG' | 'RE' | 'RW' | 'SC' | 'SD' | 'SH' | 'SL' | 'SN' | 'SO' | 'SS' | 'ST' | 'SZ' | 'TD' | 'TG' | 'TN' | 'TZ' | 'UG' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'EC' | 'FK' | 'GF' | 'GS' | 'GY' | 'PE' | 'PY' | 'SR' | 'UY' | 'VE' | 'AS' | 'AU' | 'CC' | 'CK' | 'CX' | 'FJ' | 'FM' | 'GU' | 'KI' | 'MH' | 'MP' | 'NC' | 'NF' | 'NR' | 'NU' | 'NZ' | 'PF' | 'PG' | 'PN' | 'PW' | 'SB' | 'TK' | 'TO' | 'TV' | 'VU' | 'WF' | 'WS' | 'AQ' | 'EL' | 'UK' | 'XK' | 'XS' | 'XI', enum: Abbreviation of country (using ISO 3166 standards). (default: 'US') - `postalCode` string: The ZIP or postal code. - `state` string: Abbreviation of state, province, district, etc. - `contact` Contact: Contact information. - `companyName` string: Company name. - `contactName` string: Contact name. May be required for shipments. - `email` string: Email address. May be required for shipments. - `faxNumber` string: Fax number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `faxNumberCountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `phoneNumber` string: Phone number. May be required for shipments. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `phoneNumber2` string: Alternate phone number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `phoneNumber2CountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `phoneNumberCountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `type` 'PICKUP' | 'DELIVERY' | 'PICKUP_DELIVERY' | 'PORT_OF_LOADING' | 'PORT_OF_DISCHARGE' | 'TRANSSHIPMENT_PORT': An enumeration. - `shippingDetails` ShippingDetails - `air` AirDetails - `accessorials` union[]: Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier. - union - RefrigeratedAccessorial: Accessorial which defines the acceptable temperature range for a transportation container. - … - LiftgateAccessorial: Accessorial which flags the explicit need for liftgate service. - … - TarpsAccessorial: Accessorial which delineates the expected size and number of tarps used in shipping. - … - StrapsAccessorial: Accessorial which delineates the expected size and number of straps used in shipping. - … - ChainsAccessorial: Accessorial which delineates the expected size and number of chains used in shipping. - … - DeckHeightAccessorial: Accessorial which defined the expected height of the deck on the vehicle. - … - CraneAccessorial: Accessorial which flags the explicit need for crane service. - … - CallBeforeArrivalAccessorial: Accessorial which flags the explicit need for call before arrival to a stop service. - … - DockRequiredAccessorial: Accessorial which flags the explicit need for dock service. - … - LockedGateAccessorial: Accessorial which flags the explicit need for locked gate service. - … - FirstComeFirstServedAccessorial: Accessorial which flags the explicit need for first come, first served service. - … - AppointmentRequiredAccessorial: Accessorial which flags the explicit need for appointment service. - … - WhiteGloveAccessorial: Accessorial which flags the explicit need for white glove service. - … - HazmatAccessorial: Accessorial for describing the HAZMAT Class and UN Code for transportable goods. - … - ExcessiveLengthAccessorial: Accessorial which flags the explicit need for appointment service. - … - GuaranteedServiceLevelAccessorial: Accessorial which flags the explicit need for appointment service. - … - OtherAccessorial: Accessorial which does not require any additional details. - … - `cargoMeasurements` AirCargoMeasurements - `dimensions` Dimensions - `height` number - `length` number - `unit` 'FT' | 'M' | 'IN' | 'CM' | 'MI' | 'KM': An enumeration. - `width` number - `volume` Volume - `unit` 'CUBIC_FT' | 'CUBIC_M' | 'L' | 'HL': The unit of measurement for this volume. - `value` number: The numeric decimal value of this volume. - `weight` BookingWeight - `unit` 'LB' | 'KG', enum: Weight measurement units (default: 'LB'). - `value` number: The numeric decimal value of this weight. - `incoterm` 'EXW' | 'FCA' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'CPT' | 'CIP' | 'DPU' | 'DAP' | 'DDP': International commercial terms according to the [ICC](https://iccwbo.org/). EXW: EX WORKS, FCA: FREE CARRIER, FAS: FREE ALONGSIDE SHIP, FOB: FREE ON BOARD, CFR: COST & FREIGHT, CIF: COST, INSURANCE & FREIGHT CPT: COST PAID TO, CIP: CARRIER & INSURANCE PAID TO, DPU: DELIVERED AT PLACE UNLOADED DAP: DELIVERED AT PLACE, DDP: DELIVERED DUTY PAID - `parties` Party[]: Individual shipper-represented groups which are involved with the shipment. - `addressInfo` PartyAddress: A postal address. - `addressLines` string[]: Street name, number, direction, PO box, etc. Only three address lines are currently permitted. - `addressLabel` string: The project44-generated label for the address persisted in location-service. - `city` string: Name of city, town, etc. - `country` 'US' | 'CA' | 'MX' | 'AG' | 'BB' | 'BS' | 'BZ' | 'CR' | 'CU' | 'DM' | 'DO' | 'GD' | 'GT' | 'HN' | 'HT' | 'JM' | 'KN' | 'LC' | 'NI' | 'PA' | 'SV' | 'TT' | 'VC' | 'AI' | 'AW' | 'BL' | 'BM' | 'BQ' | 'CW' | 'GL' | 'GP' | 'KY' | 'MF' | 'MQ' | 'MS' | 'PM' | 'PR' | 'SX' | 'TC' | 'UM' | 'VG' | 'VI' | 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'DE' | 'EE' | 'ES' | 'FI' | 'FR' | 'GB' | 'GR' | 'HR' | 'HU' | 'IE' | 'IT' | 'LT' | 'LU' | 'LV' | 'MT' | 'NL' | 'PL' | 'PT' | 'RO' | 'SE' | 'SK' | 'SI' | 'CH' | 'IS' | 'LI' | 'NO' | 'AL' | 'ME' | 'MK' | 'RS' | 'TR' | 'AD' | 'AX' | 'BA' | 'BV' | 'BY' | 'FO' | 'GG' | 'GI' | 'IM' | 'IO' | 'JE' | 'MC' | 'MD' | 'SJ' | 'SM' | 'TF' | 'UA' | 'VA' | 'AE' | 'AF' | 'AM' | 'AZ' | 'BD' | 'BH' | 'BN' | 'BT' | 'CN' | 'GE' | 'HK' | 'ID' | 'IL' | 'IN' | 'IQ' | 'IR' | 'JO' | 'JP' | 'KG' | 'KH' | 'KP' | 'KR' | 'KW' | 'KZ' | 'LA' | 'LB' | 'LK' | 'MM' | 'MN' | 'MO' | 'MV' | 'MY' | 'NP' | 'OM' | 'PH' | 'PK' | 'PS' | 'QA' | 'RU' | 'SA' | 'SG' | 'SY' | 'TH' | 'TJ' | 'TL' | 'TM' | 'TW' | 'UZ' | 'VN' | 'YE' | 'AO' | 'BF' | 'BI' | 'BJ' | 'BW' | 'CD' | 'CF' | 'CG' | 'CI' | 'CM' | 'CV' | 'DJ' | 'DZ' | 'EG' | 'EH' | 'ER' | 'ET' | 'GA' | 'GH' | 'GM' | 'GN' | 'GQ' | 'GW' | 'HM' | 'KE' | 'KM' | 'LR' | 'LS' | 'LY' | 'MA' | 'MG' | 'ML' | 'MR' | 'MU' | 'MW' | 'MZ' | 'NA' | 'NE' | 'NG' | 'RE' | 'RW' | 'SC' | 'SD' | 'SH' | 'SL' | 'SN' | 'SO' | 'SS' | 'ST' | 'SZ' | 'TD' | 'TG' | 'TN' | 'TZ' | 'UG' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'EC' | 'FK' | 'GF' | 'GS' | 'GY' | 'PE' | 'PY' | 'SR' | 'UY' | 'VE' | 'AS' | 'AU' | 'CC' | 'CK' | 'CX' | 'FJ' | 'FM' | 'GU' | 'KI' | 'MH' | 'MP' | 'NC' | 'NF' | 'NR' | 'NU' | 'NZ' | 'PF' | 'PG' | 'PN' | 'PW' | 'SB' | 'TK' | 'TO' | 'TV' | 'VU' | 'WF' | 'WS' | 'AQ' | 'EL' | 'UK' | 'XK' | 'XS' | 'XI', enum: Abbreviation of country (using ISO 3166 standards). (default: 'US') - `id` string, uuid: The project44-generated identifier for the address persisted in location-service. - `postalCode` string: The ZIP or postal code. - `state` string: Abbreviation of state, province, district, etc. - `contactInfo` BookingContact - `companyName` string: Name of the Company with whom the Contact is associated. - `email` string, email: The Contact's email address. - `familyName` string: The Contact's last or family name. - `givenName` string: The Contact's first or given name. - `mobilePhoneNumber` string: The Contact's mobile phone number. - `phoneNumber` string: The Contact's work or other primary phone number. - `identifyingCodes` IdentifyingCodes - `codeListProvider` 'WAVE' | 'CARX' | 'ESSD' | 'IDT' | 'BOLE' | 'EDOX' | 'IQAX' | 'SECR' | 'TRGO' | 'ETEU' | 'TRAC' | 'BRIT' | 'GSBN' | 'WISE' | 'GLEIF' | 'W3C' | 'DNB' | 'FMC' | 'DCSA' | 'ZZZ': An enumeration. - `codeListName` 'DID' | 'LEI' | 'DUNS': An enumeration. - `partyCode` string: Code to identify the party as provided by the code list provider - `locationIdentifiers` RatingLocationIdentifier[]: Identifiers for the location of the party. - `type` 'UNKNOWN' | 'AIRPORT_IATA' | 'AIRPORT_ICAO' | 'PORT_UN_LOCODE' | 'RAIL_SPLC' | 'DATA_PROVIDER_LOCATION_CODE' | 'LOCODE': An enumeration. - `value` string - `partyType` 'SHIPPER' | 'CONSIGNEE' | 'BILL_TO' | 'NOTIFY_PARTY' | 'BOOKING_AGENT' | 'CARRIER_BOOKING_OFFICE': An enumeration. - `vatNumber` string: Optional, VAT number of the listed party, if applicable. - `serviceType` 'PORT_TO_PORT' | 'PORT_TO_DOOR' | 'DOOR_TO_PORT' | 'DOOR_TO_DOOR': An enumeration. - `ltl` LtlDetails - `capacityProviderAccountGroup` CapacityProviderAccountGroup: The requested capacity provider account group containing the account used for authentication with the capacity provider's API. - `accounts` CapacityProviderAccount[]: Capacity provider accounts used for authentication with the capacity providers' APIs. For quoting, defaults to all accounts within the account group. For shipment, shipment status, and image, one and only one account is required. - `code` string: The code for the requested capacity provider account that was used for authentication with the capacity provider's API. - `code` string: The code for the capacity provider account group that contains all accounts against which an operation is to be performed. Capacity provider account groups are set up through the project44 Self-Service Portal. If no key is specified, the 'Default' account group will be used. - `ocean` OceanDetails - `accessorials` union[]: Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier. - union - RefrigeratedAccessorial: Accessorial which defines the acceptable temperature range for a transportation container. - … - LiftgateAccessorial: Accessorial which flags the explicit need for liftgate service. - … - TarpsAccessorial: Accessorial which delineates the expected size and number of tarps used in shipping. - … - StrapsAccessorial: Accessorial which delineates the expected size and number of straps used in shipping. - … - ChainsAccessorial: Accessorial which delineates the expected size and number of chains used in shipping. - … - DeckHeightAccessorial: Accessorial which defined the expected height of the deck on the vehicle. - … - CraneAccessorial: Accessorial which flags the explicit need for crane service. - … - CallBeforeArrivalAccessorial: Accessorial which flags the explicit need for call before arrival to a stop service. - … - DockRequiredAccessorial: Accessorial which flags the explicit need for dock service. - … - LockedGateAccessorial: Accessorial which flags the explicit need for locked gate service. - … - FirstComeFirstServedAccessorial: Accessorial which flags the explicit need for first come, first served service. - … - AppointmentRequiredAccessorial: Accessorial which flags the explicit need for appointment service. - … - WhiteGloveAccessorial: Accessorial which flags the explicit need for white glove service. - … - HazmatAccessorial: Accessorial for describing the HAZMAT Class and UN Code for transportable goods. - … - ExcessiveLengthAccessorial: Accessorial which flags the explicit need for appointment service. - … - GuaranteedServiceLevelAccessorial: Accessorial which flags the explicit need for appointment service. - … - OtherAccessorial: Accessorial which does not require any additional details. - … - `bookingType` 'LESS_THAN_CONTAINER_LOAD' | 'FULL_CONTAINER_LOAD' | 'ROLL_ON_ROLL_OFF' | 'OUT_OF_GAUGE': An enumeration. - `cargoMeasurements` CargoMeasurements - `dimensions` Dimensions - `height` number - `length` number - `unit` 'FT' | 'M' | 'IN' | 'CM' | 'MI' | 'KM': An enumeration. - `width` number - `volume` Volume - `unit` 'CUBIC_FT' | 'CUBIC_M' | 'L' | 'HL': The unit of measurement for this volume. - `value` number: The numeric decimal value of this volume. - `weight` BookingWeight - `unit` 'LB' | 'KG', enum: Weight measurement units (default: 'LB'). - `value` number: The numeric decimal value of this weight. - `containerCount` union: Number of equipment requested for a booking needs to be provided here. Only required when booking `FULL_CONTAINER_LOAD` or `OUT_OF_GAUGE`. - FullContainerLoadContainerCount: Number of containers that has been fully occupied by single consignee. At least one field must be provided. - `dryCargoCount` DryCargoContainerCount - … - `reeferCount` ReeferContainerCount - … - OutOfGaugeContainerCount - `fortyFootContainerCount` integer: Count of 40ft flat-rack containers - `twentyFootContainerCount` integer: Count of 20ft flat-rack containers - `incoterm` 'EXW' | 'FCA' | 'FAS' | 'FOB' | 'CFR' | 'CIF' | 'CPT' | 'CIP' | 'DPU' | 'DAP' | 'DDP': International commercial terms according to the [ICC](https://iccwbo.org/). EXW: EX WORKS, FCA: FREE CARRIER, FAS: FREE ALONGSIDE SHIP, FOB: FREE ON BOARD, CFR: COST & FREIGHT, CIF: COST, INSURANCE & FREIGHT CPT: COST PAID TO, CIP: CARRIER & INSURANCE PAID TO, DPU: DELIVERED AT PLACE UNLOADED DAP: DELIVERED AT PLACE, DDP: DELIVERED DUTY PAID - `parties` Party[]: Individual shipper-represented groups which are involved with the shipment. - `addressInfo` PartyAddress: A postal address. - `addressLines` string[]: Street name, number, direction, PO box, etc. Only three address lines are currently permitted. - `addressLabel` string: The project44-generated label for the address persisted in location-service. - `city` string: Name of city, town, etc. - `country` 'US' | 'CA' | 'MX' | 'AG' | 'BB' | 'BS' | 'BZ' | 'CR' | 'CU' | 'DM' | 'DO' | 'GD' | 'GT' | 'HN' | 'HT' | 'JM' | 'KN' | 'LC' | 'NI' | 'PA' | 'SV' | 'TT' | 'VC' | 'AI' | 'AW' | 'BL' | 'BM' | 'BQ' | 'CW' | 'GL' | 'GP' | 'KY' | 'MF' | 'MQ' | 'MS' | 'PM' | 'PR' | 'SX' | 'TC' | 'UM' | 'VG' | 'VI' | 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'DE' | 'EE' | 'ES' | 'FI' | 'FR' | 'GB' | 'GR' | 'HR' | 'HU' | 'IE' | 'IT' | 'LT' | 'LU' | 'LV' | 'MT' | 'NL' | 'PL' | 'PT' | 'RO' | 'SE' | 'SK' | 'SI' | 'CH' | 'IS' | 'LI' | 'NO' | 'AL' | 'ME' | 'MK' | 'RS' | 'TR' | 'AD' | 'AX' | 'BA' | 'BV' | 'BY' | 'FO' | 'GG' | 'GI' | 'IM' | 'IO' | 'JE' | 'MC' | 'MD' | 'SJ' | 'SM' | 'TF' | 'UA' | 'VA' | 'AE' | 'AF' | 'AM' | 'AZ' | 'BD' | 'BH' | 'BN' | 'BT' | 'CN' | 'GE' | 'HK' | 'ID' | 'IL' | 'IN' | 'IQ' | 'IR' | 'JO' | 'JP' | 'KG' | 'KH' | 'KP' | 'KR' | 'KW' | 'KZ' | 'LA' | 'LB' | 'LK' | 'MM' | 'MN' | 'MO' | 'MV' | 'MY' | 'NP' | 'OM' | 'PH' | 'PK' | 'PS' | 'QA' | 'RU' | 'SA' | 'SG' | 'SY' | 'TH' | 'TJ' | 'TL' | 'TM' | 'TW' | 'UZ' | 'VN' | 'YE' | 'AO' | 'BF' | 'BI' | 'BJ' | 'BW' | 'CD' | 'CF' | 'CG' | 'CI' | 'CM' | 'CV' | 'DJ' | 'DZ' | 'EG' | 'EH' | 'ER' | 'ET' | 'GA' | 'GH' | 'GM' | 'GN' | 'GQ' | 'GW' | 'HM' | 'KE' | 'KM' | 'LR' | 'LS' | 'LY' | 'MA' | 'MG' | 'ML' | 'MR' | 'MU' | 'MW' | 'MZ' | 'NA' | 'NE' | 'NG' | 'RE' | 'RW' | 'SC' | 'SD' | 'SH' | 'SL' | 'SN' | 'SO' | 'SS' | 'ST' | 'SZ' | 'TD' | 'TG' | 'TN' | 'TZ' | 'UG' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'EC' | 'FK' | 'GF' | 'GS' | 'GY' | 'PE' | 'PY' | 'SR' | 'UY' | 'VE' | 'AS' | 'AU' | 'CC' | 'CK' | 'CX' | 'FJ' | 'FM' | 'GU' | 'KI' | 'MH' | 'MP' | 'NC' | 'NF' | 'NR' | 'NU' | 'NZ' | 'PF' | 'PG' | 'PN' | 'PW' | 'SB' | 'TK' | 'TO' | 'TV' | 'VU' | 'WF' | 'WS' | 'AQ' | 'EL' | 'UK' | 'XK' | 'XS' | 'XI', enum: Abbreviation of country (using ISO 3166 standards). (default: 'US') - `id` string, uuid: The project44-generated identifier for the address persisted in location-service. - `postalCode` string: The ZIP or postal code. - `state` string: Abbreviation of state, province, district, etc. - `contactInfo` BookingContact - `companyName` string: Name of the Company with whom the Contact is associated. - `email` string, email: The Contact's email address. - `familyName` string: The Contact's last or family name. - `givenName` string: The Contact's first or given name. - `mobilePhoneNumber` string: The Contact's mobile phone number. - `phoneNumber` string: The Contact's work or other primary phone number. - `identifyingCodes` IdentifyingCodes - `codeListProvider` 'WAVE' | 'CARX' | 'ESSD' | 'IDT' | 'BOLE' | 'EDOX' | 'IQAX' | 'SECR' | 'TRGO' | 'ETEU' | 'TRAC' | 'BRIT' | 'GSBN' | 'WISE' | 'GLEIF' | 'W3C' | 'DNB' | 'FMC' | 'DCSA' | 'ZZZ': An enumeration. - `codeListName` 'DID' | 'LEI' | 'DUNS': An enumeration. - `partyCode` string: Code to identify the party as provided by the code list provider - `locationIdentifiers` RatingLocationIdentifier[]: Identifiers for the location of the party. - `type` 'UNKNOWN' | 'AIRPORT_IATA' | 'AIRPORT_ICAO' | 'PORT_UN_LOCODE' | 'RAIL_SPLC' | 'DATA_PROVIDER_LOCATION_CODE' | 'LOCODE': An enumeration. - `value` string - `partyType` 'SHIPPER' | 'CONSIGNEE' | 'BILL_TO' | 'NOTIFY_PARTY' | 'BOOKING_AGENT' | 'CARRIER_BOOKING_OFFICE': An enumeration. - `vatNumber` string: Optional, VAT number of the listed party, if applicable. - `serviceType` 'CONTAINER_YARD_TO_CONTAINER_YARD' | 'CONTAINER_YARD_TO_DOOR' | 'DOOR_TO_CONTAINER_YARD' | 'DOOR_TO_DOOR': An enumeration. - `truck` TruckDetails - `accessorials` union[]: Optional list of descriptors which detail any add-ons or declarations applicable which may be noteworthy to the carrier. - union - RefrigeratedAccessorial: Accessorial which defines the acceptable temperature range for a transportation container. - … - LiftgateAccessorial: Accessorial which flags the explicit need for liftgate service. - … - TarpsAccessorial: Accessorial which delineates the expected size and number of tarps used in shipping. - … - StrapsAccessorial: Accessorial which delineates the expected size and number of straps used in shipping. - … - ChainsAccessorial: Accessorial which delineates the expected size and number of chains used in shipping. - … - DeckHeightAccessorial: Accessorial which defined the expected height of the deck on the vehicle. - … - CraneAccessorial: Accessorial which flags the explicit need for crane service. - … - CallBeforeArrivalAccessorial: Accessorial which flags the explicit need for call before arrival to a stop service. - … - DockRequiredAccessorial: Accessorial which flags the explicit need for dock service. - … - LockedGateAccessorial: Accessorial which flags the explicit need for locked gate service. - … - FirstComeFirstServedAccessorial: Accessorial which flags the explicit need for first come, first served service. - … - AppointmentRequiredAccessorial: Accessorial which flags the explicit need for appointment service. - … - WhiteGloveAccessorial: Accessorial which flags the explicit need for white glove service. - … - HazmatAccessorial: Accessorial for describing the HAZMAT Class and UN Code for transportable goods. - … - ExcessiveLengthAccessorial: Accessorial which flags the explicit need for appointment service. - … - GuaranteedServiceLevelAccessorial: Accessorial which flags the explicit need for appointment service. - … - OtherAccessorial: Accessorial which does not require any additional details. - … - `flatbedType` 'CONESTOGA' | 'DOUBLE_DROP': An enumeration. - `loadPreference` 'FULL' | 'PARTIAL': An enumeration. - `trailerType` 'FLATBED' | 'REFRIGERATED' | 'DRY_VAN' | 'VAN_CURTAINS' | 'MEGA' | 'TANKER' | 'LOWBOY' | 'JUMBO' | 'AUTO_CARRIER' | 'TRAILER' | 'VAN' | 'STRETCH_TRAILER' | 'CONTAINER': An enumeration. - `trailerLength` Length - `unit` 'FT' | 'M' | 'IN' | 'CM' | 'MI' | 'KM': An enumeration. - `value` number: The numeric decimal value of this length. - `trailerVolume` Volume - `unit` 'CUBIC_FT' | 'CUBIC_M' | 'L' | 'HL': The unit of measurement for this volume. - `value` number: The numeric decimal value of this volume. - `trailerDetails` RefrigeratedTrailerDetails: Trailer details when trailer type is REFRIGERATED. Intermediary model to allow future fields. - `refrigeratedClass` 'AMBIENT' | 'CHILLED' | 'FROZEN' | 'DEEP_FROZEN': Temperature level for refrigerated trailers (different prices/carrier handling per level). - `volumeLtl` VolumeLtlDetails - `capacityProviderAccountGroup` CapacityProviderAccountGroup: The requested capacity provider account group containing the account used for authentication with the capacity provider's API. - `accounts` CapacityProviderAccount[]: Capacity provider accounts used for authentication with the capacity providers' APIs. For quoting, defaults to all accounts within the account group. For shipment, shipment status, and image, one and only one account is required. - `code` string: The code for the requested capacity provider account that was used for authentication with the capacity provider's API. - `code` string: The code for the capacity provider account group that contains all accounts against which an operation is to be performed. Capacity provider account groups are set up through the project44 Self-Service Portal. If no key is specified, the 'Default' account group will be used. - `totalLinearFeet` integer: The total linear feet that the shipment being quoted will take up in a trailer. Required only for volume LTL shipments - `shipmentDetails` RatingShipmentDetails[]: Descriptive information about the load to be transported; if the load does not change between route segments, this body is expected to be the same across each route-segment body. - `accessorials` union[]: Optional list of descriptors which detail any add-ons or declarations applicable to your shipment which may be noteworthy to the carrier. - union - RefrigeratedAccessorial: Accessorial which defines the acceptable temperature range for a transportation container. - `code` 'REFRIGERATED' - `details` TempRangeKind - … - LiftgateAccessorial: Accessorial which flags the explicit need for liftgate service. - `code` 'LIFTGATE' - `details` SpecificationKindBool - … - TarpsAccessorial: Accessorial which delineates the expected size and number of tarps used in shipping. - `code` 'TARPS' - `details` QuantityKind - … - StrapsAccessorial: Accessorial which delineates the expected size and number of straps used in shipping. - `code` 'STRAPS' - `details` QuantityKind - … - ChainsAccessorial: Accessorial which delineates the expected size and number of chains used in shipping. - `code` 'CHAINS' - `details` QuantityKind - … - DeckHeightAccessorial: Accessorial which defined the expected height of the deck on the vehicle. - `code` 'DECK_HEIGHT' - `details` SpecificationKindDeckHeight - … - CraneAccessorial: Accessorial which flags the explicit need for crane service. - `code` 'CRANE' - `details` SpecificationKindBool - … - CallBeforeArrivalAccessorial: Accessorial which flags the explicit need for call before arrival to a stop service. - `code` 'CALL_BEFORE_ARRIVAL' - `details` SpecificationKindBool - … - DockRequiredAccessorial: Accessorial which flags the explicit need for dock service. - `code` 'DOCK_REQUIRED' - `details` SpecificationKindBool - … - LockedGateAccessorial: Accessorial which flags the explicit need for locked gate service. - `code` 'LOCKED_GATE' - `details` SpecificationKindBool - … - FirstComeFirstServedAccessorial: Accessorial which flags the explicit need for first come, first served service. - `code` 'FIRST_COME_FIRST_SERVED' - `details` SpecificationKindBool - … - AppointmentRequiredAccessorial: Accessorial which flags the explicit need for appointment service. - `code` 'APPOINTMENT_REQUIRED' - `details` SpecificationKindBool - … - WhiteGloveAccessorial: Accessorial which flags the explicit need for white glove service. - `code` 'WHITE_GLOVE' - `details` SpecificationKindBool - … - HazmatAccessorial: Accessorial for describing the HAZMAT Class and UN Code for transportable goods. - `code` 'HAZMAT' - `details` HazmatKind - … - ExcessiveLengthAccessorial: Accessorial which flags the explicit need for appointment service. - `code` 'EXCESSIVE_LENGTH' - `details` SpecificationKindExcessiveLength - … - GuaranteedServiceLevelAccessorial: Accessorial which flags the explicit need for appointment service. - `code` 'GUARANTEED' - `details` SpecificationKindGuaranteedByHour - … - OtherAccessorial: Accessorial which does not require any additional details. - `code` union: Accessorial code. - … - `deliveryStopId` string, uuid: The unique ID for the location where the handling unit should be delivered. - `description` string: Free text space to describe the handling unit. - `handlingUnits` HandlingUnit[]: Content of the shipment to be transported. - `commodityType` string: This code dictates the duty rating, as well as alerts you to any import or export restrictions. - `contact` Contact: Contact information. - `companyName` string: Company name. - `contactName` string: Contact name. May be required for shipments. - `email` string: Email address. May be required for shipments. - `faxNumber` string: Fax number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `faxNumberCountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `phoneNumber` string: Phone number. May be required for shipments. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `phoneNumber2` string: Alternate phone number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `phoneNumber2CountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `phoneNumberCountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `deliveryStopNumber` integer: A reference to the stop number where this item will be dropped off. For LTL this value should always be 2. - `description` string: A brief description of the handling unit and its contents. - `freightClasses` string[]: A list of freight classes for this handling unit. - `handlingUnitDimensions` CubicDimension: A cubic dimension. - `height` number: Height measurement. - `length` number: Length measurement. - `width` number: Width measurement. - `handlingUnitQuantity` integer: The number of handling units identical to this one. - `handlingUnitType` 'BAG' | 'BALE' | 'BARREL' | 'BOX' | 'BUCKET' | 'BUNDLE' | 'CAN' | 'CARTON' | 'CASE' | 'COIL' | 'CRATE' | 'CYLINDER' | 'DRUM' | 'PACK' | 'PAIL' | 'PALLET' | 'PIECES' | 'REEL' | 'ROLL' | 'SKID' | 'TOTE' | 'TRAY' | 'TUBE': The type of the handling unit. - `harmonizedCode` string: Harmonized System (HS) Code for the product as defined by the World Customers Organization, usually 6 characters in length, but up to 10 characters as defined by customs organizations by country.In the US, this would be the HTS or HTSA Code as defined by the US International Trade Commission. - `nmfcCodes` NmfcCode[]: A list of the NMFC codes associated with this shipment. - `code` string: NMFC item and sub code. Codes can only contain numeric characters and the '-' character. The item code must be 4 to 6 digits long. The '-' and sub code are optional, but if sub code is included it is 1 to 2 digits long. Must be in format XXXXXX-XX. - `packages` Package[]: The packages on/in this handling unit. - `contact` Contact: Contact information. - `companyName` string: Company name. - `contactName` string: Contact name. May be required for shipments. - `email` string: Email address. May be required for shipments. - `faxNumber` string: Fax number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `faxNumberCountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `phoneNumber` string: Phone number. May be required for shipments. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `phoneNumber2` string: Alternate phone number. E.164 or North American Number Plan (NANP) phone numbers are accepted. If a phone number is passed in without the associated country code field, the number will be treated as a number that adheres to the NANP standard. The number will be returned in responses in the NANP format: '[+123 ]123-456-7890[, ext. 123456]'. If the associated country code field is passed in as well, the number will be treated as a number that adheres to the E.164 international phone number standard. The number will be returned in a response in the E.164 format: '[+123 ]12345678910[, ext. 123456]'. In requests, only digits and an optional 'X' (or lowercase 'x') marking the start of an extension will be used. Any other characters included for formatting will be stripped -- project44 will provide the phone number to the capacity provider in the format they accept. There must be at least ten digits before the optional 'X' (for the area code, central office code, and station code for NANP numbers or simply the subscriber number for E.164 numbers). For NANP numbers, no more than thirteen, with the first digits exceeding ten being interpreted as the country code when the country code. The number of digits after the optional 'X' must be less than seven. Examples of acceptable NANP phone numbers: '123-456-7890 x 32', '(123)456-7890 ext 30', '1234567890', '11234567890', '+55-123-456-7890 ext. 312412', '123-456-7890, ext. 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]123-456-7890[, ext. 123456]'. Examples of acceptable E.164 phone numbers: '20-1234-5678 x 1234', '(20) 1234-5678x1234', '2012345678', '20 1234-5678 ext 1234'. In responses, phone numbers will be returned in the following format: '[+123 ]2012345678[, ext. 1234]'. - `phoneNumber2CountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `phoneNumberCountryCode` string: The country code associated with the phone number. If this is blank, the phone number will be treated as a number that adheres to the North American Number Plan (NANP) format. Acceptable country codes formats: '+123' or '123'. - `description` string: A brief description of the package and its contents. - `freightClass` '50' | '55' | '60' | '65' | '70' | '77.5' | '85' | '92.5' | '100' | '110' | '125' | '150' | '175' | '200' | '250' | '300' | '400' | '500': The freight class in this package. - `involvedParties` Party[]: A list of parties and their identifiers related to the line item. These are your customers receiving this line item or your suppliers providing this line item. - `addressInfo` PartyAddress: A postal address. - … - `contactInfo` BookingContact - … - `identifyingCodes` IdentifyingCodes - … - `locationIdentifiers` RatingLocationIdentifier[]: Identifiers for the location of the party. - … - `partyType` 'SHIPPER' | 'CONSIGNEE' | 'BILL_TO' | 'NOTIFY_PARTY' | 'BOOKING_AGENT' | 'CARRIER_BOOKING_OFFICE': An enumeration. - `vatNumber` string: Optional, VAT number of the listed party, if applicable. - `nmfcCodes` NmfcCode[]: A list of the NMFC codes associated with this shipment. - `code` string: NMFC item and sub code. Codes can only contain numeric characters and the '-' character. The item code must be 4 to 6 digits long. The '-' and sub code are optional, but if sub code is included it is 1 to 2 digits long. Must be in format XXXXXX-XX. - `packageContainerType` 'BAG' | 'BALE' | 'BOX' | 'BUCKET' | 'PAIL' | 'BUNDLE' | 'CAN' | 'CARTON' | 'CASE' | 'COIL' | 'CRATE' | 'CYLINDER' | 'EACH' | 'FLAT' | 'LOOSE' | 'ROLL' | 'TUBE': The type of the package. - `packageContents` PackageContents[]: A description of the items contained in the package. - `countryOfManufacture` 'US' | 'CA' | 'MX' | 'AG' | 'BB' | 'BS' | 'BZ' | 'CR' | 'CU' | 'DM' | 'DO' | 'GD' | 'GT' | 'HN' | 'HT' | 'JM' | 'KN' | 'LC' | 'NI' | 'PA' | 'SV' | 'TT' | 'VC' | 'AI' | 'AW' | 'BL' | 'BM' | 'BQ' | 'CW' | 'GL' | 'GP' | 'KY' | 'MF' | 'MQ' | 'MS' | 'PM' | 'PR' | 'SX' | 'TC' | 'UM' | 'VG' | 'VI' | 'AT' | 'BE' | 'BG' | 'CY' | 'CZ' | 'DK' | 'DE' | 'EE' | 'ES' | 'FI' | 'FR' | 'GB' | 'GR' | 'HR' | 'HU' | 'IE' | 'IT' | 'LT' | 'LU' | 'LV' | 'MT' | 'NL' | 'PL' | 'PT' | 'RO' | 'SE' | 'SK' | 'SI' | 'CH' | 'IS' | 'LI' | 'NO' | 'AL' | 'ME' | 'MK' | 'RS' | 'TR' | 'AD' | 'AX' | 'BA' | 'BV' | 'BY' | 'FO' | 'GG' | 'GI' | 'IM' | 'IO' | 'JE' | 'MC' | 'MD' | 'SJ' | 'SM' | 'TF' | 'UA' | 'VA' | 'AE' | 'AF' | 'AM' | 'AZ' | 'BD' | 'BH' | 'BN' | 'BT' | 'CN' | 'GE' | 'HK' | 'ID' | 'IL' | 'IN' | 'IQ' | 'IR' | 'JO' | 'JP' | 'KG' | 'KH' | 'KP' | 'KR' | 'KW' | 'KZ' | 'LA' | 'LB' | 'LK' | 'MM' | 'MN' | 'MO' | 'MV' | 'MY' | 'NP' | 'OM' | 'PH' | 'PK' | 'PS' | 'QA' | 'RU' | 'SA' | 'SG' | 'SY' | 'TH' | 'TJ' | 'TL' | 'TM' | 'TW' | 'UZ' | 'VN' | 'YE' | 'AO' | 'BF' | 'BI' | 'BJ' | 'BW' | 'CD' | 'CF' | 'CG' | 'CI' | 'CM' | 'CV' | 'DJ' | 'DZ' | 'EG' | 'EH' | 'ER' | 'ET' | 'GA' | 'GH' | 'GM' | 'GN' | 'GQ' | 'GW' | 'HM' | 'KE' | 'KM' | 'LR' | 'LS' | 'LY' | 'MA' | 'MG' | 'ML' | 'MR' | 'MU' | 'MW' | 'MZ' | 'NA' | 'NE' | 'NG' | 'RE' | 'RW' | 'SC' | 'SD' | 'SH' | 'SL' | 'SN' | 'SO' | 'SS' | 'ST' | 'SZ' | 'TD' | 'TG' | 'TN' | 'TZ' | 'UG' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'AR' | 'BO' | 'BR' | 'CL' | 'CO' | 'EC' | 'FK' | 'GF' | 'GS' | 'GY' | 'PE' | 'PY' | 'SR' | 'UY' | 'VE' | 'AS' | 'AU' | 'CC' | 'CK' | 'CX' | 'FJ' | 'FM' | 'GU' | 'KI' | 'MH' | 'MP' | 'NC' | 'NF' | 'NR' | 'NU' | 'NZ' | 'PF' | 'PG' | 'PN' | 'PW' | 'SB' | 'TK' | 'TO' | 'TV' | 'VU' | 'WF' | 'WS' | 'AQ' | 'EL' | 'UK' | 'XK' | 'XS' | 'XI': Country of manufacture of line item. - `description` string: A brief description of the contents. - `hazmatDetails` HazmatDetails[]: Required if the contents are hazardous materials. Provides important information about the hazardous materials to be transported, as required by the US Department of Transportation (DOT). - … - `packageContentIdentifiers` PackageContentIdentifier[]: The identifiers associated with the contents. - … - `packageContentQuantity` integer: The number of items contained in the package. - `packageDimensions` CubicDimension: A cubic dimension. - `height` number: Height measurement. - `length` number: Length measurement. - `width` number: Width measurement. - `packageQuantity` integer: The number of packages on the handling unit identical to this one. - `weightPerPackage` number: Weight per package. - `pickupStopNumber` integer: A reference to the stop number where this item will be picked up. For LTL this value should always be 1 - `stackable` boolean: True false value indicating whether or not the handling units can be stacked - `totalValue` MonetaryValue: A monetary value expressing amount and currency type. - `amount` number: The value of the shipment - `currency` 'USD' | 'CAD' | 'MXN' | 'EUR', enum: The currency of the shipment value - `weightPerHandlingUnit` number: Weight per handling unit. - `identifiers` LogisticsIdentifier[]: The identifiers that can identify this load. This could be, but not limited to, a shipment identifier such as a BOL or an order-based identifier such as `PURCHASE_ORDER`. - `type` 'AIR_WAYBILL' | 'BILL_OF_LADING' | 'HOUSE_BILL_OF_LADING' | 'BOOKING_NUMBER' | 'CARRIER_IATA' | 'CARRIER_ICAO' | 'CARRIER_NAME' | 'CARRIER_SCAC' | 'FFW_SCAC' | 'NVOCC_SCAC' | 'NVOCC_NAME' | 'FFW_NAME' | 'FFW_MASTER_ID' | 'NVOCC_MASTER_ID' | 'CONTAINER_ID' | 'CUSTOMER_REFERENCE' | 'DELIVERY_NUMBER' | 'EXTERNAL' | 'FLIGHT_NUMBER' | 'ORDER' | 'PICKUP' | 'PRO' | 'PURCHASE_ORDER' | 'RAIL_CAR_ID' | 'RAIL_WAYBILL' | 'TRACKING_NUMBER' | 'TRAILER_ID' | 'UNKNOWN' | 'VESSEL_IMO' | 'VESSEL_NAME' | 'WAYBILL' | 'VESSEL_CALL_SIGN' | 'VESSEL_MMSI' | 'CARRIER_US_DOT_NUMBER' | 'CARRIER_MC_NUMBER' | 'SUBSCRIPTION_ID' | 'HOUSE_AIR_WAYBILL' | 'SALES_ORDER' | 'WAREHOUSE_MOVEMENT_ORDER' | 'ADVANCED_SHIPMENT_NOTICE' | 'DRIVER_MOBILE_PHONE_NUMBER' | 'VEHICLE_ID' | 'LICENSE_PLATE' | 'TRAILER_LICENSE_PLATE' | 'SENSITECH_DEVICE_ID' | 'EMERSON_DEVICE_ID' | 'TIVE_DEVICE_ID' | 'ZILLION_DEVICE_ID' | 'VOYAGE_NUMBER' | 'CARRIER_MASTER_ID' | 'CARRIER_NMC_ID' | 'CONTAINER_TYPE' | 'TRAIN_NUMBER' | 'WAGON_ID' | 'TRAIN_ID' | 'CAPACITY_PROVIDER_ACCOUNT_GROUP' | 'CAPACITY_PROVIDER_ACCOUNT_CODE' | 'SERIAL_NUMBER' | 'VEHICLE_IDENTIFICATION_NUMBER' | 'REFERENCE_NUMBER' | 'CONTAINER_PIN' | 'VESSEL_P44_ID' | 'EXPORT_CUSTOMS_BROKER' | 'IMPORT_CUSTOMS_BROKER' | 'POL_QUALITY_CONTROL_PROVIDER' | 'POD_QUALITY_CONTROL_PROVIDER' | 'AIRCRAFT_ICAO' | 'AIRLINE_NAME' | 'SEAL_NUMBER' | 'DRAYAGE_CARRIER_SCAC' | 'EXPORT_DRAYAGE_CARRIER_SCAC' | 'IMPORT_DRAYAGE_CARRIER_SCAC' | 'INBOUND_VOYAGE_NUMBER': The standard which defines who assigns the identifier and what it identifies. Required field. - `value` string: The value of this identifier. Required field. - `pickupStopId` string, uuid: The unique ID for the location where the handling unit should be picked up. - `shipperContactInfo` BookingContact - `companyName` string: Name of the Company with whom the Contact is associated. - `email` string, email: The Contact's email address. - `familyName` string: The Contact's last or family name. - `givenName` string: The Contact's first or given name. - `mobilePhoneNumber` string: The Contact's mobile phone number. - `phoneNumber` string: The Contact's work or other primary phone number. - `rateTypes` RateType[]: Optional. Limits which quote types are fetched for this rate request. Accepted values: 'CONTRACT', 'SPOT', 'ALL'. If omitted, all available quote types are fetched. - `ratingSourceMethod` 'API' | 'WEBAPP': Method by which a shipper initiates a rate request. - `status` 'OPEN' | 'QUOTES_REQUESTED' | 'QUOTES_RECEIVED': An enumeration. ## Other responses - `400`: Bad Request - `404`: Not Found --- [API](https://skmtc.dev/project44/apis/project44-rest-api.md) - [All operations](https://skmtc.dev/project44/apis/project44-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/project44/apis/project44-rest-api/revisions/cdf9675e2294?raw)