Skip to content

Model: Price Structure

The Price Structure data presents the detailed information about all prices for an offer. This data is retrieved by calling the Product Offers endpoints (see Endpoints: Product Offers).

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
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
"price": {
            "surcharges_per_doc": [
                {
                    "rate": 4050.0,
                    "rateusd": 55.1,
                    "qty": 1,
                    "amount": 4050.0,
                    "amountusd": 55.1,
                    "currency": "INR",
                    "ratebasis": "PER_DOC",
                    "ratetypecode": "Origin",
                    "chargecode": "ODF",
                    "chargedescription": "Documentation Fee Origin"
                },
                {
                    "rate": 130.0,
                    "rateusd": 94.36,
                    "qty": 1,
                    "amount": 130.0,
                    "amountusd": 94.36,
                    "currency": "SGD",
                    "ratebasis": "PER_DOC",
                    "ratetypecode": "Destination",
                    "chargecode": "DDF",
                    "chargedescription": "Documentation fee - Destination"
                }
            ],
            "prices_per_container": [
                {
                    "priceid": "P_456033828_T1crum",
                    "containersizetype": "20DRY",
                    "priceValidFromDate": null,
                    "bas": {
                        "rate": 1.0,
                        "rateusd": 1.0,
                        "qty": 1,
                        "amount": 1.0,
                        "amountusd": 1.0,
                        "currency": "USD",
                        "ratebasis": "PER_CONTAINER",
                        "ratetypecode": "Freight",
                        "chargecode": "BAS",
                        "chargedescription": "Basic Ocean Freight"
                    },
                    "surcharges_per_container": [
                        {
                            "rate": 215.0,
                            "rateusd": 156.06,
                            "qty": 1,
                            "amount": 215.0,
                            "amountusd": 156.06,
                            "currency": "SGD",
                            "ratebasis": "PER_CONTAINER",
                            "ratetypecode": "Destination",
                            "chargecode": "DHC",
                            "chargedescription": "Terminal Handling Service - Destination"
                        },
                        {
                            "rate": 5.0,
                            "rateusd": 5.0,
                            "qty": 1,
                            "amount": 5.0,
                            "amountusd": 5.0,
                            "currency": "USD",
                            "ratebasis": "PER_CONTAINER",
                            "ratetypecode": "Origin",
                            "chargecode": "EXP",
                            "chargedescription": "Export Service"
                        },
                        {
                            "rate": 7290.0,
                            "rateusd": 99.18,
                            "qty": 1,
                            "amount": 7290.0,
                            "amountusd": 99.18,
                            "currency": "INR",
                            "ratebasis": "PER_CONTAINER",
                            "ratetypecode": "Origin",
                            "chargecode": "OHC",
                            "chargedescription": "Terminal Handling Service - Origin"
                        }
                    ]
                }
            ],
            "total": 411,
            "totalbas": 1
        }

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"

A price for an offer has the following attributes:

  • surcharges_per_doc : The surcharges for documentation

    • rate: The rate information for surcharges

    • rateusd: The rate in USD

    • qty: Quantity of containers for this specific container size type

    • amount: The total amount for one specific container size type (Amount = rate * qty)

    • amount: The total amount in USD for one specific container size type (Amount = rateusd * qty)

    • currency: The requested currency to be displayed

    • ratebasis: The rate basis (PER_DOC or PER_CONTAINER)

    • ratetypecode: The rate type (Origin / Destination / Freight)

    • chargecode: The surcharge code (BAS for Ocean Freight)

    • chargedescription: The surcharge description (eg. Ocean Freight)

  • prices_per_container: The price per requested container

    • priceid: The price id. This price id is used to further request the booking of the given offer through Booking API service offered by Maersk

    • containersizetype: The container size type for which the price is valid

    • priceValidFromDate: Start date of the price validity

    • bas: The BAS charges

    • surcharges_per_container: The surcharges for the specified container

  • total: The total of all charge types

  • totalbas: The total of BAS charge type