Container | Truck | Dry Run | Climes API

---

Logistics Freights API's are useful to calculate the truecost value of a single shipment having multiple factors.

Request Parameters

Endpoint

/v3/logistics/freight

Method

POST

Headers

{
    'x-api-key': 'API_KEY',
    'Content-Type': 'application/json'
}

Payload

{
  "configs": {
    "region": "IN",
    "transportation_type": "truck"
  },
  "queries": {
    "legs": [
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": true
      },
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": false
      }
    ]
  }
}

Response Parameters

Status Code

200

Response Data

The response will contain the truecost values in tonnes CO2e for each shipping_method as per the request order respectively.

{
    "message": "Truecost calculated successfully",
    "truecost": {
        "total_truecost": 2677,
        "legs": [
            1141,
            1536
        ],
        "equivalents": {
            "trash_collected": "113773",
            "trees_planted": "44171",
            "lamps_collected": "101458"
        }
    }
}

caution

The error message is for your information, not the end users.
Please use the status codes and communicate the error to user accordingly
The API returns the first validation error that is encountered even if there are multiple errors with the request

tip

Here the response will be in the same order as the request values.

Sample Request

cURL

curl --location --request POST 'BASE_URL/logistics/freight'  
--header 'x-api-key: API_KEY'  
--header 'Content-Type: application/json'  
--data-raw '{
  "configs": {
    "region": "IN",
    "transportation_type": "truck"
  },
  "queries": {
    "legs": [
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": true
      },
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": false
      }
    ]
  }
}'

NodeJs

const fetch = require('node-fetch');

const url = 'BASE_URL/logistics/freight';
const apiKey = 'API_KEY';

const headers = {
  'x-api-key': apiKey,
  'Content-Type': 'application/json'
};

const body = JSON.stringify({
  configs: {
    region: 'IN',
    transportation_type: 'truck'
  },
  queries: {
    legs: [
      {
        shipping_method: 'container',
        weight: 14125,
        distance: 2200,
        container_type: '22UP',
        dry_run: true
      },
      {
        shipping_method: 'container',
        weight: 14125,
        distance: 2200,
        container_type: '22UP',
        dry_run: false
      }
    ]
  }
});

const options = {
  method: 'POST',
  headers: headers,
  body: body
};

fetch(url, options)
  .then(response => response.text())
  .then(data => {
    console.log(data);
  })
  .catch(error => {
    console.error('Error:', error);
  });

Axios

var axios = require('axios');

var data = JSON.stringify({
  "configs": {
    "region": "IN",
    "transportation_type": "truck"
  },
  "queries": {
    "legs": [
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": true
      },
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": false
      }
    ]
  }
});

var config = {
  method: 'post',
  url: 'BASE_URL/logistics/freight',
  headers: { 
    'x-api-key': 'API_KEY', 
    'Content-Type': 'application/json'
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

Python

import requests
import json

url = "BASE_URL/logistics/freight"

payload = json.dumps({
  "configs": {
    "region": "IN",
    "transportation_type": "truck"
  },
  "queries": {
    "legs": [
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": True
      },
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": False
      }
    ]
  }
})
headers = {
  'x-api-key': 'API_KEY',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Php

<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();

$request->setUrl('BASE_URL/logistics/freight');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'x-api-key' => 'API_KEY',
  'Content-Type' => 'application/json'
));
$request->setBody('{
  "configs": {
    "region": "IN",
    "transportation_type": "truck"
  },
  "queries": {
    "legs": [
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": true
      },
      {
        "shipping_method": "container",
        "weight": 14125,
        "distance": 2200,
        "container_type": "22UP",
        "dry_run": false
      }
    ]
  }
}');

try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}

Sample Response

Below are sample responses for the above request.

Responses

Success - 200

{
  "message": "Truecost calculated successfully",
  "truecost": {
    "total_truecost": 2677,
    "legs": [
      1141,
      1536
    ],
    "equivalents": {
      "trash_collected": "113773",
      "trees_planted": "44171",
      "lamps_collected": "101458"
    }
  }
}

Failure - 400

{
  "message": "Bad Request! Please send all the variables properly."
}

Failure - 500

{
  "message": "Server Error! Failed to get Logistics Truecost."
}