Fetch Order Items with Mews API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Mews, Pipedream and 2,900+ other apps remarkably fast.

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Fetch Order Items with the Mews 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#

This integration creates a workflow with a Pipedream trigger and Mews action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
Configure the Fetch Order Items action
1. Connect your Mews account
2. Optional- Configure Created Start (UTC)
3. Optional- Configure Created End (UTC)
4. Optional- Configure Updated Start (UTC)
5. Optional- Configure Updated End (UTC)
6. Optional- Configure Consumed Start (UTC)
7. Optional- Configure Consumed End (UTC)
8. Optional- Configure Canceled Start (UTC)
9. Optional- Configure Canceled End (UTC)
10. Optional- Configure Closed Start (UTC)
11. Optional- Configure Closed End (UTC)
12. Optional- Select one or more Enterprise IDs
13. Optional- Select one or more Order Item IDs
14. Select a Account Type
15. Optional- Select one or more Account IDs
16. Optional- Select one or more Service Order IDs
17. Optional- Select one or more Service IDs
18. Optional- Select one or more Bill IDs
19. Optional- Configure Currency
20. Optional- Select one or more Accounting States
21. Optional- Select one or more Types
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are 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.

Trigger#

New Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

Trigger 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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

Pipedream uses API keys for authentication. When you connect your Pipedream account, Pipedream securely stores the keys so you can easily authenticate to Pipedream APIs in both code and no-code steps.

About Pipedream#

Integration platform for developers

Action#

Fetch Order Items on Mews

Description:Retrieve order items using Mews Connector API. [See the documentation](https://mews-systems.gitbook.io/connector-api/operations/orderitems#get-all-order-items)

Version:0.0.3

Key:mews-fetch-order-items

View on GitHub

Mews Overview#

The Mews API is a gateway for developers to interact with the Mews hospitality platform, allowing for innovative connections and automations between hotel management systems and other software tools. By using Pipedream, you can create custom workflows that automate repetitive tasks, integrate with numerous third-party services, and manipulate data to suit specific needs within the hospitality industry. The combination of Mews' API and Pipedream's serverless execution model paves the way for enhanced guest experiences, optimized operations, and real-time data handling.

Action Code#

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

export default {
  name: "Fetch Order Items",
  description: "Retrieve order items using Mews Connector API. [See the documentation](https://mews-systems.gitbook.io/connector-api/operations/orderitems#get-all-order-items)",
  key: "mews-fetch-order-items",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    createdStartUtc: {
      description: "Start of the interval in which Order item was created. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`",
      propDefinition: [
        app,
        "createdStartUtc",
      ],
    },
    createdEndUtc: {
      description: "End of the interval in which Order item was created. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`",
      propDefinition: [
        app,
        "createdEndUtc",
      ],
    },
    updatedStartUtc: {
      description: "Start of the interval in which Order item was updated. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`",
      propDefinition: [
        app,
        "updatedStartUtc",
      ],
    },
    updatedEndUtc: {
      description: "End of the interval in which Order item was updated. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`",
      propDefinition: [
        app,
        "updatedEndUtc",
      ],
    },
    consumedStartUtc: {
      type: "string",
      label: "Consumed Start (UTC)",
      description: "Start of the interval in which Order item was consumed. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`",
      optional: true,
    },
    consumedEndUtc: {
      type: "string",
      label: "Consumed End (UTC)",
      description: "End of the interval in which Order item was consumed. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`",
      optional: true,
    },
    canceledStartUtc: {
      type: "string",
      label: "Canceled Start (UTC)",
      description: "Start of the interval in which Order item was canceled. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`",
      optional: true,
    },
    canceledEndUtc: {
      type: "string",
      label: "Canceled End (UTC)",
      description: "End of the interval in which Order item was canceled. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`",
      optional: true,
    },
    closedStartUtc: {
      type: "string",
      label: "Closed Start (UTC)",
      description: "Start of the interval in which Order item was closed. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`",
      optional: true,
    },
    closedEndUtc: {
      type: "string",
      label: "Closed End (UTC)",
      description: "End of the interval in which Order item was closed. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`",
      optional: true,
    },
    enterpriseIds: {
      propDefinition: [
        app,
        "enterpriseIds",
      ],
    },
    orderItemIds: {
      propDefinition: [
        app,
        "orderItemIds",
      ],
    },
    accountType: {
      propDefinition: [
        app,
        "accountType",
      ],
    },
    accountIds: {
      type: "string[]",
      label: "Account IDs",
      description: "Unique identifiers of specific Accounts to which the order items belong to. Required if no other filter is provided. Max 100 items.",
      optional: true,
      propDefinition: [
        app,
        "accountId",
        ({ accountType }) => ({
          accountType,
        }),
      ],
    },
    serviceOrderIds: {
      type: "string[]",
      label: "Service Order IDs",
      description: "Unique identifiers of the service orders (product service orders or reservations). Required if no other filter is provided. Max 1000 items.",
      optional: true,
      propDefinition: [
        app,
        "reservationId",
      ],
    },
    serviceIds: {
      type: "string[]",
      label: "Service IDs",
      description: "Unique identifiers of the Services. Required if no other filter is provided. Max 1000 items.",
      optional: true,
      propDefinition: [
        app,
        "serviceId",
      ],
    },
    billIds: {
      type: "string[]",
      label: "Bill IDs",
      description: "Unique identifiers of the Bills to which order item is assigned. Required if no other filter is provided. Max 1000 items.",
      optional: true,
      propDefinition: [
        app,
        "billId",
      ],
    },
    currency: {
      type: "string",
      label: "Currency",
      description: "ISO-4217 code of the Currency the item costs should be converted to.",
      optional: true,
    },
    accountingStates: {
      type: "string[]",
      label: "Accounting States",
      description: "Accounting state of the item. Max 1000 items.",
      optional: true,
      options: [
        "Open",
        "Closed",
        "Deferred",
        "Canceled",
      ],
    },
    types: {
      type: "string[]",
      label: "Types",
      description: "Order item type, e.g. whether product order or space order. Max 1000 items.",
      optional: true,
      options: [
        "ProductOrder",
        "SpaceOrder",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      createdStartUtc,
      createdEndUtc,
      updatedStartUtc,
      updatedEndUtc,
      consumedStartUtc,
      consumedEndUtc,
      canceledStartUtc,
      canceledEndUtc,
      closedStartUtc,
      closedEndUtc,
      enterpriseIds,
      orderItemIds,
      accountIds,
      serviceOrderIds,
      serviceIds,
      billIds,
      currency,
      accountingStates,
      types,
    } = this;

    const items = await app.paginate({
      requester: app.orderItemsGetAll,
      requesterArgs: {
        $,
        data: {
          ...(createdStartUtc || createdEndUtc) && {
            CreatedUtc: {
              StartUtc: createdStartUtc,
              EndUtc: createdEndUtc,
            },
          },
          ...(updatedStartUtc || updatedEndUtc) && {
            UpdatedUtc: {
              StartUtc: updatedStartUtc,
              EndUtc: updatedEndUtc,
            },
          },
          ...(consumedStartUtc || consumedEndUtc) && {
            ConsumedUtc: {
              StartUtc: consumedStartUtc,
              EndUtc: consumedEndUtc,
            },
          },
          ...(canceledStartUtc || canceledEndUtc) && {
            CanceledUtc: {
              StartUtc: canceledStartUtc,
              EndUtc: canceledEndUtc,
            },
          },
          ...(closedStartUtc || closedEndUtc) && {
            ClosedUtc: {
              StartUtc: closedStartUtc,
              EndUtc: closedEndUtc,
            },
          },
          EnterpriseIds: enterpriseIds,
          OrderItemIds: orderItemIds,
          AccountIds: accountIds,
          ServiceOrderIds: serviceOrderIds,
          ServiceIds: serviceIds,
          BillIds: billIds,
          Currency: currency,
          AccountingStates: accountingStates,
          Types: types,
        },
      },
      resultKey: "OrderItems",
    });

    $.export("$summary", `Successfully fetched ${items.length} order item${items.length !== 1
      ? "s"
      : ""}`);
    return items;
  },
};

Action Configuration#

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

Label	Prop	Type	Description
Mews	`app`	`app`	This component uses the Mews app.
Created Start (UTC)	`createdStartUtc`	`string`	Start of the interval in which Order item was created. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`
Created End (UTC)	`createdEndUtc`	`string`	End of the interval in which Order item was created. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`
Updated Start (UTC)	`updatedStartUtc`	`string`	Start of the interval in which Order item was updated. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`
Updated End (UTC)	`updatedEndUtc`	`string`	End of the interval in which Order item was updated. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`
Consumed Start (UTC)	`consumedStartUtc`	`string`	Start of the interval in which Order item was consumed. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`
Consumed End (UTC)	`consumedEndUtc`	`string`	End of the interval in which Order item was consumed. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`
Canceled Start (UTC)	`canceledStartUtc`	`string`	Start of the interval in which Order item was canceled. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`
Canceled End (UTC)	`canceledEndUtc`	`string`	End of the interval in which Order item was canceled. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`
Closed Start (UTC)	`closedStartUtc`	`string`	Start of the interval in which Order item was closed. ISO 8601 format. Eg. `2025-01-01T00:00:00Z`
Closed End (UTC)	`closedEndUtc`	`string`	End of the interval in which Order item was closed. ISO 8601 format. Max 3 months interval. Eg. `2025-01-01T00:00:00Z`
Enterprise IDs	`enterpriseIds`	`string[]`	Select a value from the drop down menu.
Order Item IDs	`orderItemIds`	`string[]`	Select a value from the drop down menu.
Account Type	`accountType`	`string`	Select a value from the drop down menu:`customercompany`
Account IDs	`accountIds`	`string[]`	Select a value from the drop down menu.
Service Order IDs	`serviceOrderIds`	`string[]`	Select a value from the drop down menu.
Service IDs	`serviceIds`	`string[]`	Select a value from the drop down menu.
Bill IDs	`billIds`	`string[]`	Select a value from the drop down menu.
Currency	`currency`	`string`	ISO-4217 code of the Currency the item costs should be converted to.
Accounting States	`accountingStates`	`string[]`	Select a value from the drop down menu:`OpenClosedDeferredCanceled`
Types	`types`	`string[]`	Select a value from the drop down menu:`ProductOrderSpaceOrder`

Fetch Order Items with Mews API on New Scheduled Tasks from Pipedream API

Pipedream makes it easy to connect APIs for Mews, Pipedream and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular