---
# System prepended metadata

title: Endpoints route-cost-api x freight-rate-api

---

# Endpoints route-cost-api x freight-rate-api

## Extra-costs

`GET /extra-costs/search`

Query params:

- page [required, int]
- limit [required, int]
- site_id [optional, string]
- carrier_id [optional, int]
- starting_at [optional, datetime]
- file_id [guid, optional]
- 
```jsonld=
{
   "total":1000,
   "page_size":100,
   "page": 1, 
   "content": [
      {
         "id":"19a9047a-7720-45ee-a126-aa6851ab183a",
         "valid_from":"2021-01-01T00:00:00.000Z",
         "valid_until":null,
         "carrier_id":17500540,
         "type":"YY",
         "percentage_value":0.00000,
         "min_value":235.19,
         "percentage_calculated_on":"",
         "fixed_value":0.00,
         "conditions":{
            "width":0,
            "height":0,
            "length":0,
            "weight":70,
            "base_cost":0,
            "goods_value":0,
            "destinations":null,
            "carrier_service":""
         }
      },
      {
         "id":"34bea778-ce4e-4d85-9f9b-31905a1eba4d",
         "valid_from":"2021-01-01T00:00:00.000Z",
         "valid_until":null,
         "carrier_id":292026138,
         "type":"OO",
         "percentage_value":0.00000,
         "min_value":60.00,
         "percentage_calculated_on":"",
         "fixed_value":0.00,
         "conditions":{
            "width":0,
            "height":0,
            "length":0,
            "weight":0,
            "base_cost":0,
            "goods_value":0,
            "destinations":{
               "type":"RANGE",
               "ranges":[
                  {
                     "end":"1139",
                     "start":"1139"
                  }
               ],
               "simple_destinations":null
            },
            "carrier_service":""
         }
      }
   ]
}
```

## Service Config

`GET /services-config/search`

Query params:

- page [required, int]
- limit [required, int]
- site_id [optional, string]
- carrier_id [optional, int]
- starting_at [optional, datetime]


```jsonld=
{
   "total":1000,
   "page_size":100,
   "page": 1, 
   "content":[
      {
         "id":"1aecdd30-639e-4ae9-b63c-1d120704f1b1",
         "site_id":"MLM",
         "rate_type":"PHYSICAL_WEIGHT",
         "carrier_id":17501640,
         "service_id":521,
         "valid_from":"2021-12-02T00:00:00.000Z",
         "valid_until":null,
         "scope_config":{
            "calculation_type":"MLM"
         },
         "weight_config":{
            "real_exemption":0,
            "use_volumetric":true,
            "volumetric_factor":5000,
            "volumetric_exemption":0
         },
         "logistic_types":[
            "inside_melinet"
         ],
         "carrier_service":"8832794095",
         "carrier_service_n2":""
      },
      {
         "id":"22fd6488-f44e-45ca-a5bf-906468456aac",
         "site_id":"MLM",
         "rate_type":"PHYSICAL_WEIGHT",
         "carrier_id":292026138,
         "service_id":186599,
         "valid_from":"2021-12-02T00:00:00.000Z",
         "valid_until":null,
         "scope_config":{
            "calculation_type":"MLM"
         },
         "weight_config":{
            "real_exemption":0,
            "use_volumetric":true,
            "volumetric_factor":5000,
            "volumetric_exemption":0
         },
         "logistic_types":[
            "inside_melinet",
            "outside_melinet"
         ],
         "carrier_service":"N/A",
         "carrier_service_n2":""
      }
   ]
}
```

## Rates


`GET /rates/search`

Query params:

- page [required, int]
- limit [required, int]
- site_id [optional, string]
- carrier_id [optional, int]
- starting_at [optional, datetime]
- file_id [guid, optional]


```jsonld=
{
   "total":1000,
   "page_size":100,
   "page": 1, 
   "content":[
      {
         "id":"016a3799-fd69-4b3f-a3f4-7f9e93a99eaf",
         "valid_from":"2022-06-08T00:00:00.000Z",
         "valid_until":"2022-10-10T00:00:00.000Z",
         "carrier_id":17503240,
         "carrier_service":"70D",
         "carrier_service_n2":"N/A",
         "scope":"1",
         "scope_n2":"N/A",
         "origin":"N/A",
         "extra_kg_value":0.00,
         "shipments_range_from":350000,
         "shipments_range_until":999999,
         "site_id": "MLM",
         "ranges":[
            {
               "rate":52.3481,
               "weight_to":1.0,
               "weight_from":0.0,
               "extra_kg_value":0.0
            }
         ]
      }
   ]
}
```

## Scopes MLM

`GET /scopes-mlm/search`

Query params:

- page [required, int]
- limit [required, int]
- site_id [optional, string]
- carrier_id [optional, int]
- starting_at [optional, datetime]
- file_id [guid, optional]


```jsonld=
{
   "page":  1,
   "total": 1000,
   "limit": 100,
   "data":[
      {
         "id":"3b527dda-4ce5-475d-bfd4-4062e76577cf",
         "carrier_id":17500540,
         "carrier_service":"GDS",
         "site_id": "MLM",
         "scopes":[
            {
               "scope":"1",
               "origin_zone":"G13",
               "destination_zone":"G13"
            },
            {
               "scope":"1",
               "origin_zone":"G1",
               "destination_zone":"G1"
            }
         ],
         "valid_from":"2022-10-10T00:00:00.000Z",
         "valid_until":null
      }
   ]
}
```

## Zones MLM


`GET /zones-mlm/search`

Query params:

- page [required, int]
- limit [required, int]
- site_id [optional, string]
- carrier_id [optional, int]
- starting_at [optional, datetime]
- file_id [guid, optional]

```jsonld=
{
   "total":1000,
   "page_size":100,
   "page":1, 
   "content":[
      {
        "carrier_id": 17501740,
        "valid_from": "2022-06-08T00:00:00.000Z",
        "valid_until": null,
        "site_id": "MLM",
        "zones": {"1000": "MX3", "1184": "MX3"}
      }
   ]
}
```

## Scopes MLB


`GET /scopes-mlb/search`

Query params:

- page [required, int]
- limit [required, int]
- site_id [optional, string]
- carrier_id [optional, int]
- starting_at [optional, datetime]
- file_id [guid, optional]


```jsonld=
{
    "total":1000,
    "page_size":100,
    "page":1, 
    "content": [
        {
            "site_id": "MLB",
            "carrier_id": "...",
            "carrier_service": "....",
            "valid_from": "2022-06-08T00:00:00.000Z",
            "valid_until": null,
            "origin": "N/A",
            "data": {
                "start_values": [1, 2, 3, 4],
                "stop_values": [5, 6, 7, 8],
                "areas": ["BAC", "WTF"]
            }
        }    
    ]
}
```


## Scopes by cities (correios)

`GET /scopes-by-cities/states/search` 

- page [required, int]
- limit [required, int]

```jsonld=
{
   "total":1000,
   "page_size":100,
   "page":1, 
   "content":[
       {
         "state_id" : "SP",
         "city_id": "ABCDEF=123y412ybd",
         "country_id": "BR"
       },
   ]
}
```


`GET /scopes-by-cities/scopes/search` 

- page [required, int]
- limit [required, int]
- site_id [optional, string]
- carrier_id [optional, int]
- starting_at [optional, datetime]
- file_id [guid, optional]

```jsonld=
{
   "total":1000,
   "page_size":100,
   "page": 1, 
   "content":[
       {
         "carrier_id": 1234,
         "carrier_service": "N/A",
         "carrier_service_n2": "N/A",
         "valid_from":  "2022-06-08T00:00:00.000Z",
         "valid_until": "2022-06-08T00:00:00.000Z",
         "scope": "...",
         "origin_state_id" : "...",
         "destination_state_id": "...",
         "origin_city_id" : "....",
         "destination_city_id": "....",
         "city_id": "...",
         "site_id": "MLB"
       },
   ]
}
```