Freight

Example 5 – Integration with the Trip API

The Freight API service can be used in conjunction with the Trip API. The process consists of simply adding the Freight API parameters to the body of the request to the Trip API.

You won’t need to include the distance parameter, as the Trip API itself will provide the information on the distance traveled.

The following example shows a request for a route between São Paulo – SP and Campinas – SP, to be traveled by a truck with 4 double axles, including calculation of tolls and freight (Cargo: Solid bulk / Type of operation: D).

Endpoint used: https://api.maplink.global/trip/v1/problems (Method: POST)

The full request can be found below:

{
   "calculationMode": "THE_FASTEST",   
   "points": [
       {
           "latitude": -23.566329,
           "longitude": -46.653690,
           "siteId": "SP"
       },
       {
           "latitude": -22.910884,
           "longitude": -47.066027,
           "siteId": "CAMPINAS"
       }
   ],
   "toll": {
       "vehicleType": "TRUCK_WITH_FOUR_DOUBLE_AXLES"
   },
   "freight": {
       "operationType": [
           "D"
       ],
       "goodsType": [
           "GRANEL_SOLIDO"
       ],
       "axis": [
           "4"
       ],
       "roundTrip": false,
       "backEmpty": false,
       "otherCosts": [
           {
               "name": "ICMS",
                "type": "PERCENT",
               "value": "5"
           },
           {
               "name": "Lucro",
               "type": "PERCENT",
               "value": "20"
           },
           {
               "name": "TaxaFixa",
               "type": "FIXED",
               "value": "500"
           }
       ],
       "date": "2021-10-02"
   }
}

Where:

  • The parameter points contains the coordinates for a simple route between São Paulo and Campinas;
  • The parameter toll contains the data of the tolls on the route.
  • The parameter freight contains the minimum freight data for the route.
{
    "id": "65835380bb432a18819d6555",
    "clientId": "maplink",
    "totalDistance": 95119,
    "totalNominalDuration": 5281,
    "averageSpeed": 51.30,
    "tollCosts": 98.40,
    "routeFreightCost": 335232.70,
    "legs": [
        {
            "distance": 95118,
            "nominalDuration": 5281,
            "averageSpeed": 51.3,
            "points": "vxynCl`w{G_B{AkEgEaEhFiGhIqBgC}@y@mGoC_D{A_@_@[q@eAaC_BsDqDgFkFVk@KMYSWa@Q]E{@gAk@o@q@g@sCwAcGkCsB{@QAa@Uw@o@_@m@Oc@y@wDi@wByCeJqCgHUu@OcAK}@CeAD_A@o@Ko@Ok@k@_Ac@e@YSeC{AsAu@_Ag@q@UqBqAgQgKwGiDgB{@}A]]EeG]}BIoBMgHc@aFGi@GwDq@cUuESQkBg@c@WoGsA{@UkBk@mAa@}Ao@iBy@OM{AaBgC}CUHYPIJOZm@dBiC~E{Tj^]f@_@`@oAdA_IbG[Ze@n@OXMh@IhAQvIItD@d@DXYhDyAdUSvDYlGi@jHk@~FDf@k@xL]pF]hE@d@UpC_@lG{AtVIp@_@vEa@dJo@zKgBvWg@tH{A~UU~Bg@jCW`A_AhCc@`AuCnEsBpCeBpC_A`B}@tBw@jCi@jCY~B{BrTa@zEoAlHa@tDOx@uArMOdBMtDChBFhEl@fOLpE`@hKVfFNlEJhANrDC~DKrDShHK`BMl@Ir@U|DW|Gc@tIQ`ECvA@~ABdBHpAN`BZdCDx@@|@Ch@MbAQv@Yx@c@`Ae@t@uBjCIPcDbDaLrJcQpOqCvByGjEaGxCsLdHyF`EyFpEcShP}BvA_DvAoBh@gC`@wKp@kNbAoDTsB`@gDfAmCjAsClBwBjBeBlBeBbCqArCkDfKeAjDqAdDy@bB_AvA}@hA}AvAqAz@eB|@gBn@}ItC{QfGkOhFuEvAeB^oDh@uSfCkc@pFyLvA}S~BqOxBwKvA{B^cFxAaO~FkRjHkEnAcEb@qINga@fAiK\\mBHqCb@kE|AoMhGkKdFkEtBsHpDkBv@uBv@qBz@sA\\qCr@cDr@eDh@wC\\uCVqDNeCHwBCcUNuLHiEJ{FXkBPqAFkBNuCNi`@bC_HZ_LNoHNsMNwDViDh@gD|@yCrAaDpBaD|CkDhEgNpQ_CvCsDhE{ApAiAz@uA|@oKlFcPfIyNhHsDhBgBr@aAZcCf@oLvAqAVaAVqAd@cD~A{AdA}A~AeA|As@lAUd@gA|Cc@`BaBbLo@xC[bAo@dBYn@_@l@mAdBkDhE{@x@uBxCuBpDaAvBm@xAkAtDm@~BMx@e@jEcAjSg@nIc@rIOvAMbAWxAs@dDq@bCmAvCwBxDgAvA_K`LkDrDuN|NiDzD{GhH{ClCuAbAcBdAwDtBqAj@sCfAyCz@qE`AcBVmBRuE\\{FNs@AoVRsORiB@kJHc@?c[ZoGL{BPaAL{@P{Bt@uBdAkAr@uAdAs@n@wAhBi@x@a@v@c@`A[|@s@fCaCbJsEnQ[|@_@~@aAlBo@dAwAnBo@r@mCnCgD~CyNtNaCvBiAz@_BbAuAn@{@Z_Ch@cCVeWtA{AN_BTkB`@{Br@mAj@oAt@m@`@sApAgKfMmA|Ag@h@_BxA}@p@eAn@yAj@gA^aATwAPgBP}EZmFRuHb@}UrAeFb@_AL}A^wAd@qAh@iAp@mA|@e@`@gAfAoFhHgEnF_DjEoCbDcAbAmAbA_DxB{DzB}DdCy@l@wBlBaA~@yAdB}BdD]XOTwC|EcInMg@t@yAfBaBbBs@l@_BnAaAp@{Ax@iB|@uCdAoIzB{BZaAF_CDsCGcBOmCa@}IiByFoAmDg@qAMsAEy@AuBH}@HyCb@wA^mDpA}RbIqC~@q@NoBZoCTyJt@{BT{@JqCh@_Ch@qE~AuGjCmB|@{L|E{LbFeEhBuN|F{CvAoAt@mAv@{AhAwIjH}TjRoFnEyArAsBvBcBlBmBbCqBrCw@nAsAzB{JbRkI|OaMhU_ClEsCtEmBjC}BbCuAnAgDnCsErC_D`ByEdBoDfA{KlCmIzB_FrAeLtCoKxC{ZhImDnAoGjCkFfCoErCgD`CsCxBuDlDiIbKw@jAqG~IoGvIcHvJq@fAkNtRaEhFwCzCkEvEyChCaBlAqD`CmDfCi@ZsEzByC`B_PdI{M`HaGlCmCjAoDtAuIvCaOtEmJzCcFtAsIrC}B|@cHzBoGfByFvBkCfAaClAsDvBkD~B_HnFqBlBkEbEsHnHqHhHuHfHwDlD}DpCgFrCmCtAgChAsE~AqEjAkH|AcI|AkSzD}HnBoH~BqEjBwBv@uBdA_InEuPnJwJrFq`@`U_SbL_K|F}P|JqGlDqUzMkEhCsJpF}RdLoDpBkDvBkHtEiKbH_^tVoD`CuJvGsOxKmH|EiHbFaKdHqAv@{AfAsKtH{LjIiKdGaCzAmEjCmE`CaJ|EoBjAaEzBoV|M{JnFiB|@uCbB{JnFeBx@oFdCkG~BeCz@eCt@uO|DgFtAaCz@_C`AiD~AwJdFkPbJeHtDgNnHcExBwHfEwLrGiJ`FwKhGoJhFqLlGiSxKyDpBoPpJqPjK{V~OmLlHuSjMgG|DsHzE}FrDeOlJuGxDuM|GcPvHcFdC_A^kHjDoKdFiOfHiGtCuI`E{DbBeFhCmFdCsG|Ce^xP}MnG}G`DqMhGePvHuI~DoAXaI~Ca@N_@HoB~@kBbA{CtAcPxHeGnCkDbBeCzAyFbEuAt@YLYHc@DYAiAQ_BIaBAq@Me@[[WOGIKi@u@u@o@gJqFoN{HqBq@kBg@aL_Cm@OaFkAA?mAYuFkAeMkCuD{@mGwAyBo@i@I]OoCy@m@_@gIkBoAKmBYsAGCVy@rD_BdJlCj@",
            "tollCalculation": {
                "tolls": [
                    {
                        "id": "13",
                        "name": "Pedágio - Campo Limpo",
                        "address": "SP 348 - Rod. dos Bandeirantes - Km 39",
                        "city": "Cajamar",
                        "state": {
                            "name": "São Paulo",
                            "code": "SP"
                        },
                        "country": "Brasil",
                        "concession": "Autoban",
                        "direction": "NORTH",
                        "coordinates": {
                            "latitude": -23.3260346,
                            "longitude": -46.8231453
                        },
                        "serviceTypes": [
                            {
                                "serviceId": "48",
                                "name": "Via Facil"
                            },
                            {
                                "serviceId": "35351600323810101",
                                "name": "ANTTCODE"
                            }
                        ],
                        "price": 49.60
                    },
                    {
                        "id": "73",
                        "name": "Pedágio - Valinhos Norte",
                        "address": "SP 330 - Rod. Anhanguera - Km 82 Valinhos",
                        "city": "Valinhos",
                        "state": {
                            "name": "São Paulo",
                            "code": "SP"
                        },
                        "country": "Brasil",
                        "concession": "Autoban",
                        "direction": "NORTHWEST",
                        "coordinates": {
                            "latitude": -23.01295484,
                            "longitude": -47.0230555
                        },
                        "serviceTypes": [
                            {
                                "serviceId": "50",
                                "name": "Via Facil"
                            },
                            {
                                "serviceId": "35353300820000101",
                                "name": "ANTTCODE"
                            }
                        ],
                        "price": 48.80
                    }
                ],
                "legTotalCost": 98.40,
                "vehicleType": "TRUCK_WITH_FOUR_DOUBLE_AXLES"
            }
        }
    ],
    "freight": {
        "source": "RESOLUÇÃO No 5.949, DE 13 DE JULHO DE 2021",
        "results": {
            "D": {
                "4": {
                    "GRANEL_SOLIDO": {
                        "value": 267707.43,
                        "otherCosts": {
                            "ICMS": 13385.38,
                            "Lucro": 53541.49,
                            "TaxaFixa": 500
                        }
                    }
                }
            }
        },
        "minimumFreight": 267707.43,
        "minimumFreightWithCosts": 335134.30
    },
    "source": "MAPLINK"
}