Skip to content

Model: Locations

The Locations data presents the detailed information about a location as origin or destination. This data is retrieved by calling the Location endpoints (see Endpoints: Product Offers).

Data representation

Each product has a set of general attributes as shown below in an example of data representation. The request made for obtaining this data is:

.../offers/v2/offers/brand/MAEU/locations?originRkstCode=ESBCN&productCode=MaerskSpot&destinationRkstCode=CNDAI

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
[
    {
        "brandScac": "maeu",
        "fullTradeSwitch": false,
        "origin": {
            "geoId": "1FQMCYMU9XLZ2",
            "rkstCode": "ESBCN",
            "unLocCode": "ESBCN",
            "cityName": "Barcelona",
            "countryName": "Spain"
        },
        "destination": {
            "geoId": "0G5RI2I2X2U8P",
            "rkstCode": "CNDAI",
            "unLocCode": "CNDAL",
            "cityName": "Dalian",
            "regionName": "Liaoning",
            "countryName": "China"
        },
        "containers": [
            ...
        ]
    }
]

Data description

An offer has the following attributes:

  • brandScac : The SCAC code of the carrier for which the offer is available, eg. maeu for MaerskLine.

  • fullTradeSwitch : If the value is set to true, then the origin -> destination route has the full trade switch enabled. For a full trade switch enabled route, the SPOT products are the only option in the booking process for short term contract agreements.

  • origin : The data about the requested origin:

    • geoId : The geo ID for the requested origin. The ID is used internally in Maersk network betweek systems

    • rkstCode : The RKST code for the requested origin. The code is used internally in Maersk network

    • regionName : The region name where the requested origin is placed. The value might be null, as some countries do not have regions.

    • unLocCode : The United Nations Code for Trade and Transport Locations (UN/LOCODE) for the requested origin

  • destination : The data about the requested destination:

    • geoId : The geo ID for the requested destination. The ID is used internally in Maersk network betweek systems

    • rkstCode : The RKST code for the requested destination. The code is used internally in Maersk network

    • regionName : The region name where the requested destination is placed. The value might be null, as some countries do not have regions.

    • unLocCode : The United Nations Code for Trade and Transport Locations (UN/LOCODE) for the requested destination

  • containers : The containers data, see Model: Container Size and Types