cargopanel logocargopanel for developers

Get Proposals

POSThttps://api.cargopanel.co/v1/carriers/proposal/domestic
POSThttps://sandbox-api.cargopanel.co/v1/carriers/proposal/domestic

Calculate domestic shipping rates for your parcels within Turkey.

This API requires a contract. Get in touch with cargopanel Support Team.

Request Fields

originCitystringrequired

Origin city name in Turkey (e.g. "İstanbul", "Ankara")

destinationCitystringrequired

Destination city name in Turkey (e.g. "Ankara", "İzmir")

packages[].quantitynumberrequired

Number of pieces in the package

packages[].weightnumberrequired

Weight of the package in kilograms

packages[].dimensions.widthnumberrequired

Package width in centimeters

packages[].dimensions.lengthnumberrequired

Package length in centimeters

packages[].dimensions.heightnumberrequired

Package height in centimeters

Request Body

The request body should be a JSON object containing the following structure:

{
  "packages": [
    {
      "quantity": <number>,
      "weight": <number>,
      "dimensions": {
        "width": <number>,
        "length": <number>,
        "height": <number>
      }
    }
  ],
  "originCity": "<string>",
  "destinationCity": "<string>"
}

Example Response

201
{
    "proposals": [
        {
            "id": "YURTICI_KARGO",
            "name": "Yurtiçi Kargo",
            "serviceType": "standard",
            "isValid": true,
            "deliveryTime": "1-3",
            "currency": "TRY",
            "price": 0,
            "kg": 5
        },
        {
            "id": "ARAS_KARGO",
            "name": "Aras Kargo",
            "serviceType": "standard",
            "isValid": true,
            "deliveryTime": "1-3",
            "currency": "TRY",
            "price": 0,
            "kg": 5
        }
    ],
    "chargeableWeight": 5
}

Responses

201Shipping proposals retrieved successfully
400Invalid request (missing or incorrect parameters)
401Unauthorized (invalid or missing token)
422Validation error (submitted data is not valid)
500Internal server error