RateSearchItem

True when an end is not one known port, so surcharges cannot be priced: rates is ocean freight only, in the contract's currency. Such rates are listed after the priced ones.

The shipping line. Null when an agent's rate sheet names none; carrierStatus is then unknown.

"unknown" when the rate names no carrier, otherwise null.

What the rate is for. FAK (freight all kinds) is the general rate.

ISO currency code of rates.

Destination port UN/LOCODE. Null if the contract names no single port; see destinationCandidates.

When the destination is ambiguous: the UN/LOCODEs it may be.

The destination as a readable place name.

The destination was searched as a door address.

For a destination door search: the trucking leg from the port to the door, by container size. Null when the search was not to a door.

How the searched destination matched; see originMatch.

Destination via point (transshipment port), if any.

First day the rate is valid, MM/DD/YYYY.

The equipment type's id. Its name is the container_type_raw to pass to GET /rate-groups/{rate_group_id}/surcharges for this row's charges.

Last day the rate is valid, MM/DD/YYYY.

The rate group (a set of contract lines priced together). Pass it to GET /rate-groups/{rate_group_id}/surcharges for the charge breakdown, and in selectedRows to export this row.

The inland leg this row starts with, when it is made up of a leg and the same contract's rate from that leg's port. Its rates are already included in this row's rates.

The rate's line in the contract.

Origin port UN/LOCODE. Null if the contract names no single port; see originCandidates.

When the origin is ambiguous: the UN/LOCODEs it may be.

The origin as a readable place name.

The origin was searched as a door address.

For an origin door search: the trucking leg from the door to the port, by container size (the keys of rates). Null when the search was not from a door; {} or a missing size when no trucking lane covers it.

How the searched origin matched: exact (the rate's own port), alternative (one of the ports the rate covers) or ambiguous (the rate names no single port; originCandidates lists the possibilities).

Origin via point (transshipment port), if any.

False when a required charge is missing from rates; true when none is; null when the contract names no required charges.

Why the rate is not fully priced, when it is not.

All-in price per container, in USD, by size (20', 40', 40' HC, 45', 48', 53'): ocean freight plus current surcharges and per-shipment charges. Null for a size this rate does not price. For a baseFreightOnly rate, the ocean freight alone, in currency.

Notes on the rate as written in the contract. Never priced.

Where the carrier takes and hands over the container: CY/CY (port to port), CY/DOOR, DOOR/CY or DOOR/DOOR.

Equipment type: Dry, Reefer (refrigerated), Tank, HAZ and so on.

By container size: charges the contract requires that rates leaves out, with the reason.