Get Routes with OptimoRoute API

Pipedream makes it easy to connect APIs for OptimoRoute and 3,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Routes with the OptimoRoute API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Routes with the OptimoRoute API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Routes action
1. Connect your OptimoRoute account
2. Configure Date
3. Optional- Configure Driver External ID
4. Optional- Configure Driver Serial
5. Optional- Configure Vehicle Registration
6. Optional- Configure Include Route Polyline
7. Optional- Configure Include Route Start End
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Routes on OptimoRoute

Description:Get routes from Optimoroute. [See the documentation](https://optimoroute.com/api/#get-routes)

Version:0.0.1

Key:optimoroute-get-routes

View on GitHub

Code#

import optimoroute from "../../optimoroute.app.mjs";

export default {
  key: "optimoroute-get-routes",
  name: "Get Routes",
  description: "Get routes from Optimoroute. [See the documentation](https://optimoroute.com/api/#get-routes)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    optimoroute,
    date: {
      type: "string",
      label: "Date",
      description: "Queried date. YYYY-MM-DD format, for example `2013-12-20`",
    },
    driverExternalId: {
      type: "string",
      label: "Driver External ID",
      description: "Optionally filter by drivers external identifier",
      optional: true,
    },
    driverSerial: {
      type: "string",
      label: "Driver Serial",
      description: "Optionally filter by Serial number of the Driver",
      optional: true,
    },
    vehicleRegistration: {
      type: "string",
      label: "Vehicle Registration",
      description: "Optionally filter by Vehicle registration",
      optional: true,
    },
    includeRoutePolyline: {
      type: "boolean",
      label: "Include Route Polyline",
      description: "Optional property to include route polyline in the output",
      optional: true,
    },
    includeRouteStartEnd: {
      type: "boolean",
      label: "Include Route Start End",
      description: "Optional property to include the route's start and end locations in the output",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.optimoroute.getRoutes({
      $,
      params: {
        date: this.date,
        driverExternalId: this.driverExternalId,
        driverSerial: this.driverSerial,
        vehicleRegistration: this.vehicleRegistration,
        includeRoutePolyline: this.includeRoutePolyline,
        includeRouteStartEnd: this.includeRouteStartEnd,
      },
    });
    $.export("$summary", `Routes found: ${response.routes.length}`);
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
OptimoRoute	`optimoroute`	`app`	This component uses the OptimoRoute app.
Date	`date`	`string`	Queried date. YYYY-MM-DD format, for example `2013-12-20`
Driver External ID	`driverExternalId`	`string`	Optionally filter by drivers external identifier
Driver Serial	`driverSerial`	`string`	Optionally filter by Serial number of the Driver
Vehicle Registration	`vehicleRegistration`	`string`	Optionally filter by Vehicle registration
Include Route Polyline	`includeRoutePolyline`	`boolean`	Optional property to include route polyline in the output
Include Route Start End	`includeRouteStartEnd`	`boolean`	Optional property to include the route's start and end locations in the output