The meta object

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

default_thc_methodology

array Reference information on the terminal handling charges. othc_applicable and dthc_applicable indicate if THCs are applied at the origin and destination respectively.

Child attributes
  • thc_class string
    Default THC methodology for the requested origin and destination pair
  • dthc_applicable boolean
    Indicates whether THCs are applied at destination
  • othc_applicable boolean
    Indicates whether THCs are applied at origin

carrier

array Carrier whose rates were requested.

Child attributes
  • name string
    Carrier name
  • slug string
    Carrier name as it appears in the Xeneta database

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": "china_main",
      "name": "China Main",
      "type": "Region",
      "allow_aggregation": true,
      "geo_level": 4
    },
    "actual_destination": {
      "location": "north_europe_main",
      "name": "North Europe Main",
      "type": "Region",
      "allow_aggregation": true,
      "geo_level": 3
    },
    "default_thc_methodology": {
      "thc_class": "none",
      "dthc_applicable": true,
      "othc_applicable": true
    },
    "carrier": {
      "name": "CMA CGM",
      "slug": "cma_cgm"
    }
  }
}
Xeneta Footer - Fixed