Send a request for rates for a single shipment from your TMS to your Rate Management System (RMS).
| Name | Description |
|---|---|
| Root | Chain.io schema for requesting rates applicable to a shipment from a Rate Management System. |
| Party | Represents a named party on a job. |
| PartyIdentifier | A code and context that can be used to uniquely identify a party. |
| Container | Container information used to calculate the shipping rates. |
| Package | Packaging information used to calculate the shipping rates. |
| Weight | |
| Volume | |
| Dimensions | |
| Operator | A user in the accounting system. |
| Value | |
| RoutingLeg | The overall origin to destination routing of the shipment. |
| RouteLocation | A single stop on the shipment's overall route. |
| Address | A location representing a street address. |
| Airport | A location representing an airport. |
| UnLocode | A location representing a UN location code. |
| CustomProperties | An object an input converter can utilize to pass any custom data back into a flow that can potentially be utilized by an output converter. |
| Name | Data Type | Description | Required |
|---|---|---|---|
tms_system_identifier | String | The 'primary key' uniquely identifying the shipment in the source TMS system. This value will be sent to the Rate Management System to be utilized as the identifier for the rate data when returning responses back to the TMS. | YES |
transport_mode | String | The primary means of transport of the goods on their journey. Allowed values: sea, air, road, rail, sea_air, air_sea, inland_waterway, rail_sea, rail_air. | YES |
movement_type | String | The type of shipment service requested on the rate request, defining the location types where the carrier will receive the goods and where the carrier will relinquish the goods. Allowed values: port_to_port, door_to_door, door_to_port, port_to_door. | |
containerization_type | String | The container load type required on the booking. Allowed values: fcl, lcl, ftl, ltl. | |
quote_number | String | If applicable, used to retrieve rates associated with a previously issued quote. | |
carrier_contract_number | String | The carrier contract number that should be used to source the rate information. | |
carrier | Party | The expected carrier that will be the primary party responsible for transporting the goods. | |
controlling_party | Party | The owning party of the rates. In a multi-tenant RMS, this party will be used to determine which RMS tenant to utilize to generate rates for this request. | |
customer | Party | The rate owner's customer the rates should be received for. | |
estimated_departure_date | String | The estimated departure date of the shipment. This date is the primary date used to determine validity of the rates. | YES |
carrier_service_level | String | The requested service level for this shipment. Different service levels generally affect the number of days / hours the shipment may take to be fulfilled. This is more often used in air freight and is typically a value like "Standard", "Express", "Premium", "Priority" or "Economy". | |
freight_payment_terms | String | The freight terms of payment indicating the party responsible for freight charges. Allowed values: collect, prepaid, third_party. | |
inco_terms | String | The terms of sale defining the responsibilities of the consignor/seller and consignee/buyer. Expired terms dat, daf, des, deq, ddu are included for backwards compatibility sake, though it is very highly recommended to no longer utilize them. Allowed values: exw, fca, fas, fob, cfr, cif, cpt, cip, dap, dpu, ddp, dat, daf, des, deq, ddu. | |
direction | String | The directionality of the shipment from the point of view of the controlling party in the TMS. Typically this information is only a factor in local pickup/delivery rates. foreign_to_foreign is also known as triangle, third-party or cross-trade shipments. Allowed values: import, export, domestic, foreign_to_foreign. | |
description_of_goods | String | A generalized description of the cargo. | |
gross_weight | Weight | The gross weight of the cargo. | |
volume | Volume | The total volume of the cargo. | |
environmental_pollutant | Boolean | True if the cargo is considered an environmental pollutant. | |
hazardous | Boolean | True if the cargo is considered hazardous or dangerous goods. | |
out_of_gauge_freight | Boolean | True if the cargo is considered out of gauge (OOG) and does not fit into standard shipping containers. | |
temperature_controlled | Boolean | True if the cargo must be transported using specific temperature settings. | |
stackable | Boolean | True if the goods packaging allows for it to be stacked. | |
secured | Boolean | True if the cargo will be stabilized and secured for transport. | |
operator | Operator | Information regarding the operator that is initiating the rate request. | |
carriage_value | Value | The total goods selling price or replacement cost. | |
customs_value | Value | The total goods value for customs declaration purposes. | |
company_code | String | The TMS's native code for identifying which internal company is requesting the rates. | |
department_code | String | The TMS's native code for identifying which internal department / division is requesting the rates. | |
branch_code | String | The TMS's native code for identifying which internal branch is requesting the rates. | |
containers | Array<Container> | The container information required to rate containerized shipments. | |
outer_packs | Array<Package> | The packaging information required to rate non-containerized shipments. | |
routing_legs | Array<RoutingLeg> | A breakdown of the important waypoints on the shipment's journey. Typically, this will simply be a single origin and destination - but may include additional stops like precarriage points or main leg vias. | YES |
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|---|---|---|
identifiers | Array<PartyIdentifier> | An array of all applicable identifiers that can be used to identify the party. | |
name | String | The entity's name. | |
address_1 | String | The address' street number and name. | |
address_2 | String | The address' secondary address information. | |
city | String | The address' city component. | |
country_subdivision | String | The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data. | |
country | String | The address' 2 character ISO-3166-2 country Code. | |
postal_code | String | The unique postal code identifier for the address. |
| Name | Data Type | Description | Required |
|---|---|---|---|
code | String | The identifier code | YES |
code_type | String | The type of data that the identifier code represents. The tms_external_identifier represents a code value that will uniquely identify the party to the sending TMS system without value translations. The rms_external_identifier represents a code value that will uniquely identify the party to the receiving rate management system (RMS) without value translations. Allowed values: tms_external_identifier, rms_external_identifier, iata, scac, legal_entity_id, duns. | YES |
code_country | String | The 2 character ISO-3166-2 country code that the id code was issued in / by. |
| Name | Data Type | Description | Required |
|---|---|---|---|
type_code | String | The ISO 6346 container type code or standard Unit Load Device (ULD) type code that is expected to be utilized on the shipment. | YES |
quantity | Integer | The number of containers of the requested type that should be rated. | YES |
gross_weight | Weight | The gross weight of the cargo in the container. | |
volume | Volume | The total volume of the cargo in the container. | |
outer_packs | Array<Package> | The packaging information for goods inside the container(s). |
| Name | Data Type | Description | Required |
|---|---|---|---|
dimensions | Dimensions | The dimensions of the packages. | |
gross_weight | Weight | The gross weight of the cargo in the container. | |
volume | Volume | The total volume of the cargo in the container. | |
nmfc_freight_class | String | The National Motor Freight commodity classification. | |
nmfc_code | String | The NMFC specific commodity code. | |
number_of_packages | Integer | The number of packages associated with this package type. | |
package_type_code | String | A packaging code describing the cargo. When possible, the 2 character UN/ECE Trade Facilitation Recommendation No. 21 package code should be utilized to enhance interoperability. | |
package_type_description | String | A free text description of the goods packaging. |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The numeric weight amount | YES |
unit | String | The unit of measure associated with the amount property. tonne = Metric Tonne (1,000 kilograms), ton = Imperial Tonne (1,000 pounds) Allowed values: kilogram, tonne, pound, ton. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The numeric volume amount | YES |
unit | String | The unit of measure associated with the amount property. gallon - US liquid gallon (3.785411784 litres), imperial_gallon = UK gallon (4.54609 litres) Allowed values: cubic_meter, cubic_foot, liter, gallon, imperial_gallon. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
unit | String | Allowed values: inch, foot, centimeter, meter. | YES |
length | Decimal | YES | |
width | Decimal | YES | |
height | Decimal | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
tms_system_identifier | String | The 'primary key' uniquely identifying the user in the TMS. Typically, this will be the operator's username. | YES |
name | String | The operator's full name. |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | Decimal | The value amount. | YES |
currency | String | The ISO 4217 currency code indicating the currency of the value. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
leg_type | String | The movement type represented by the routing leg. Allowed values: pre_carriage, main, on_carriage. | |
origin | RouteLocation | The originating point of the shipment. If the movement_type of the shipment begins as a port location, it is expected that the location should point to a UnLocode for sea modes and to an AirPort for air modes. Door movement types should be an Address. | YES |
destination | RouteLocation | The terminating point of the shipment. If the movement_type of the shipment ends as a port location, it is expected that the location should point to a UnLocode for sea modes and to an AirPort for air modes. Door movement types should be an Address. | YES |
custom_properties | CustomProperties |
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier. Allowed values: address. | YES |
name | String | A name for the address. Typically the name of the business located at the address. | |
address_1 | String | The address' street number and name. | |
address_2 | String | The address' secondary address information. | |
city | String | The address' city component. | YES |
country_subdivision | String | The country specific subdivision code. This could represent a county, province, state, etc. In order to maximize interoperability, you should utilize the ISO 3166-2 country subdivision identifiers when providing this data. | |
country | String | The address' 2 character ISO-3166-2 country Code. | YES |
postal_code | String | The unique postal code identifier for the address. | |
unlocode | String | A UN/Locode identifier correlated with the address. | |
unlocode_description | String | A free text description of the UN/Locode. |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier Allowed values: airport. | YES |
iata_code | String | The IATA airport location identifier. | YES |
iata_code_description | String | A free text description of the IATA Code. | |
unlocode | String | The UN/Locode identifier correlated with the IATA code. |
| Name | Data Type | Description | Required |
|---|---|---|---|
type | String | A location type identifier Allowed values: unlocode. | YES |
unlocode | String | The UN/Locode identifier for the sea port. | YES |
unlocode_description | String | A free text description of the UN/Locode. |
| Name | Data Type | Description | Required |
|---|