Skip to content

Endpoints: Product Offers

The Product Offers group of endpoints are concerned about which products are available on which combinations of origins, destinations and container size and types. The Product Offers group of endpoints also include an endpoint to get the combined information for available product offers for a certain combination origin, destination, container size and type. This combined information should include all the information relevant for a display of the offer to a customer, like which Product the offer is for, the route and schedule information for the offer, including relevant vessel departures and deadlines information for these, and also includes price information for the offer.

List available offers

Path URI

.../offers/v2/offers/brand/{brandScac}/departuredate/{departureDate}

Path parameters

  • brandScac (required): The SCAC code for the carrier for which to query for available offers, eg. maeu for MaerskLine.
  • departureDate (required): The earliest departure date for offers. No offers will be included in the response with departure data before this date. The date is in ISO 8601 Date format (YYYY-MM-DD), eg. April 30th, 2018 would be 2018-04-30.

Query parameters

  • productCode (optional): Obsolete and has no effect now.
  • originServiceMode (optional): The service mode of the origin. The allowed values are CY for Merchant Haulage when the customer arranges own transportation to move the cargo from the container yard and SD for Carrier Haulage where the cargo transport between the container yard and the specified address is done by Maersk. If no service type is specified, it defaults to CY.
  • destinationServiceMode (optional): The service mode of the destination. The allowed values are CY for Merchant Haulage when the customer arranges own transportation to move the cargo to the container yard and SD for Carrier Haulage where the cargo transport between the container yard and the specified address is done by Maersk.. If no service type is specified, it defaults to CY.

  • containers (required): The container amounts, sizes, types and requested weight (in Metric Tons) to restrict available offers returned to only those for which the containers are available and there is enough mtons capacity. The format is <amount>x<size><type>x<mton>, eg. 2x20DRYx10 to list offers for 2 containers of type 20 feet DRY, each of them with a weight of 10 mtons. Specify parameter containers multiple times to request more than one container size-type in each request. The <mtons> parameter is optional. If no mtons is specified, it defaults to 10 mtons.
    When specifying more than one container-size-type in a request, the returned offers support all those multiple containers, therefore, if there are no offers for at least one container-size-type, there will be no offers returned for that request.

  • includeOfferFilteredReasons (optional): A boolean value indicating if the response should contain the reasons for filtering away offers. The parameter value can be true or false.

  • One required origin parameter which can be...

    • originUnLocCode (optional): The UN/LOCODE for the origin locations (eg. CNDAL) to restrict available offers locations returned to only those that match the specified id.
    • originRkstCode (optional): The Maersk RKST code for the origin locations (eg. CNDAI) to restrict available offers locations returned to only those that match the specified id.
    • originGeoId (optional): The Maersk GeoId for the origin locations (eg. 0G5RI2I2X2U8P) to restrict available offers locations returned to only those that match the specified id.

    NOTE: The recommandation is to use RKST code. In order to get the RKST code of a location, please use the following developer portal: https://developer.maersk.com/

  • One required destination parameter which can be...

    • destinationUnLocCode (optional): The UN/LOCODE for the destination locations (eg. ESBCN) to restrict available offers locations returned to only those that match the specified id.
    • destinationRkstCode (optional): The Maersk RKST code for the destination locations (eg. ESBCN) to restrict available offers locations returned to only those that match the specified id.
    • destinationGeoId (optional): The Maersk GeoId for the destination locations (eg. 1FQMCYMU9XLZ2) to restrict available offers locations returned to only those that match the specified id.

    NOTE: The recommandation is to use RKST code. In order to get the RKST code of a location, please use the following developer portal: https://developer.maersk.com/

The originPrefix and destinationPrefix query parameters is not allowed for this endpoint. You will need to specify one of the three identifier options, however be aware that some locations does not actually have an UN/LOCODE identifier.

Allowed consumers

Category of API consumer Access control Authentication needed
Maersk controlled sites Allowed ForgeRock JWT
Direct customers integrations Allowed Consumer key
3rd party platforms Allowed Consumer key

Response data

The endpoint response will contain a json array of json objects for each valid offers. The offer should contain all relevant information for the offer including, route and schedule details, vessel and deadline information and prices inluding surcharges for the requested origin, destination, container size-types combination. For details about the response see Model: Product Offers.

Be aware that the Maersk Spot Products will be subject to dynamic pricing, and the offers come with no guaranty about the validity time for the prices. So in the consumption of the Offers API, be sure to only store the data for the session. Also the Offers API should only be queried on actual user request, so do not setup a schedule to refresh offer prices.

Offers for routes going out of or into countries or territories under US legislation may be under Federal Maritime Commission (FMC) regulation. FMC regulation requires special handling for Spot offers and will only be possible to book on our own websites. If the spot offer is under FMC regulation the spot offer json will contain a property fmcRegulationApplies which will have a true value. This can be used by the consumer to understand if the offer requires FMC handling.

Example query

Query: .../offers/v2/offers/brand/maeu/departuredate/2020-03-23?originServiceMode=CY&destinationServiceMode=CY&containers=1x40DRYx2&originRkstCode=SGSIN&destinationRkstCode=NLROT

Response:

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
{
    "offers": [
        {
            "productOffer": {
                "offerId": 247296,
                "productCode": "MaerskSpot",
                "productName": "Maersk Spot",
                "productVersion": 1,
                "gcssProductId": 2,
                "gcssProductIdWithVR": 5,
                "brandScac": "maeu",
                "routeCode": "E1W",
                "originRkstCode": "SGSIN",
                "originGeoId": "0XOP5ISJZK0HR",
                "originDisplayName": "Singapore, Singapore",
                "originCityName": "Singapore",
                "originCountryName": "Singapore",
                "originRegionName": null,
                "originUnLocCode": "SGSIN",
                "destinationRkstCode": "NLROT",
                "destinationGeoId": "1JUKNJGWHQBNJ",
                "destinationDisplayName": "Rotterdam, Netherlands",
                "destinationCityName": "Rotterdam",
                "destinationCountryName": "Netherlands",
                "destinationRegionName": "Zuid-Holland",
                "destinationUnLocCode": "NLRTM",
                "originServiceMode": "CY",
                "destinationServiceMode": "CY",
                "validFromDate": "2020-03-22",
                "validToDate": null,
                "deepLink": "https://maersk.com/book",
                "containers": [
                    {
                        "size": "40",
                        "height": "8 6",
                        "type": "DRY",
                        "iso": "42G1",
                        "name": "40DRY",
                        "label": "40' Dry Standard",
                        "mtonPrCntr": 10.000,
                        "cargoType": "DRY",
                        "reefer": false
                    }
                ]
            },
            "routeSchedulesWithPrices": [
                {
                    "routeScheduleFull": {
                        "brandScac": "maeu",
                        "routeCode": "E1",
                        "direction": "W",
                        "productId": "3066556039",
                        "productSequence": "1",
                        "fromLocation": {
                            "type": "TERMINAL",
                            "siteGeoId": "1USOJ5O7R938O",
                            "cityGeoId": "0XOP5ISJZK0HR",
                            "rkstCode": "SGSINPS",
                            "unLocCode": "SGSIN",
                            "siteName": "PSA Singapore Terminal",
                            "cityName": "Singapore",
                            "countryCode": "SG",
                            "countryName": "Singapore",
                            "date": "2020-03-28",
                            "time": "22:00:00"
                        },
                        "toLocation": {
                            "type": "TERMINAL",
                            "siteGeoId": "HHMT8D8RO96BR",
                            "cityGeoId": "1JUKNJGWHQBNJ",
                            "rkstCode": "NLROTTM",
                            "unLocCode": "NLRTM",
                            "siteName": "APM 2 Terminal Maasvlakte II",
                            "cityName": "Rotterdam",
                            "regionName": "Zuid-Holland",
                            "countryCode": "NL",
                            "countryName": "Netherlands",
                            "date": "2020-04-24",
                            "time": "07:00:00"
                        },
                        "firstLoadPort": {
                            "type": "TERMINAL",
                            "siteGeoId": "1USOJ5O7R938O",
                            "cityGeoId": "0XOP5ISJZK0HR",
                            "rkstCode": "SGSINPS",
                            "unLocCode": "SGSIN",
                            "siteName": "PSA Singapore Terminal",
                            "cityName": "Singapore",
                            "countryCode": "SG",
                            "countryName": "Singapore",
                            "date": "2020-03-28",
                            "time": "22:00:00"
                        },
                        "lastDischargePort": {
                            "type": "TERMINAL",
                            "siteGeoId": "HHMT8D8RO96BR",
                            "cityGeoId": "1JUKNJGWHQBNJ",
                            "rkstCode": "NLROTTM",
                            "unLocCode": "NLRTM",
                            "siteName": "APM 2 Terminal Maasvlakte II",
                            "cityName": "Rotterdam",
                            "regionName": "Zuid-Holland",
                            "countryCode": "NL",
                            "countryName": "Netherlands",
                            "date": "2020-04-24",
                            "time": "07:00:00"
                        },
                        "hasInlandExport": false,
                        "hasInlandImport": false,
                        "vessel": {
                            "code": "H5X",
                            "name": "MELINA",
                            "longName": "MELINA",
                            "flagCode": "MH",
                            "flagName": "Marshall Islands",
                            "imoNumber": "9401075",
                            "buildYear": "2009",
                            "callSign": "V7DE9",
                            "capacityTEU": 4253,
                            "vesselClass": "DNV-GL 100 A5"
                        },
                        "voyageNumber": "013W",
                        "transitTime": "37980",
                        "fmcRegulationApplies": false,
                        "scheduleDetails": [
                            {
                                "deadlines": [
                                    {
                                        "deadlineKey": "CY",
                                        "name": "Commercial Cargo Cutoff",
                                        "type": "Documentation",
                                        "deadline": "2020-03-27 20:00:00"
                                    },
                                    {
                                        "deadlineKey": "SINONAMS",
                                        "name": "Shipping Instructions Deadline",
                                        "type": "Documentation",
                                        "deadline": "2020-03-26 14:00:00"
                                    },
                                    {
                                        "deadlineKey": "VGM",
                                        "name": "Commercial Verified Gross Mass Deadline",
                                        "type": "Documentation",
                                        "deadline": "2020-03-28 06:00:00"
                                    },
                                    {
                                        "deadlineKey": "LCD",
                                        "name": "Loadlist Closure Deadline",
                                        "type": "Marine Services",
                                        "deadline": "2020-03-26 18:00:00"
                                    },
                                    {
                                        "deadlineKey": "CSPD",
                                        "name": "Coprar to Stowage Planners Deadline",
                                        "type": "Marine Services",
                                        "deadline": "2020-03-27 04:00:00"
                                    },
                                    {
                                        "deadlineKey": "FLD",
                                        "name": "Final Loadlist Deadline",
                                        "type": "Marine Services",
                                        "deadline": "2020-03-27 14:00:00"
                                    }
                                ],
                                "fromLocation": {
                                    "type": "TERMINAL",
                                    "siteGeoId": "1USOJ5O7R938O",
                                    "cityGeoId": "0XOP5ISJZK0HR",
                                    "rkstCode": "SGSINPS",
                                    "unLocCode": "SGSIN",
                                    "siteName": "PSA Singapore Terminal",
                                    "cityName": "Singapore",
                                    "countryCode": "SG",
                                    "countryName": "Singapore",
                                    "date": "2020-03-28",
                                    "time": "22:00:00"
                                },
                                "toLocation": {
                                    "type": "TERMINAL",
                                    "siteGeoId": "00YSAZHW6VRIK",
                                    "cityGeoId": "2DTLIHUG9YN7S",
                                    "rkstCode": "MYTPPTM",
                                    "unLocCode": "MYTPP",
                                    "siteName": "Pelabuhan Tanjung Pelepas Terminal",
                                    "cityName": "Tanjung Pelepas",
                                    "regionName": "Johor",
                                    "countryCode": "MY",
                                    "countryName": "Malaysia",
                                    "date": "2020-03-30",
                                    "time": "02:00:00"
                                },
                                "transport": {
                                    "transportMode": "MVS",
                                    "vessel": {
                                        "code": "H5X",
                                        "name": "MELINA",
                                        "longName": "MELINA",
                                        "flagCode": "MH",
                                        "flagName": "Marshall Islands",
                                        "imoNumber": "9401075",
                                        "buildYear": "2009",
                                        "callSign": "V7DE9",
                                        "capacityTEU": 4253,
                                        "vesselClass": "DNV-GL 100 A5"
                                    },
                                    "tradeLane": "FEA/EUR",
                                    "voyageNumber": "013W"
                                },
                                "serviceCode": "310",
                                "serviceName": "CHENNAI Express",
                                "carrierCode": "F3310M",
                                "routingType": "E"
                            },
                            {
                                "deadlines": [
                                    {
                                        "deadlineKey": "CY",
                                        "name": "Commercial Cargo Cutoff",
                                        "type": "Documentation",
                                        "deadline": "2020-04-02 13:00:00"
                                    },
                                    {
                                        "deadlineKey": "SINONAMS",
                                        "name": "Shipping Instructions Deadline",
                                        "type": "Documentation",
                                        "deadline": "2020-04-02 13:00:00"
                                    },
                                    {
                                        "deadlineKey": "SIAMS",
                                        "name": "Shipping Instructions Deadline for Advance Manifest Cargo",
                                        "type": "Documentation",
                                        "deadline": "2020-04-01 05:00:00"
                                    },
                                    {
                                        "deadlineKey": "VGM",
                                        "name": "Commercial Verified Gross Mass Deadline",
                                        "type": "Documentation",
                                        "deadline": "2020-04-02 09:00:00"
                                    },
                                    {
                                        "deadlineKey": "LCD",
                                        "name": "Loadlist Closure Deadline",
                                        "type": "Marine Services",
                                        "deadline": "2020-03-31 20:00:00"
                                    },
                                    {
                                        "deadlineKey": "CSPD",
                                        "name": "Coprar to Stowage Planners Deadline",
                                        "type": "Marine Services",
                                        "deadline": "2020-03-31 21:00:00"
                                    },
                                    {
                                        "deadlineKey": "FLD",
                                        "name": "Final Loadlist Deadline",
                                        "type": "Marine Services",
                                        "deadline": "2020-04-01 23:00:00"
                                    },
                                    {
                                        "deadlineKey": "SCDD",
                                        "name": "Special Cargo Documentation Deadline",
                                        "type": "Marine Services",
                                        "deadline": "2020-03-31 19:00:00"
                                    }
                                ],
                                "fromLocation": {
                                    "type": "TERMINAL",
                                    "siteGeoId": "00YSAZHW6VRIK",
                                    "cityGeoId": "2DTLIHUG9YN7S",
                                    "rkstCode": "MYTPPTM",
                                    "unLocCode": "MYTPP",
                                    "siteName": "Pelabuhan Tanjung Pelepas Terminal",
                                    "cityName": "Tanjung Pelepas",
                                    "regionName": "Johor",
                                    "countryCode": "MY",
                                    "countryName": "Malaysia",
                                    "date": "2020-04-04",
                                    "time": "12:00:00"
                                },
                                "toLocation": {
                                    "type": "TERMINAL",
                                    "siteGeoId": "HHMT8D8RO96BR",
                                    "cityGeoId": "1JUKNJGWHQBNJ",
                                    "rkstCode": "NLROTTM",
                                    "unLocCode": "NLRTM",
                                    "siteName": "APM 2 Terminal Maasvlakte II",
                                    "cityName": "Rotterdam",
                                    "regionName": "Zuid-Holland",
                                    "countryCode": "NL",
                                    "countryName": "Netherlands",
                                    "date": "2020-04-24",
                                    "time": "07:00:00"
                                },
                                "transport": {
                                    "transportMode": "MVS",
                                    "vessel": {
                                        "code": "C5N",
                                        "name": "MSC MIRJA",
                                        "longName": "MSC MIRJA",
                                        "flagCode": "LR",
                                        "flagName": "Liberia",
                                        "imoNumber": "9762338",
                                        "buildYear": "2007",
                                        "callSign": "D5LI6",
                                        "capacityTEU": 19600,
                                        "vesselClass": "DNV-GL"
                                    },
                                    "tradeLane": "FEA/EUR",
                                    "voyageNumber": "012W"
                                },
                                "serviceCode": "431",
                                "serviceName": "AE5",
                                "carrierCode": "E1431M",
                                "routingType": "M"
                            }
                        ]
                    },
                    "importDnDConditions": [
                        {
                            "direction": "Import",
                            "chargeType": "Demurrage",
                            "containerSizeType": "40DRY",
                            "commodity": "GENERAL CARGO",
                            "freetimeStartEvent": "DISCHARGE",
                            "freetimeGrantInDays": 7,
                            "rkstCode": "NLROT",
                            "chargePerDiemAfterFreetime": [
                                {
                                    "startDayOfCharge": 8,
                                    "endDayOfCharge": null,
                                    "chargePerDiem": 130,
                                    "currencyOfCharge": "EUR"
                                }
                            ],
                            "displayName": "Import Demurrage"
                        },
                        {
                            "direction": "Import",
                            "chargeType": "Detention",
                            "containerSizeType": "40DRY",
                            "commodity": "GENERAL CARGO",
                            "freetimeStartEvent": "GATE-OUT FULL",
                            "freetimeGrantInDays": 14,
                            "rkstCode": "NLROT",
                            "chargePerDiemAfterFreetime": [
                                {
                                    "startDayOfCharge": 15,
                                    "endDayOfCharge": null,
                                    "chargePerDiem": 100,
                                    "currencyOfCharge": "EUR"
                                }
                            ],
                            "displayName": "Import Detention"
                        }
                    ],
                    "penaltyFees": [
                        {
                            "containerSizeType": "40DRY",
                            "currency": "USD",
                            "charges": [
                                {
                                    "penaltyType": "AmendmentFee",
                                    "chargeFee": 100,
                                    "displayName": "Amendment Fee"
                                },
                                {
                                    "penaltyType": "CancellationFee",
                                    "chargeFee": 100,
                                    "displayName": "Cancellation Fee"
                                },
                                {
                                    "penaltyType": "NoShowFee",
                                    "chargeFee": 200,
                                    "displayName": "No Show Fee"
                                },
                                {
                                    "penaltyType": "CompensationFee",
                                    "chargeFee": -100,
                                    "displayName": "Compensation Fee"
                                }
                            ]
                        }
                    ],
                    "price": {
                        "surcharges_per_doc": [
                            {
                                "rate": 130.0,
                                "rateusd": 94.36,
                                "qty": 1,
                                "amount": 130.0,
                                "amountusd": 94.36,
                                "currency": "SGD",
                                "ratebasis": "PER_DOC",
                                "ratetype": "Paid at Origin",
                                "chargecode": "ODF",
                                "chargedescription": "Documentation Fee Origin"
                            },
                            {
                                "rate": 40.0,
                                "rateusd": 45.68,
                                "qty": 1,
                                "amount": 40.0,
                                "amountusd": 45.68,
                                "currency": "EUR",
                                "ratebasis": "PER_DOC",
                                "ratetype": "Paid at Destination",
                                "chargecode": "DDF",
                                "chargedescription": "Documentation fee - Destination"
                            }
                        ],
                        "prices_per_container": [
                            {
                                "priceid": "P_40952180",
                                "containersizetype": "40DRY",
                                "priceValidFromDate": null,
                                "bas": {
                                    "rate": 1025.0,
                                    "rateusd": 1025.0,
                                    "qty": 1,
                                    "amount": 1025.0,
                                    "amountusd": 1025.0,
                                    "currency": "USD",
                                    "ratebasis": "PER_CONTAINER",
                                    "ratetype": "Paid with Freight",
                                    "chargecode": "BAS",
                                    "chargedescription": "Basic Ocean Freight"
                                },
                                "surcharges_per_container": [
                                    {
                                        "rate": 230.0,
                                        "rateusd": 262.66,
                                        "qty": 1,
                                        "amount": 230.0,
                                        "amountusd": 262.66,
                                        "currency": "EUR",
                                        "ratebasis": "PER_CONTAINER",
                                        "ratetype": "Paid at Destination",
                                        "chargecode": "DHC",
                                        "chargedescription": "Terminal Handling Service - Destination"
                                    },
                                    {
                                        "rate": 332.0,
                                        "rateusd": 332.0,
                                        "qty": 1,
                                        "amount": 332.0,
                                        "amountusd": 332.0,
                                        "currency": "USD",
                                        "ratebasis": "PER_CONTAINER",
                                        "ratetype": "Paid with Freight",
                                        "chargecode": "EFF",
                                        "chargedescription": "Environmental Fuel Fee"
                                    },
                                    {
                                        "rate": 15.0,
                                        "rateusd": 10.89,
                                        "qty": 1,
                                        "amount": 15.0,
                                        "amountusd": 10.89,
                                        "currency": "SGD",
                                        "ratebasis": "PER_CONTAINER",
                                        "ratetype": "Paid at Origin",
                                        "chargecode": "EXP",
                                        "chargedescription": "Export Service"
                                    },
                                    {
                                        "rate": 10.0,
                                        "rateusd": 10.0,
                                        "qty": 1,
                                        "amount": 10.0,
                                        "amountusd": 10.0,
                                        "currency": "USD",
                                        "ratebasis": "PER_CONTAINER",
                                        "ratetype": "Paid with Freight",
                                        "chargecode": "LSS",
                                        "chargedescription": "Low Sulphur Surcharge"
                                    },
                                    {
                                        "rate": 325.0,
                                        "rateusd": 235.91,
                                        "qty": 1,
                                        "amount": 325.0,
                                        "amountusd": 235.91,
                                        "currency": "SGD",
                                        "ratebasis": "PER_CONTAINER",
                                        "ratetype": "Paid at Origin",
                                        "chargecode": "OHC",
                                        "chargedescription": "Terminal Handling Service - Origin"
                                    }
                                ]
                            }
                        ],
                        "total": 2017,
                        "totalbas": 1025
                    },
                    "rollableOptionEnabled": false
                }
            ]
        }
    ],
    "spotScope": {
        "spotSupported": true,
        "spotOnlyAllowedFreesale": false
    }
}

For details about the endpoint please refer to the swagger for the endpoint.

List origin and destination port-pairs with valid offers

Path URI

.../offers/v2/offers/brand/{brandScac}/locations

Path parameters

  • brandScac (required): The SCAC code of the carrier for which the offer is available, use maeu for MaerskLine.

Query parameters

  • productCode (optional): Obsolete and has no effect now.

  • includeContainerInfo (optional): Set this with a value of false (default true) if you do not want the response to include information about available container types for the returned origin locations.

  • Up to one origin parameter ...

    • originPrefix (optional): An prefix for the name of origin locations (eg. Dal) to restrict available offers locations returned to only those that match the prefix.
    • originUnLocCode (optional): The UN/LOCODE for the origin locations (eg. CNDAL) to restrict available offers locations returned to only those that match the specified id.
    • originRkstCode (optional): The Maersk RKST code for the origin locations (eg. CNDAI) to restrict available offers locations returned to only those that match the specified id.
    • originGeoId (optional): The Maersk GeoId for the origin locations (eg. 0G5RI2I2X2U8P) to restrict available offers locations returned to only those that match the specified id.

  • Up to one destination parameter ...

    • destinationPrefix (optional): An prefix for the name of destination locations (eg. Bar) to restrict available offers locations returned to only those that match the prefix.
    • destinationUnLocCode (optional): The UN/LOCODE for the destination locations (eg. ESBCN) to restrict available offers locations returned to only those that match the specified id.
    • destinationRkstCode (optional): The Maersk RKST code for the destination locations (eg. ESBCN) to restrict available offers locations returned to only those that match the specified id.
    • destinationGeoId (optional): The Maersk GeoId for the destination locations (eg. 1FQMCYMU9XLZ2) to restrict available offers locations returned to only those that match the specified id.

Allowed consumers

Category of API consumer Access control Authentication needed
Maersk controlled sites Allowed ForgeRock JWT
Direct customers integrations Allowed Consumer key
3rd party platforms Allowed Consumer key

Response data

The endpoint response will contain a json array of json objects for each valid offers location pairs. For details about the response see Model: Locations. The response structure for the .../locations endpoint will contain both origin and destination properties, as well as containers properties unless the parameter includeContainerInfohas been set to false.

Example query

Query: .../offers/v2/offers/brand/maeu/locations?originUnLocCode=CNQIN&destinationPrefix=Luan

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
[
    {
        "brandScac": "maeu",
        "fullTradeSwitch": false,
        "origin": {
            "geoId": "1YCLYW8V7RZB2",
            "rkstCode": "CNTST",
            "unLocCode": "CNQIN",
            "cityName": "Qingdao",
            "regionName": "Shandong",
            "countryName": "China"
        },
        "destination": {
            "geoId": "1OID8PVUH0TJ2",
            "rkstCode": "AOLAD",
            "unLocCode": "AOLAD",
            "cityName": "Luanda",
            "countryName": "Angola"
        },
        "containers": [
            {
                "size": "40",
                "height": "8 6",
                "type": "DRY",
                "iso": "42G1",
                "name": "40DRY",
                "label": "40' Dry Standard",
                "reefer": false,
                "cargoType": "DRY"
            },
            {
                "size": "40",
                "height": "9 6",
                "type": "HDRY",
                "iso": "45G1",
                "name": "40HDRY",
                "label": "40' Dry High",
                "reefer": false,
                "cargoType": "DRY"
            },
            {
                "size": "20",
                "height": "8 6",
                "type": "DRY",
                "iso": "22G1",
                "name": "20DRY",
                "label": "20' Dry Standard",
                "reefer": false,
                "cargoType": "DRY"
            }
        ]
    }
]

For details about the endpoint please refer to the swagger for the endpoint.

List origin ports with valid offers

Path URI

.../offers/v2/offers/brand/{brandScac}/locations/origins

Path parameters

  • brandScac (required): The SCAC code of the carrier for which the offer is available, use maeu for MaerskLine.

Query parameters

  • productCode (optional): Obsolete and has no effect now.

  • includeContainerInfo (optional): Set this with a value of false (default true) if you do not want the response to include information about available container types for the returned origin locations.

  • Up to one origin parameter ...

    • originPrefix (optional): An prefix for the name of origin locations (eg. Dal) to restrict available offers locations returned to only those that match the prefix.
    • originUnLocCode (optional): The UN/LOCODE for the origin locations (eg. CNDAL) to restrict available offers locations returned to only those that match the specified id.
    • originRkstCode (optional): The Maersk RKST code for the origin locations (eg. CNDAI) to restrict available offers locations returned to only those that match the specified id.
    • originGeoId (optional): The Maersk GeoId for the origin locations (eg. 0G5RI2I2X2U8P) to restrict available offers locations returned to only those that match the specified id.

  • Up to one destination parameter ...

    • destinationPrefix (optional): An prefix for the name of destination locations (eg. Ba) to restrict available offers locations returned to only those that match the prefix.
    • destinationUnLocCode (optional): The UN/LOCODE for the destination locations (eg. ESBCN) to restrict available offers locations returned to only those that match the specified id.
    • destinationRkstCode (optional): The Maersk RKST code for the destination locations (eg. ESBCN) to restrict available offers locations returned to only those that match the specified id.
    • destinationGeoId (optional): The Maersk GeoId for the destination locations (eg. 1FQMCYMU9XLZ2) to restrict available offers locations returned to only those that match the specified id.

Allowed consumers

Category of API consumer Access control Authentication needed
Maersk controlled sites Allowed ForgeRock JWT
Direct customers integrations Allowed Consumer key
3rd party platforms Allowed Consumer key

Response data

The endpoint response will contain a json array of json objects for each valid offers location. For details about the response see Model: Locations. The response structure for the .../locations/origins endpoint will not contain destination properties, but will contain containers properties unless the parameter includeContainerInfohas been set to false.

Example query

Query: .../offers/v2/offers/brand/maeu/locations/origins?originPrefix=Qin&includeContainerInfo=false

Response:

 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",
        "origin": {
            "geoId": "1YCLYW8V7RZB2",
            "rkstCode": "CNTST",
            "unLocCode": "CNQIN",
            "cityName": "Qingdao",
            "regionName": "Shandong",
            "countryName": "China"
        }
    },
    {
        "brandScac": "maeu",
        "origin": {
            "geoId": "1MUWHM1ZFR2O6",
            "rkstCode": "CNQIN",
            "unLocCode": "CNQZH",
            "cityName": "Qinzhou",
            "regionName": "Guangxi",
            "countryName": "China"
        }
    }
]

For details about the endpoint please refer to the swagger for the endpoint.

List destination ports with valid offers

Path URI

.../offers/v2/offers/brand/{brandScac}/locations/destinations

Path parameters

  • brandScac (required): The SCAC code of the carrier for which the offer is available, use maeu for MaerskLine.

Query parameters

  • productCode (optional): Obsolete and has no effect now.

  • includeContainerInfo (optional): Set this with a value of false (default true) if you do not want the response to include information about available container types for the returned origin locations.

  • Up to one origin parameter ...

    • originPrefix (optional): An prefix for the name of origin locations (eg. Dal) to restrict available offers locations returned to only those that match the prefix.
    • originUnLocCode (optional): The UN/LOCODE for the origin locations (eg. CNDAL) to restrict available offers locations returned to only those that match the specified id.
    • originRkstCode (optional): The Maersk RKST code for the origin locations (eg. CNDAI) to restrict available offers locations returned to only those that match the specified id.
    • originGeoId (optional): The Maersk GeoId for the origin locations (eg. 0G5RI2I2X2U8P) to restrict available offers locations returned to only those that match the specified id.

  • Up to one destination parameter ...

    • destinationPrefix (optional): An prefix for the name of destination locations (eg. Barc) to restrict available offers locations returned to only those that match the prefix.
    • destinationUnLocCode (optional): The UN/LOCODE for the destination locations (eg. ESBCN) to restrict available offers locations returned to only those that match the specified id.
    • destinationRkstCode (optional): The Maersk RKST code for the destination locations (eg. ESBCN) to restrict available offers locations returned to only those that match the specified id.
    • destinationGeoId (optional): The Maersk GeoId for the destination locations (eg. 1FQMCYMU9XLZ2) to restrict available offers locations returned to only those that match the specified id.

Allowed consumers

Category of API consumer Access control Authentication needed
Maersk controlled sites Allowed ForgeRock JWT
Direct customers integrations Allowed Consumer key
3rd party platforms Allowed Consumer key

Response data

The endpoint response will contain a json array of json objects for each valid offers location. For details about the response see Model: Locations. The response structure for the .../locations/destinations endpoint will not contain origin properties, but will contain containers properties unless the parameter includeContainerInfohas been set to false.

Example query

Query: .../offers/v2/offers/brand/maeu/locations/destinations?originUnLocCode=CNQIN&destinationPrefix=Luan

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
[
    {
        "destination": {
            "geoId": "1OID8PVUH0TJ2",
            "rkstCode": "AOLAD",
            "unLocCode": "AOLAD",
            "cityName": "Luanda",
            "countryName": "Angola"
        },
        "containers": [
            {
                "size": "40",
                "type": "HDRY",
                "iso": "45G1",
                "name": "40HDRY",
                "label": "40' Dry High"
            },
            {
                "size": "40",
                "type": "DRY",
                "iso": "42G1",
                "name": "40DRY",
                "label": "40' Dry Standard"
            },
            {
                "size": "40",
                "type": "REEF",
                "iso": "45R1",
                "name": "40NOR",
                "label": "40' Reefer High (non operational)",
                "isOperational": false
            },
            {
                "size": "20",
                "type": "DRY",
                "iso": "22G1",
                "name": "20DRY",
                "label": "20' Dry Standard"
            }
        ]
    }
]

For details about the endpoint please refer to the swagger for the endpoint.

List supported containers

Path URI

.../offers/v2/offers/containers

Allowed consumers

Category of API consumer Access control Authentication needed
Maersk controlled sites Allowed ForgeRock JWT
Direct customers integrations Allowed Consumer key
3rd party platforms Allowed Consumer key

Response data

The endpoint response will contain a json array of json objects, one object for each supported container. For details about the response see Model: Container Size and Types.

Example query

Query: .../offers/v2/offers/containers

Response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
[
    {
        "size": "20",
        "height": "8 6",
        "type": "REEF",
        "iso": "22R1",
        "name": "20NOR",
        "label": "20' Reefer Standard (non operational)",
        "isOperational": false,
        "cargoType": "DRY",
        "reefer": true
    },
    {
        "size": "40",
        "height": "8 6",
        "type": "DRY",
        "iso": "42G1",
        "name": "40DRY",
        "label": "40' Dry Standard",
        "cargoType": "DRY",
        "reefer": false
    },
    {
        "size": "40",
        "height": "9 6",
        "type": "HDRY",
        "iso": "45G1",
        "name": "40HDRY",
        "label": "40' Dry High",
        "cargoType": "DRY",
        "reefer": false
    },
    {
        "size": "45",
        "height": "9 6",
        "type": "HDRY",
        "iso": "L5G1",
        "name": "45HDRY",
        "label": "45' Dry High",
        "cargoType": "DRY",
        "reefer": false
    },
    {
        "size": "20",
        "height": "8 6",
        "type": "DRY",
        "iso": "22G1",
        "name": "20DRY",
        "label": "20' Dry Standard",
        "cargoType": "DRY",
        "reefer": false
    },
    {
        "size": "40",
        "height": "9 6",
        "type": "REEF",
        "iso": "45R1",
        "name": "40NOR",
        "label": "40' Reefer High (non operational)",
        "isOperational": false,
        "cargoType": "DRY",
        "reefer": true
    }
]

For details about the endpoint please refer to the swagger for the endpoint.