Search Orders 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

Search Orders 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 Search Orders with the OptimoRoute API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Search Orders action
1. Connect your OptimoRoute account
2. Configure From
3. Configure To
4. Optional- Configure Include Order Data
5. Optional- Configure Include Schedule Information
6. Optional- Configure After Tag
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.

Search Orders on OptimoRoute

Description:Search for orders in Optimoroute. [See the documentation](https://optimoroute.com/api/#search-orders)

Version:0.0.1

Key:optimoroute-search-orders

View on GitHub

Code#

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

export default {
  key: "optimoroute-search-orders",
  name: "Search Orders",
  description: "Search for orders in Optimoroute. [See the documentation](https://optimoroute.com/api/#search-orders)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    optimoroute,
    from: {
      type: "string",
      label: "From",
      description: "From date. YYYY-MM-DD format, for example `2013-12-20`. The range can span at most 35 days, i.e. 5 weeks",
    },
    to: {
      type: "string",
      label: "To",
      description: "To date. YYYY-MM-DD format, for example `2013-12-20`. The range can span at most 35 days, i.e. 5 weeks",
    },
    includeOrderData: {
      type: "boolean",
      label: "Include Order Data",
      description: "Include order data in the response",
      optional: true,
    },
    includeScheduleInformation: {
      type: "boolean",
      label: "Include Schedule Information",
      description: "Include schedule information in the response",
      optional: true,
    },
    afterTag: {
      propDefinition: [
        optimoroute,
        "afterTag",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.optimoroute.searchOrders({
      $,
      data: {
        dateRange: {
          from: this.from,
          to: this.to,
        },
        includeOrderData: this.includeOrderData,
        includeScheduleInformation: this.includeScheduleInformation,
        after_tag: this.afterTag,
      },
    });
    $.export("$summary", `Orders found: ${response?.orders?.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.
From	`from`	`string`	From date. YYYY-MM-DD format, for example `2013-12-20`. The range can span at most 35 days, i.e. 5 weeks
To	`to`	`string`	To date. YYYY-MM-DD format, for example `2013-12-20`. The range can span at most 35 days, i.e. 5 weeks
Include Order Data	`includeOrderData`	`boolean`	Include order data in the response
Include Schedule Information	`includeScheduleInformation`	`boolean`	Include schedule information in the response
After Tag	`afterTag`	`string`	Specify the after_tag to retrieve the next page of results from a previous call to this endpoint