Get carrier rates

get

https://api.xeneta.com/v3.0/ocean/carrier-spread

Returns freight rates for the requested carrier.

Query Params

origin

string

required

Defaults to CNSGH

Defines the origin location of the requested carrier rate data. Can be either a UN/LOCODE or a region as defined in Xeneta's geo-hierarchy. For example, CNSGH or china_east_main.

destination

string

required

Defaults to NLRTM

Defines the destination location of the requested carrier rate data. Can be either a UN/LOCODE or a region as defined in Xeneta's geo-hierarchy. For example, NLRTM or north_europe_main.

date_from

date

required

Defaults to 2023-02-01

Defines the start date of the date range for the requested carrier rates in the YYYY-MM-DD format. The total range cannot exceed 31 days.

date_to

date

required

Defaults to 2023-02-03

Defines the end date of the date range for the requested carrier rates in the YYYY-MM-DD format. The total range cannot exceed 31 days.

carrier_slug

string

required

Defaults to cma_cgm

Defines the carrier whose rates to request.

contract_length

string

required

Defaults to short

Defines the type of contract for the requested carrier rate data. Accepted values are long or short.

contracted_within

string

required

Defaults to all

Defines the maximum age of the contracts to be included in the requested carrier rate data, relative to each day. Accepted values include all, 3months and 6months. Using any value other than all when contract_length is set to short will return an error.

container_type

string

required

Defaults to 40DC

Defines the container type of the requested carrier rate data. Accepted values include 20DC, 20RE, 20TK, 40DC, 40RH and 40HC.

thc_methodology

string

required

Defaults to meth

Defines whether the requested carrier rate data should include the terminal handling charge. Accepted values include meth, othc, dthc, none and both. Selecting meth will use Xeneta's default methodology for the requested origin and destination.

Response

200200