Skip to content

Model: Product Definitions

The Product Definitions data presents the detailed information about a requested product. This data is retrieved by calling the Product Definition endpoints (see Endpoints: Product Definitions).

Data representation

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

 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
{
    "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
                },
                ...
            ]
        },
        ...      
    ]
}

Data description

Besides the self explanatory properties such as version, name, description and so on, a product has the following attributes:

  • productCode : The product code for the requested product (eg. MaerskSpot for the Maersk Spot Product)

  • gcssProductId : An identifier for the product in gcss. The gcssProductId is used for internal purposes and should not be used by Maersk external consumers

  • gcssProductIdWithVR : An identifier for the product in gcss. The gcssProductIdWithVR is used for internal purposes and should not be used by Maersk external consumers

  • version, type, category, status, name, description : The version, type, category, full name and description of the product

  • validFromDate : The value specifies the time the product becomes available

  • validToDate : The value specifies the time the product stops being available

  • attributeGroups : A set of attribute groups showing meaningful groups of services offered on the product (eg. Booking and loading). Each group has a set of

    • attributes: the current values for the specific service group (eg. Cancel with a Cancellation Fee)