Skip to content

Endpoints: Product Definition

The Product Definition group of endpoints are concerned about which the details of products offered. The response data models for the Product Offers endpoints will contain data to identify the product offered, but will not contain the detailed information for the product. The endpoints in the Product Definition group of endpoints makes this information available. The definition for a Product is identified by the productCode and productVersion and the definition is immutable. In other words if the definition for a product is changed a new version is created, that will supplant the previous version of the product (except for smaller textual changes made for clarification purposes). Bookings already placed with the definition for a retired product version is still subject to that product definition, which means an existing booking will not change terms and conditions, if a new version of the product is made available. This also means that two versions of a product can be valid at the same time, but only that latest version will be available on new offers.

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

Get Product Definition

Path

.../offers/v1/products/{productCode} or .../offers/v1/products/{productCode}/version/{version}

Path parameters

  • productCode (required): The product code identifies a certain product, eg. MaerskSpot for the Maersk Spot Product.
  • version (optional): The product version identifies a specific version of a product's definition. If it is absent the definition for the latest version of the product will be returned.

Query parameters

None.

Response data

The endpoint will (on success) respond with a json object for the product definition of the specified product. For details about the response see Model: Product Definition.

Example query

Query: .../offers/v1/products/MaerskSpot/version/1

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
{
    "productCode": "MaerskSpot",
    "version": 1,
    "gcssProductId": 2,
    "gcssProductIdWithVR": 5,
    "type": "ocean",
    "category": "spot",
    "status": "active",
    "name": "Maersk Spot",
    "description": "Competitive pricing with a booking guarantee and restricted flexibility in booking cancellation and amendment",
    "validFromDate": "2018-11-01",
    "validToDate": null,
    "attributeGroups": [
        {
            "code": "BnL",
            "title": "Booking and loading",
            "attributes": [
                {
                    "code": "BkCanc",
                    "category": "TEXT",
                    "title": "Booking Cancellation",
                    "setting": "Cancel with a Cancellation Fee",
                    "value": null
                },
                {
                    "code": "BkConf",
                    "category": "TEXT",
                    "title": "Booking Confirmation",
                    "setting": "Guaranteed",
                    "value": null
                },
                {
                    "code": "EqpPrio",
                    "category": "TEXT",
                    "title": "Equipment Prioritisation",
                    "setting": "Prioritized in case of Shortage",
                    "value": null
                },
                {
                    "code": "LoadOrg",
                    "category": "TEXT",
                    "title": "Loading at origin",
                    "setting": "SPOT",
                    "value": null
                },
                {
                    "code": "LoadTrnsp",
                    "category": "TEXT",
                    "title": "Loading at transhipment",
                    "setting": "SPOT",
                    "value": null
                }
            ]
        },
        {
            "code": "Promo",
            "title": "Promotions",
            "attributes": [
                {
                    "code": "CustSLvl",
                    "category": "TEXT",
                    "title": "Customer Service Level",
                    "setting": "Depending on customers CS level",
                    "value": null
                },
                {
                    "code": "Segmt",
                    "category": "TEXT",
                    "title": "Segmentation",
                    "setting": "Super Saver & Efficiency",
                    "value": null
                }
            ]
        },
        {
            "code": "TnC",
            "title": "Terms & Conditions",
            "attributes": [
                {
                    "code": "DnD",
                    "category": "URL",
                    "title": "Demurrage and Detention",
                    "setting": "https://assets.maerskline.com/combined-pricing-assets/maeu/dnd/free_time_offer_for_Maersk_SPOT.xlsx",
                    "value": null
                },
                {
                    "code": "Route",
                    "category": "TEXT",
                    "title": "Routing",
                    "setting": "As per asis routing offering",
                    "value": null
                },
                {
                    "code": "TnC",
                    "category": "URL",
                    "title": "Terms and Conditions",
                    "setting": "https://terms.maersk.com/terms-spot-booking",
                    "value": null
                }
            ]
        },
        {
            "code": "Paymt",
            "title": "Payments",
            "attributes": [
                {
                    "code": "Paymt",
                    "category": "TEXT",
                    "title": "Payment",
                    "setting": "No payment upfront",
                    "value": null
                },
                {
                    "code": "RollFee",
                    "category": "TEXT",
                    "title": "Carrier Compensation Fee",
                    "setting": "Applicable",
                    "value": null
                },
                {
                    "code": "Surchg",
                    "category": "TEXT",
                    "title": "Surcharges",
                    "setting": "Standard",
                    "value": null
                }
            ]
        },
        {
            "code": "Amnd",
            "title": "Amendments",
            "attributes": [
                {
                    "code": "ChngDel",
                    "category": "TEXT",
                    "title": "Change of delivery or discharge port",
                    "setting": "Amendment Fee & Reprice",
                    "value": null
                },
                {
                    "code": "ChngVes",
                    "category": "TEXT",
                    "title": "Change of vessel",
                    "setting": "Amendment Fee & Reprice",
                    "value": null
                },
                {
                    "code": "DecCntr",
                    "category": "TEXT",
                    "title": "Decrease number of containers",
                    "setting": "Cancellation Fee",
                    "value": null
                }
            ]
        }
    ]
}

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