Rate Data Providers
Purpose
This integration is used to improve sales and margins by integrating your TMS with a leading rate management system allowing instant quoting and lead conversion.
Roles
These roles describe the different systems involved in this integration:
- TMS - this is the shipper or freight forwarder's system that houses shipment data. It may be a traditional transportation management system, an ERP, or even an online spreadsheet.
- Rate Management System - (RMS) this is the system responsible for managing your shipment rates.
Flow Types
| Flow Type | Key | Description | Input Converter | Output Converter |
|---|---|---|---|---|
| Send Shipment Rate Request | rateQuote.send_shipment_rate_request | Send a request for rates for a single shipment from your TMS to your rate management system. | TMS | RMS |
| Receive Shipment Rate Response | rateQuote.receive_shipment_rate_response | Receive rates for a single shipment back from your RMS. | RMS | TMS |
| Receive Booking | rateQuote.receive_booking | Receive a booking made in your RMS. | RMS | TMS |
Send Shipment Rate Request
Sample payloads output by the TMS's Input Converter and sent the RMS's Output Converter
{
"tms_system_identifier": "S189011",
"company_code": "XYZ",
"department_code": "OID",
"branch_code": "LA",
"transport_mode": "sea",
"movement_type": "door_to_door",
"containerization_type": "fcl",
"estimated_departure_date": "2024-02-01",
"customer": {
"identifiers": [
{
"code_type": "tms_external_identifier",
"code": "THECUSTOMER"
},
{
"code_type": "rms_external_identifier",
"code": "CUST1"
}
],
"name": "The Customer"
},
"carrier": {
"identifiers": [
{
"code_type": "scac",
"code": "MAEU"
}
],
"name": "Maersk"
},
"freight_payment_terms": "prepaid",
"inco_terms": "exw",
"gross_weight": {
"amount": 6000,
"unit": "kilogram"
},
"containers": [
{
"type_code": "42GP",
"quantity": 1,
"gross_weight": {
"amount": 6000,
"unit": "kilogram"
},
"outer_packs": [
{
"gross_weight": {
"amount": 2000,
"unit": "kilogram"
},
"number_of_packages": 10,
"package_type_code": "AG",
"package_type_description": "Pallet, shrinkwrapped"
}
]
}
],
"routing_legs": [
{
"leg_type": "pre_carriage",
"origin": {
"type": "address",
"name": "Sheraton Hanoi",
"address_1": "K5 Nghi Tam",
"address_2": "11 Đ. Xuân Diệu Road",
"city": "Hà Nội",
"country": "VN",
"postal_code": "100000"
},
"destination": {
"type": "unlocode",
"unlocode": "VNHAI"
},
"custom_properties": {
"first_leg": true
}
},
{
"leg_type": "main",
"origin": {
"type": "unlocode",
"unlocode": "VNHAI"
},
"destination": {
"type": "unlocode",
"unlocode": "TWKHH"
}
},
{
"leg_type": "main",
"origin": {
"type": "unlocode",
"unlocode": "TWKHH"
},
"destination": {
"type": "unlocode",
"unlocode": "USLGB"
}
},
{
"leg_type": "on_carriage",
"origin": {
"type": "unlocode",
"unlocode": "USLGB"
},
"destination": {
"type": "address",
"name": "Sheraton Grand Los Angeles",
"address_1": "711 South Hope St",
"city": "Los Angeles",
"country": "US",
"postal_code": "90017"
},
"custom_properties": {
"last_leg": true
}
}
],
"custom_properties": {
"rate_types": ["buy", "sell"]
}
}
{
"tms_system_identifier": "S189011",
"transport_mode": "air",
"movement_type": "port_to_port",
"estimated_departure_date": "2024-02-01",
"customer": {
"identifiers": [
{
"code_type": "tms_external_identifier",
"code": "THECUSTOMER"
},
{
"code_type": "rms_external_identifier",
"code": "CUST1"
}
],
"name": "The Customer"
},
"carrier": {
"identifiers": [
{
"code_type": "iata",
"code": "AA"
}
],
"name": "American Airlines"
},
"carrier_service_level": "express",
"freight_payment_terms": "prepaid",
"gross_weight": {
"amount": 500,
"unit": "kilogram"
},
"volume": {
"amount": 2,
"unit": "cubic_meter"
},
"outer_packs": [
{
"number_of_packages": 24,
"package_type_code": "CT",
"package_type_description": "Carton"
}
],
"routing_legs": [
{
"leg_type": "main",
"origin": {
"type": "airport",
"iata_code": "SGN"
},
"destination": {
"type": "airport",
"iata_code": "LAX"
}
}
]
}
Receive Shipment Rate Response / Receive Booking
Sample payloads output by the RMS's Input Converter and sent the TMS's Output Converter. The receive shipment rate response and receive booking integration utilize the same schema.
{
"rates": [
{
"rms_rate_identifier": "bfdd2d21-687e-4d0a-b752-8e6fef05da51",
"tms_system_identifier": "S198210",
"quote_number": "Q781891",
"carrier_contract_number": "HDMU_HLS_CFI_HDMU189",
"transport_mode": "sea",
"movement_type": "door_to_port",
"containerization_type": "fcl",
"carrier": {
"identifiers": [
{
"code_type": "scac",
"code": "MAEU"
},
{
"code_type": "rms_external_identifier",
"code": "MAERSK"
}
],
"name": "Maersk"
},
"customer": {
"identifiers": [
{
"code_type": "rms_external_identifier",
"code": "CUS18919"
},
{
"code_type": "tms_external_identifier",
"code": "CUSTOMER"
}
],
"name": "The Customer"
},
"rate_start_date": "2024-01-01",
"rate_end_date": "2024-04-01",
"estimated_departure_date": "2024-03-12",
"freight_payment_terms": "collect",
"inco_terms": "exw",
"description_of_goods": "Hexagonal aluminum bicycle nuts",
"gross_weight": {
"amount": 15000,
"unit": "kilogram"
},
"volume": {
"amount": 30,
"unit": "cubic_meter"
},
"containers": [
{
"type_code": "20GP",
"quantity": 1
}
],
"routing_legs": [
{
"routing_leg_identifier": "1",
"leg_type": "pre_carriage",
"transport_mode": "road",
"origin": {
"type": "address",
"city": "Dinxperlo",
"country": "NL"
},
"destination": {
"type": "unlocode",
"unlocode": "NLRTM",
"unlocode_description": "Rotterdam"
},
"carrier": {
"identifiers": [
{
"code_type": "rms_external_identifier",
"code": "0261"
}
],
"name": "Dutch Transport"
},
"transit_time": {
"minimum_duration": 1,
"maximum_duration": 1,
"unit": "day"
}
},
{
"routing_leg_identifier": "2",
"leg_type": "main",
"transport_mode": "sea",
"origin": {
"type": "unlocode",
"unlocode": "NLRTM"
},
"destination": {
"type": "unlocode",
"unlocode": "USMIA"
},
"carrier": {
"identifiers": [
{
"code_type": "scac",
"code": "MAEU"
},
{
"code_type": "rms_external_identifier",
"code": "MAERSK"
}
],
"name": "Maersk"
},
"transit_time": {
"minimum_duration": 14,
"maximum_duration": 14,
"unit": "day"
}
}
],
"buy_charges": [
{
"charge_code": "OPICK",
"rms_charge_identifier": "OPICK",
"description": "Origin Pickup",
"charge_total": {
"amount": 310,
"currency": "EUR"
},
"payment_terms": "collect",
"routing_leg_identifier": "1",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "1"
},
{
"charge_code": "OFUEL",
"rms_charge_identifier": "OIFS",
"description": "Origin Inland Fuel Surcharge (8.0% of Origin Pickup)",
"charge_total": {
"amount": 24.80,
"currency": "EUR"
},
"payment_terms": "collect",
"routing_leg_identifier": "1",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "2"
},
{
"charge_code": "FREIGHT",
"rms_charge_identifier": "BR",
"description": "Base Rate",
"charge_total": {
"amount": 1225,
"currency": "USD"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "3"
},
{
"charge_code": "BAF",
"rms_charge_identifier": "BSC",
"description": "Booking Service Charge",
"charge_total": {
"amount": 10,
"currency": "USD"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "4"
},
{
"charge_code": "FREIGHT",
"rms_charge_identifier": "ISOCC",
"description": "IMO SOX Compliance Charge",
"charge_total": {
"amount": 11,
"currency": "USD"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "5"
},
{
"charge_code": "DTHC",
"rms_charge_identifier": "DTHC",
"description": "Destination Terminal Handling Charge",
"charge_total": {
"amount": 450,
"currency": "USD"
},
"payment_terms": "prepaid",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "6"
}
],
"sell_charges": [
{
"charge_code": "OPICK",
"rms_charge_identifier": "OPICK",
"description": "Origin Pickup",
"charge_total": {
"amount": 310,
"currency": "EUR"
},
"payment_terms": "collect",
"routing_leg_identifier": "1",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "1"
},
{
"charge_code": "OFUEL",
"rms_charge_identifier": "OIFS",
"description": "Origin Inland Fuel Surcharge (8.0% of Origin Pickup)",
"charge_total": {
"amount": 24.80,
"currency": "EUR"
},
"payment_terms": "collect",
"routing_leg_identifier": "1",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "2"
},
{
"charge_code": "FREIGHT",
"rms_charge_identifier": "BR",
"description": "Base Rate",
"charge_total": {
"amount": 1225,
"currency": "USD"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "3"
},
{
"charge_code": "BAF",
"rms_charge_identifier": "BSC",
"description": "Booking Service Charge",
"charge_total": {
"amount": 10,
"currency": "USD"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "4"
},
{
"charge_code": "FREIGHT",
"rms_charge_identifier": "ISOCC",
"description": "IMO SOX Compliance Charge",
"charge_total": {
"amount": 11,
"currency": "USD"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "5"
},
{
"charge_code": "DTHC",
"rms_charge_identifier": "DTHC",
"description": "Destination Terminal Handling Charge",
"charge_total": {
"amount": 450,
"currency": "USD"
},
"payment_terms": "prepaid",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01",
"sell_charge_identifier": "6"
},
{
"charge_code": "VGM",
"rms_charge_identifier": "VGMF",
"description": "VGM Administration Fee",
"charge_total": {
"amount": 35,
"currency": "USD"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01"
},
{
"charge_code": "ODOC",
"rms_charge_identifier": "EXPDOC",
"description": "Export Documentation Fee",
"charge_total": {
"amount": 65,
"currency": "EUR"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01"
},
{
"charge_code": "OBILL",
"rms_charge_identifier": "BOLF",
"description": "Bill of Lading Fee",
"charge_total": {
"amount": 55,
"currency": "EUR"
},
"payment_terms": "collect",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-03-01"
}
]
}
]
}
{
"rates": [
{
"tms_system_identifier": "3e21fb6e-4228-4a91-a734-792acb99b469",
"carrier_service_level": "Economy",
"rate_start_date": "2024-02-07",
"rate_end_date": "2024-02-29",
"carrier": {
"identifiers": [
{
"code_type": "iata",
"code": "UA"
}
],
"name": "United Airlines"
},
"customer": {
"identifiers": [
{
"code_type": "rms_external_identifier",
"code": "THECUST"
}
],
"name": "The Customer"
},
"routing_legs": [
{
"leg_type": "pre_carriage",
"transport_mode": "road",
"origin": {
"type": "address",
"city": "Rockingham",
"country_subdivision": "NC",
"country": "US",
"postal_code": "28379",
"unlocode": "USOYV"
},
"destination": {
"type": "airport",
"iata_code": "ATL",
"iata_code_description": "Hartsfield-Jackson Atlanta International Airport"
},
"routing_leg_identifier": "1"
},
{
"leg_type": "main",
"transport_mode": "air",
"origin": {
"type": "airport",
"iata_code": "ATL",
"iata_code_description": "Hartsfield-Jackson Atlanta International Airport"
},
"destination": {
"type": "airport",
"iata_code": "FRA",
"iata_code_description": "Frankfurt am Main Airport"
},
"routing_leg_identifier": "2",
"transit_time": {
"minimum_duration": 7,
"maximum_duration": 7,
"unit": "day"
},
"carrier": {
"identifiers": [
{
"code_type": "iata",
"code": "UA"
}
],
"name": "United Airlines"
}
},
{
"leg_type": "main",
"transport_mode": "air",
"origin": {
"type": "airport",
"iata_code": "FRA",
"iata_code_description": "Frankfurt am Main Airport"
},
"destination": {
"type": "airport",
"iata_code": "DUS",
"iata_code_description": "Dusseldorf International Airport"
},
"routing_leg_identifier": "3",
"carrier": {
"identifiers": [
{
"code_type": "iata",
"code": "UA"
}
],
"name": "United Airlines"
}
},
{
"leg_type": "on_carriage",
"transport_mode": "road",
"origin": {
"type": "airport",
"iata_code": "FRA",
"iata_code_description": "Frankfurt am Main Airport"
},
"destination": {
"type": "address",
"city": "Emmerich",
"country_subdivision": "NRW",
"country": "DE",
"postal_code": "46446",
"unlocode": "DEEMM"
},
"routing_leg_identifier": "4"
}
],
"buy_charges": [
{
"charge_code": "FRT",
"rms_charge_identifier": "565192461",
"description": "Freight",
"charge_total": {
"amount": 300,
"currency": "USD"
},
"valid_start_date": "2024-01-01",
"valid_end_date": "2024-02-29",
"routing_leg_identifier": "2",
"charge_rate": {
"calculation_method": "chargeable_weight",
"min_max": "minimum",
"unit_of_measure": "kilogram",
"unit_cost": 0.85,
"total_quantity": 230.7347826825656
},
"sell_charge_identifier": "7401a2ab-288f-4957-9dbd-9b1b96f3842f"
}
],
"sell_charges": [
{
"charge_code": "OOHS",
"rms_charge_identifier": "89776",
"description": "OVERLENGTH / HEAVY WEIGHT SURCHARGE ORIGIN",
"charge_total": {
"amount": 295,
"currency": "USD"
},
"comments": "For LTL shipments of 8 FT / 244cm and over in length (linear footage ), additional fee of 295 USD will be added on top of delivery cost",
"routing_leg_identifier": "1",
"valid_start_date": "2024-01-17",
"charge_rate": {
"calculation_method": "flat",
"included_in_freight": false,
"optional": true
}
},
{
"charge_code": "OPCK",
"rms_charge_identifier": "86372",
"description": "PICK UP",
"charge_total": {
"amount": 185,
"currency": "USD"
},
"comments": "LTL, Non Guaranteed Service, Monday through Friday only",
"routing_leg_identifier": "1",
"valid_start_date": "2024-01-17",
"charge_rate": {
"calculation_method": "chargeable_weight",
"min_max": "minimum",
"included_in_freight": false,
"optional": false,
"unit_of_measure": "kilogram",
"unit_cost": 0.65
}
},
{
"charge_code": "OHAN",
"rms_charge_identifier": "86372",
"description": "HANDLING ORIGIN",
"charge_total": {
"amount": 45,
"currency": "USD"
},
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-17",
"charge_rate": {
"calculation_method": "flat",
"included_in_freight": false,
"optional": false
}
},
{
"charge_code": "OSCR",
"rms_charge_identifier": "86372",
"description": "SCREENING FEE ORIGIN",
"charge_total": {
"amount": 27.69,
"currency": "USD"
},
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-17",
"charge_rate": {
"calculation_method": "chargeable_weight",
"included_in_freight": false,
"optional": false,
"unit_of_measure": "kilogram",
"unit_cost": 0.12,
"total_quantity": 230.7347826825656
}
},
{
"charge_code": "OTHC",
"rms_charge_identifier": "86372",
"description": "TERMINAL HANDLING ORIGIN",
"charge_total": {
"amount": 34.61,
"currency": "USD"
},
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-17",
"charge_rate": {
"calculation_method": "chargeable_weight",
"included_in_freight": false,
"optional": false,
"unit_of_measure": "kilogram",
"unit_cost": 0.15
}
},
{
"charge_code": "OINP",
"rms_charge_identifier": "86372",
"description": "INSURANCE PREMIUM ORIGIN",
"charge_total": {
"amount": 0,
"currency": "USD"
},
"comments": "Insurance quoted at 0.50 USD per 100 USD CIF + 10% ( 50 USD Minimum ). Subject to commodity validation.",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-17",
"charge_rate": {
"calculation_method": "on_request",
"included_in_freight": false,
"optional": true
}
},
{
"charge_code": "OAES",
"rms_charge_identifier": "89640",
"description": "AES FILING",
"charge_total": {
"amount": 15,
"currency": "USD"
},
"comments": "Flat fee applicable contingent upon customer providing total value per HTS code.",
"routing_leg_identifier": "2",
"valid_start_date": "2024-01-17",
"charge_rate": {
"calculation_method": "per",
"included_in_freight": false,
"optional": false,
"unit_of_measure": "bill_of_lading",
"unit_cost": 15
}
},
{
"charge_code": "FRT",
"rms_charge_identifier": "565192461",
"description": "Freight",
"charge_total": {
"amount": 196.12,
"currency": "USD"
},
"valid_start_date": "2024-02-07",
"valid_end_date": "2024-02-29",
"routing_leg_identifier": "2",
"charge_rate": {
"calculation_method": "chargeable_weight",
"unit_of_measure": "kilogram",
"unit_cost": 0.85,
"total_quantity": 230.7347826825656
},
"sell_charge_identifier": "7401a2ab-288f-4957-9dbd-9b1b96f3842f"
},
{
"charge_code": "DTHC",
"rms_charge_identifier": "55477",
"description": "TERMINAL HANDLING DESTINATION",
"charge_total": {
"amount": 18.46,
"currency": "EUR"
},
"valid_start_date": "2023-02-23",
"routing_leg_identifier": "3",
"charge_rate": {
"calculation_method": "chargeable_weight",
"unit_of_measure": "kilogram",
"unit_cost": 0.08,
"total_quantity": 230.7347826825656
}
},
{
"charge_code": "DHAN",
"rms_charge_identifier": "55369",
"description": "HANDLING DESTINATION",
"charge_total": {
"amount": 25,
"currency": "EUR"
},
"valid_start_date": "2023-02-23",
"routing_leg_identifier": "3",
"charge_rate": {
"calculation_method": "per",
"unit_of_measure": "bill_of_lading",
"unit_cost": 25,
"total_quantity": 1
}
},
{
"charge_code": "DENS",
"rms_charge_identifier": "55469",
"description": "ENS FEE DESTINATION",
"charge_total": {
"amount": 10,
"currency": "EUR"
},
"comments": "ICS FEE",
"valid_start_date": "2023-02-23",
"routing_leg_identifier": "3",
"charge_rate": {
"calculation_method": "per",
"unit_of_measure": "bill_of_lading",
"unit_cost": 10,
"total_quantity": 1
}
},
{
"charge_code": "DSEC",
"rms_charge_identifier": "55469",
"description": "SECURITY FEE DESTINATION",
"charge_total": {
"amount": 15,
"currency": "EUR"
},
"comments": "For retroactive changes or amendments of ENS Date after transmission (ICS Fee)",
"valid_start_date": "2023-02-23",
"routing_leg_identifier": "3",
"charge_rate": {
"calculation_method": "per",
"unit_of_measure": "bill_of_lading",
"unit_cost": 15,
"total_quantity": 1
}
},
{
"charge_code": "DCMP",
"rms_charge_identifier": "55333",
"description": "COMPLIANCE FEE DESTINATION",
"charge_total": {
"amount": 12.5,
"currency": "EUR"
},
"valid_start_date": "2023-02-23",
"routing_leg_identifier": "3",
"charge_rate": {
"calculation_method": "per",
"unit_of_measure": "bill_of_lading",
"unit_cost": 12.5,
"total_quantity": 1
}
},
{
"charge_code": "DHAND",
"rms_charge_identifier": "55353",
"description": "HANDOVER FEE DESTINATION",
"charge_total": {
"amount": 40,
"currency": "EUR"
},
"comments": "Assignment Fee: if customs clearance is not handled by forwarder",
"valid_start_date": "2023-02-23",
"routing_leg_identifier": "3",
"charge_rate": {
"calculation_method": "per",
"unit_of_measure": "bill_of_lading",
"unit_cost": 40,
"total_quantity": 1,
"optional": true
}
},
{
"charge_code": "DAHAN",
"rms_charge_identifier": "55313",
"description": "AIRLINE HANDLING DESTINATION",
"charge_total": {
"amount": 15,
"currency": "EUR"
},
"comments": "Airline Release Fee - Max 150 € per AWB",
"valid_start_date": "2023-02-23",
"routing_leg_identifier": "3",
"charge_rate": {
"calculation_method": "chargeable_weight",
"min_max": "minimum",
"unit_of_measure": "kilogram",
"unit_cost": 0.05,
"total_quantity": 230.7347826825656
}
},
{
"charge_code": "DDEL",
"rms_charge_identifier": "81841",
"description": "DELIVERY",
"charge_total": {
"amount": 55,
"currency": "EUR"
},
"valid_start_date": "2023-02-01",
"routing_leg_identifier": "4",
"charge_rate": {
"calculation_method": "chargeable_weight",
"min_max": "minimum",
"unit_of_measure": "kilogram",
"unit_cost": 0.12,
"total_quantity": 230.7347826825656
}
}
]
}
]
}
Updated 9 months ago