Attributes

asked_origin

array origin that was requested.

Child attributes

location string
Name of the requested origin as it appears in the Xeneta database
name string
Actual name of the requested origin
type string
Location type of the requested origin
allow_aggregation boolean
Indicates whether rate aggregation on a larger geographic region is available for the requested origin
geo_level integer
Geo-hierarchy level of the requested origin

asked_destination

array destination that was requested.

Child attributes

location string
Name of the requested destination as it appears in the Xeneta database
name string
Actual name of the requested destination
type string
Location type of the requested destination
allow_aggregation boolean
Indicates whether rate aggregation on a larger geographic region is available for the requested destination
geo_level integer
Geo-hierarchy level of the requested destination

actual_origin

array origin that was returned instead of the requested origin due to insufficient data. actual_origin will be identical to asked_origin if there is enough data.

Child attributes

location string
Name of the returned origin as it appears in the Xeneta database
name string
Actual name of the returned origin
type string
Location type of the returned origin
allow_aggregation boolean
Indicates whether rate aggregation on a larger geographic region is available for the requested origin
geo_level integer
Geo-hierarchy level of the returned origin

actual_destination

array destination that was returned instead of the requested destination due to insufficient data. actual_destination will be identical to asked_destination if there is enough data.

Child attributes

location string
Name of the returned destination as it appears in the Xeneta database
name string
Actual name of the returned destination
type string
Location type of the returned destination
allow_aggregation boolean
Indicates whether rate aggregation on a larger geographic region is available for the requested destination
geo_level integer
Geo-hierarchy level of the returned destination

Body

{
  "meta": {
    "asked_origin": {
      "location": "CNSGH",
      "name": "Shanghai",
      "type": "Port",
      "allow_aggregation": true,
      "geo_level": 6
    },
    "asked_destination": {
      "location": "NLRTM",
      "name": "Rotterdam",
      "type": "Port",
      "allow_aggregation": true,
      "geo_level": 4
    },
    "actual_origin": {
      "location": "asia",
      "name": "Asia",
      "type": "Region",
      "allow_aggregation": false,
      "geo_level": 1
    },
    "actual_destination": {
      "location": "northern_europe",
      "name": "Northern Europe",
      "type": "Region",
      "allow_aggregation": false,
      "geo_level": 2
    }
  }
}