Fleet Planner API Overview

Fleet Planner API manages and optimizes a fleet of vehicles or equipment to ensure efficient and cost-effective operations. Key responsibilities include aggregating, distributing and route optimization. Fleet planners play a crucial role in enhancing operational efficiency across various industries, including logistics, transportation, etc.

Why Fleet Planner API?

Fleet Planner is an essential need for a lot of logistical companies for efficiency and reducing costs prioritising the need to optimized solution. It is required to have focused deliverables and quantifying the exact amount of planned work via travel ETA and travel distance. Certain variations like optimization, time-bound allocations, fair work distribution, etc. allow to choose the style of work allocation keeping business needs in mind.

What can Fleet Planner API help with?

Fleet Planner helps to solve the problem of allocating work, distributing and finding an optimal path to accomplish the deliverables. This is quintessential in logistic services, food delivery services, courier services, etc. for planning.

How to use

Sample request:
curl --location --request POST "https://api.olamaps.io/routing/v1/fleetPlanner?strategy=fair&api_key=${your_api_key}" --header "X-Request-Id: XXX" --form "input=@data.json;type=application/json"
Input file schema:
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "packages": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "weightInGrams": {
              "type": "integer"
            },
            "loadingLocation": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number"
                },
                "lng": {
                  "type": "number"
                }
              },
              "required": ["lat", "lng"]
            },
            "loadingTimeInMinutes": {
              "type": "integer"
            }
          },
          "required": [
            "id",
            "weightInGrams",
            "loadingLocation",
            "loadingTimeInMinutes"
          ]
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "weightInGrams": {
              "type": "integer"
            },
            "loadingLocation": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number"
                },
                "lng": {
                  "type": "number"
                }
              },
              "required": ["lat", "lng"]
            },
            "loadingTimeInMinutes": {
              "type": "integer"
            }
          },
          "required": [
            "id",
            "weightInGrams",
            "loadingLocation",
            "loadingTimeInMinutes"
          ]
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "weightInGrams": {
              "type": "integer"
            },
            "loadingLocation": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number"
                },
                "lng": {
                  "type": "number"
                }
              },
              "required": ["lat", "lng"]
            },
            "unloadingLocation": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number"
                },
                "lng": {
                  "type": "number"
                }
              },
              "required": ["lat", "lng"]
            },
            "unloadingTimeInMinutes": {
              "type": "integer"
            },
            "loadingTimeInMinutes": {
              "type": "integer"
            }
          },
          "required": [
            "id",
            "weightInGrams",
            "loadingLocation",
            "unloadingLocation",
            "unloadingTimeInMinutes",
            "loadingTimeInMinutes"
          ]
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "weightInGrams": {
              "type": "integer"
            },
            "loadingLocation": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number"
                },
                "lng": {
                  "type": "number"
                }
              },
              "required": ["lat", "lng"]
            },
            "loadingTimeInMinutes": {
              "type": "integer"
            }
          },
          "required": [
            "id",
            "weightInGrams",
            "loadingLocation",
            "loadingTimeInMinutes"
          ]
        }
      ]
    },
    "vehicles": {
      "type": "array",
      "items": [
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "capacityInKG": {
              "type": "integer"
            },
            "startTime": {
              "type": "object",
              "properties": {
                "hour": {
                  "type": "integer"
                },
                "minutes": {
                  "type": "integer"
                }
              },
              "required": ["hour", "minutes"]
            },
            "endTime": {
              "type": "object",
              "properties": {
                "hour": {
                  "type": "integer"
                },
                "minutes": {
                  "type": "integer"
                }
              },
              "required": ["hour", "minutes"]
            },
            "startLocation": {
              "type": "object",
              "properties": {
                "lat": {
                  "type": "number"
                },
                "lng": {
                  "type": "number"
                }
              },
              "required": ["lat", "lng"]
            }
          },
          "required": [
            "id",
            "capacityInKG",
            "startTime",
            "endTime",
            "startLocation"
          ]
        },
        {
          "type": "object",
          "properties": {
            "id": {
              "type": "string"
            },
            "capacityInKG": {
              "type": "integer"
            }
          },
          "required": ["id", "capacityInKG"]
        }
      ]
    },
    "globalStartLocation": {
      "type": "object",
      "properties": {
        "lat": {
          "type": "number"
        },
        "lng": {
          "type": "number"
        }
      },
      "required": ["lat", "lng"]
    }
  },
  "required": ["packages", "vehicles"]
}

The input file comprises of 2 types - Vehicle and Package.

Vehicle attributes:
1. id: A unique identifier to represent a vehicle. Only alphanumeric characters allowed, no special characters allowed. (required, datatype : string)
2. capacityInKG: Loading capacity of the vehicle in Kilograms (required, datatype : number)
3. startTime: Needed if a vehicle has working hours. Represents duty start time. Comprises of hour and minutes. Hour required to be in 24 hours format (optional)
4. endTime: Needed if a vehicle has working hours. Represents duty end time. Comprises of hour and minutes. Hour required to be in 24 hours format (optional)

Package attributes:
1. id: A unique identifier to represent a package. Only alphanumeric characters allowed, no special characters allowed. (required, datatype : string)
2. weightInGrams: Loading capacity of the package in Grams (required, datatype : number)
3. loadingLocation: Location of package pickup. Comprises of lat (latitude) and lng (longitude)
4. unloadingLocation: Location of package drop. Comprises of lat (latitude) and lng (longitude)
5. loadingTimeInMinutes: Time in minutes required to load a package in the vehicle (optional, datatype : number)
6. unloadingTimeInMinutes: Time in minutes required to unload a package in the vehicle (optional, datatype : number)
Sample input file:
{
  "packages": [
    {
      "id": "package1",
      "weightInGrams": 2000,
      "loadingLocation": {
        "lat": 12.988063387888786,
        "lng": 77.55078360931566
      },
      "loadingTimeInMinutes": 0
    },
    {
      "id": "package2",
      "weightInGrams": 1500,
      "loadingLocation": {
        "lat": 12.788063387888785,
        "lng": 77.95078360931566
      },
      "loadingTimeInMinutes": 0
    },
    {
      "id": "package3",
      "weightInGrams": 1200,
      "loadingLocation": {
        "lat": 13.050973936977373,
        "lng": 77.54251919913526
      },
      "unloadingLocation": {
        "lat": 12.958624721413775,
        "lng": 77.59886345950845
      },
      "unloadingTimeInMinutes": 0,
      "loadingTimeInMinutes": 0
    }
  ],
  "vehicles": [
    {
      "id": "MHXXAAYYYY",
      "capacityInKG": 2,
      "startTime": {
        "hour": 11,
        "minutes": 0
      },
      "endTime": {
        "hour": 12,
        "minutes": 25
      }
    },
    {
      "id": "MHXXBBYYYY",
      "capacityInKG": 2
    }
  ]
}

Please refer to theAPI documentationfor further details.