| Name | Description |
|---|---|
| Root | The top level document |
| Rate | The standard rates JSON schema used in communication from/to chain.io |
| Note | A textual message |
| RateSegment | A Rate Segment |
| Address | A physical location. |
| RateLine | A Rate Line |
| RateItem | A Rate Item |
| WeightBreak | A breakup of weight data |
| Name | Data Type | Description | Required |
|---|---|---|---|
doc_type | String | Always chainio_rate | |
rates | Array<Rate> | Array of Standard Rate objects | |
version | String | The version of the specification being used. |
| Name | Data Type | Description | Required |
|---|---|---|---|
commodity_type | String | A code for a type of goods being transported | |
company_code | String | The internal company account in the source system that owns the rate | |
containerization_type | String | The explanation of how the consolidation is containerized. Can be any of the following values: LSE (Loose Freight), FCL (Full Container), LCL (Less Than Container), FTL (Full Truckload), or LTL (Less Than Truckload). | |
contract_number | String | The contract number for the rate. | |
customer_number | String | The seller's ID for the customer. Do not populate for public / general rates. | |
destination_type | String | The type of destination service provided (CFS, Door, Port, etc) | |
freight_payment_terms | String | The payment terms for shipment. For example, Prepaid or Collect. This is different from the purchase_order document's inco_term and payment_term fields. | |
inco_terms | String | The type of payment method that the shipper will use to complete payment for the shipment or customs clearance. | |
notes | Array<Note> | optional notes that need to be added | |
origin_type | String | The type of origin service provided (CFS, Door, Port, etc) | |
payment_terms | String | The terms of payment. | |
quote_reference | String | The reference number for the quote associated with the shipment. | |
rate_name | String | Descriptive name of the rate | |
rate_segments | Array<RateSegment> | An array of rate segments | |
service_level | String | The level of service provided by the consolidation's mode of transportation. | |
source_system_id | String | Record identifier in the system that hosts the master copy of this record. | |
transport_mode | String | The mode of transportation for the Main rate segment. Recommended values: AIR, SEA, TRUCK, RAIL | |
type_code | String | Rate type code of the rates. Eg: MKT, PRO, CTR, BUY, CXX. | |
valid_end | DateTime | This rate is valid before this moment. | |
valid_start | DateTime | This rate is valid at or after this moment. |
| Name | Data Type | Description | Required |
|---|---|---|---|
carrier_code | String | The SCAC code for the carrier performing the movement for this segment | |
carrier_name | String | The name of the carrier responsible for the physical movement of the goods. | |
destination | Address | The address of the port of destination | |
destination_via | Address | the address of the ports through with the shipment travels | |
maximum_transit_time | Decimal | The maximum number of hours the shipment will take | |
minimum_transit_time | Decimal | The minimum number of hours the shipment will take | |
origin | Address | The address of the port of origin | |
origin_via | Address | the address of the ports through with the shipment travels | |
rate_lines | Array<RateLine> | Array of rate lines | |
segment_name | String | Descriptive name of the segment. USLAX-->USCHI | |
segment_type | String | The type of segment: One of Precarriage, Main, Oncarriage | |
transit_time_uom | String | Transit time unit of measure, example Days | |
transport_mode | String | The mode of transportation for the shipment. This is the TMS system's code, not the customs authorities code | |
valid_end | DateTime | This rate is valid before this moment. | |
valid_start | DateTime | This rate is valid at or after this moment. |
| Name | Data Type | Description | Required |
|---|---|---|---|
address_1 | String | The first line of the address. | |
address_2 | String | The second line of the address. | |
address_type | String | The type of address represented by this element. Specific types may be defined on a per specification basis | |
city | String | The city. | |
country | String | The 2-Digit ISO 3166 Alpha-2 Country Code. Like 'US' | |
country_name | String | The full name of the country like “United States” | |
iata_code | String | The International Air Transport location identifier is a unique 3 letter code used in aviation and also in logistics to identify an airport | |
name | String | The name associated with the address. | |
postal_code | String | The postal or ZIP code. | |
state | String | The state, province, or administrative division code | |
unlocode | String | The UN/LOCODE associated with the address. Like 'USCHI' |
| Name | Data Type | Description | Required |
|---|---|---|---|
buy_rate | RateItem | The amount for each increment in the rate calculation. If the rate is "$1 / 1000 KG" then this value is 1. If the rate is "10% per MainLeg" then this value is 10 | |
conversion_factor_denominator | String | The denominator unit of measure when perfoming volumetric conversions | |
conversion_factor_numerator | String | The numerator unit of measure when performing volumetric conversions. | |
conversion_factor_value | Decimal | A volumetric conversion factor for a charge line. | |
equipment_type | String | The type of equipment for which this rate applies. If null, apply the line for all equipment types. | |
notes | Array<Note> | Notes about rate line | |
optional | String | Whether rate is optional. When associated with rate quotes, an optional rate typically outlines amounts for services that are available but not required as part of the freight movement (such as Storage fees). Optional lines should not affect invoicing totals for quotes. | |
rate_group_code | String | How this rate should be grouped when presented to the customer like ORIGIN, DESTINATION, FREIGHT, etc. | |
sell_rate | RateItem | The amount for each increment in the rate calculation. If the rate is "$1 / 1000 KG" then this value is 1. If the rate is "10% per MainLeg" then this value is 10 | |
valid_from | DateTime | This rate is valid at or after this moment. | |
valid_until | DateTime | This rate is valid before this moment. |
| Name | Data Type | Description | Required |
|---|---|---|---|
base_amount | Decimal | When sending information regarding a compound rate, this represents the base amount of the rate. For example, in a rate representing $1000 + $100/per container the base amount is 100. | |
calculation_type | String | The type of calculation to use to determine the buy amount for this rate like FLAT, PERKG, or any other value supported by the rate management system. | |
charge_code | String | The charge code that will be used on the invoices | |
charge_description | String | The charge description that should be displayed | |
conditional_type | String | An optional filter code to indicate to the rating engine whether a chargecode is applicable or not. An example use case may be sending a code of 'BRK' to indicate to the rating engine to only include the charge if the forwarder is responsible for import / export clearances. | |
currency | String | The 3-character ISO 4217 currency code in which the rate is displayed | |
drop_mode | String | The drop mode for the rate, if applicable to this calculation method. This is only applicable on sell rates, it will be ignored on buy rates. | |
geographic_zone_code | String | A code uniquely identifying the geographic zone that the rate will be applicable to. The rating engine should then only utilize this rate when the shipment aligns with this zone. | |
markup_base | Float | A set amount value, based on cost, used to markup a sell rate. | |
markup_percentage | Float | A percentage value based on cost used to markup a sell rate. | |
markup_sell_calculation_order | String | A set value indicator for calculation order when both percentage and base unit markups are present. This indicator is used to determine which markups are calculated first, percentage or base. | |
markup_sell_minimum | Float | A minimum set amount value based on cost used to markup a sell rate. | |
markup_sell_unit_price | Float | A set amount value based on cost per unit on measure that is used to markup a sell rate. | |
markup_unit_percentage | Float | A percentage value based on cost per unit that used to markup a sell rate. | |
maximum_amount | Decimal | The maximum amout that is/can be charged | |
minimum_amount | Decimal | The minium amout that is/can be charged | |
unit_amount | Decimal | The amount for each increment in the rate calculation. If the rate is "$1/1000 KG" then this value is 1. If the rate is "10% per MainLeg" then this value is 10 | |
unit_of_measure | String | The unit of measure used to calculate the rate line | |
units_per_increment | Decimal | The number of units for each increment in the rate calculation. If the rate is "$1 / 1000 KG" then this value is 1000. | |
volumetric_factor | Decimal | The volume component of the dimensional weight calculation ratio | |
weight_breaks | Array<WeightBreak> | The breakup of weights | |
weight_measure_indicator | String | Indicates to the rating engine the type of weight measure calculation to execute for this rate. An example might be sending a value of 'actual' to indicate to the rating engine to use the actual weight instead of the chargeable weight. |
| Name | Data Type | Description | Required |
|---|---|---|---|
amount | String | The amount to apply in the calculation if this is the appropriate rate break | |
greater_than_or_equal_to | String | weight should be greater than or equal to | |
less_than | String | weight should be less than or equal to |