Model: Product Offers

The Product Offers data presents the detailed information about an available priced quote or a missing price quote. This data is retrieved by calling the Product Offers endpoints (see Endpoints: Product Offers).

Product Offers Available

Data representation

Each product has a set of general attributes as shown below in an example of data representation:

{
  "offers": [
    {
      "productOffer": {
        "productCode": "MaerskSpot",
        "productName": "Maersk Spot",
        "productVersion": 1,
        "gcssProductId": 2,
        "brandScac": "maeu",
        "routeCode": "E2W",
        "originRkstCode": "CNDAI",
        "originGeoId": "0G5RI2I2X2U8P",
        "originDisplayName": "Dalian, China",
        "originCityName": "Dalian",
        "originCountryName": "China",
        "originRegionName": "Liaoning",
        "originUnLocCode": "CNDLC",
        "destinationRkstCode": "ESBCN",
        "destinationGeoId": "1FQMCYMU9XLZ2",
        "destinationDisplayName": "Barcelona, Spain",
        "destinationCityName": "Barcelona",
        "destinationCountryName": "Spain",
        "destinationRegionName": null,
        "destinationUnLocCode": "ESBCN",
        "originServiceMode": "CY",
        "destinationServiceMode": "CY",
        "productVariances": [
          ...
        ],
        "deepLink": "https://maersk.com/book",
        "containers": [
          {
            "size": "20",
            "height": "8 6",
            "type": "DRY",
            "iso": "22G1",
            "name": "20DRY",
            "label": "20 Dry Standard",
            "amount": 1,
            "mtonPrCntr": 25.000,
            "isSpotSupported": true,
            "isSpecial": false,
            "cargoType": "DRY",
            "reefer": false,
            "spotSupported": true,
            "special": false
          }
        ]
      },
      "routeSchedulesWithPrices": [
        {
          "offerId": "O_T1crt9",
          "routeScheduleFull": {
            ...
          },
          "importDnDConditions": [
            ...
          ],
          "penaltyFees": [
            ...
          ],
          "price": {
            ...
          },
          "rollableOptionEnabled": true
        }
      ]
    }
  ],
  "spotScope": {
    ...
  }
}

Data description

NOTE: The attributes present in the JSON structure but missing in the below description are used only for internal purposes and should not be used by Maersk external customers. Some attributes are self-explanatory, eg "vesselName"

An offer has the following attributes:

productCode : The product code of a product for which the returned offer is available, eg. MaerskSpot for the Maersk Spot Product
productName : The commercial name of the product. This is what should be displayed when the product is shown, not the productCode.
productVersion : The version of the product. A specific product is identified by its productCode and productVersion.
brandScac : The SCAC code of the carrier for which the offer is available, eg. maeu for MaerskLine.
routeCode : The unique ID linked to a valid port pair combination
originRkstCode : The RKST code for the requested origin. The code is used internally in Maersk network
originGeoId : The geo ID for the requested origin. The ID is used internally in Maersk network
originDisplayName : The complete display name of the origin.
originCityName : The city name of the origin.
originCountryName : The country name of the origin.
originRegionName : The region name for the requested origin. Some countries does not have regions.
originUnLocCode : The United Nations Code for Trade and Transport Locations (UN/LOCODE) for the requested origin
destinationRkstCode : The RKST code for the requested destination. The code is used internally in Maersk network
destinationGeoId : The geo ID for the requested destination. The ID is used internally in Maersk network
destinationDisplayName : The complete display name of the destination.
destinationCityName : The city name of the destination.
destinationCountryName : The country name of the destination.
destinationRegionName : The region name for the requested destination. Some countries does not have regions.
destinationUnLocCode : The United Nations Code for Trade and Transport Locations (UN/LOCODE) for the requested destination
originServiceMode : The service mode of the origin. The allowed values are CY for Merchant Haulage when the customer arranges own transportation to move the cargo to/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.
destinationServiceMode : 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/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.
deepLink : A link to Maersk.com website. The URL redirects to the SPOT offers search website page. The webpage redirect can be used to initiate the booking of the offer for customers without am EDI or Intra connection for placing bookings.
containers : The containers data, see Model: Container Size and Types
routeSchedulesWithPrices : The details about the schedules and prices for the offer:
- routeScheduleFull : The schedules data, see Model: Routes & Schedules
- importDnDConditions: The demurrage and detentions conditions, see Model: Demurrage and Detention Conditions
- penaltyFees: The penalty fees data, see Model: Penalty Fees
- price : The price data, see Model: Price Structure
- rollableOptionEnabled : (Deprecated, currently every offer is returned with a rollable option, thus this field will always be true) A flag to signal if the rollable add on is currently enabled for the offer. If your cargo is not time sensitive we provide an option to mark it as Rollable. Should we get to a situation where we need to roll cargo we will roll goods marked as Rollable first and pay you a compensation in exchange for that.

Product Offers Missing

Data representation

Each filtered away offer has a set of general attributes, together with the reason for being filtered away as shown below in an example of data representation:

{
    "offers": [],
    "offerFilteredReasons": [
      {
        "traceId": "8a738b266df15448",
        "productCode": "MaerskSpot",
        "brandScac": "maeu",
        "routeCode": "E2W",
        "originServiceMode": "CY",
        "destinationServiceMode": "CY",
        "origin": "CNDAI",
        "originLabel": "Dalian China",
        "destination": "ESBCN",
        "destinationLabel": "Barcelona Spain",
        "firstLoadPort": "CNDAIDT",
        "firstLoadPortLabel": "Dalian China",
        "lastDischargePort": "ESBCNBS",
        "lastDischargePortLabel": "Barcelona Spain",
        "vesselVoyages": null,
        "container": "[20DRY]",
        "departureDate": "2022-09-01",
        "departureWeek": 35,
        "detailedSchedule": "Schedule segments: CNDAIDT > KRULSDY > CNNPOJ4 > ESBCNBS. ",
        "vesselName": "MILAN MAERSK",
        "vesselCode": "Y27",
        "voyageNumber": "235W",
        "status": "NOT_ALLOWED",
        "type": "PRICE",
        "reason": "We are not currently offering a spot product for CNDAIDT > CNDAIDT > ESBCNBS > ESBCNBS with [20DRY] on 2022-09-01. Please search for alternate product OR place a standard booking.\n No spot price in Penny for route schedule.",
        "requestType": "Offers",
        "time": "2022-07-20T08:59:19.25"
      }
  ]
}

Data description

NOTE: The attributes present in the JSON structure but missing in the below description are used only for internal purposes and should not be used by Maersk external customers. Some attributes are self-explanatory, eg "vesselName"

An offer has the following attributes:

productCode : The code of the requested product
brandScac : The requested SCAC code of the carrier
routeCode : The unique ID linked to a valid port pair combination
originServiceMode : The service mode of the origin. The allowed values are CY for Merchant Haulage when the customer arranges own transportation to move the cargo to/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.
destinationServiceMode : 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/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.
origin : The RKST code for the requested origin. The code is used internally in Maersk network
destination : The RKST code for the requested destination. The code is used internally in Maersk network
firstLoadPort : The RKST code for the first load port. The code is used internally in Maersk network
lastDischargePort : The RKST code for the last discharge port. The code is used internally in Maersk network
vesselVoyage : The unique ID for the vessel and the voyage. These IDs are used internally in Maersk network
status: The status of the searched offer. Current possible values: NOT_ALLOWED
type : The data type that is not available for the requested offer. Current possible values relevant for external consumers:
- SCHEDULE : No schedule is available for the requested offer
- PRICE : No price is available for the requested offers
- DEADLINE : The ocean deadline is passed for the requested offer
- PRODUCT : The requested port pair is not enabled for Spot offers
- CAPACITY : There is no more vessel capacity available for the request offer
- INLANDEXCLUSION : The inland segment of the journey is not enabled for the requested offer
- INLANDDEADLINE : The inland deadline is passed for the requested offer
- EHS : There is no available equipment for the requested offer
reason : The detailed reason for which the requested offer is not available