Get Orders with PlentyONE API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream API

Next, do this

Get Orders with the PlentyONE 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 PlentyONE 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 Get Orders action
1. Connect your PlentyONE account
2. Optional- Select a Order Type ID
3. Optional- Select a Contact ID
4. Optional- Configure Contact Data
5. Optional- Configure Referrer ID
6. Optional- Configure Shipping Profile ID
7. Optional- Configure Shipping Service Provider ID
8. Optional- Configure Owner User ID
9. Optional- Configure Warehouse ID
10. Optional- Configure Is eBay Plus
11. Optional- Configure Included Variation
12. Optional- Configure Included Item
13. Optional- Select one or more Order IDs
14. Optional- Select a Country ID
15. Optional- Configure Order Item Name
16. Optional- Configure Variation Number
17. Optional- Configure Package Number
18. Optional- Configure External Order ID
19. Optional- Configure Client ID
20. Optional- Select a Payment Status
21. Optional- Configure Payment Method ID
22. Optional- Select one or more With
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#

Get Orders on PlentyONE

Description:Retrieves a list of orders from PlentyONE. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/get_rest_orders)

Version:0.0.2

Key:plentyone-get-orders

View on GitHub

Action Code#

import {
  ORDER_TYPE_OPTIONS,
  ORDER_WITH_OPTIONS,
  PAYMENT_STATUS_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import plentyone from "../../plentyone.app.mjs";

export default {
  key: "plentyone-get-orders",
  name: "Get Orders",
  description: "Retrieves a list of orders from PlentyONE. [See the documentation](https://developers.plentymarkets.com/en-gb/plentymarkets-rest-api/index.html#/Order/get_rest_orders)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    plentyone,
    typeID: {
      type: "integer",
      label: "Order Type ID",
      description: "Type of order to retrieve. If not provided, all order types will be retrieved.",
      options: ORDER_TYPE_OPTIONS,
      optional: true,
    },
    contactId: {
      propDefinition: [
        plentyone,
        "contactId",
      ],
      optional: true,
    },
    contactData: {
      type: "string",
      label: "Contact Data",
      description: "Filter that restricts the search result to orders with a specific contact data.",
      optional: true,
    },
    referrerId: {
      type: "integer",
      label: "Referrer ID",
      description: "Filter that restricts the search result to orders of a specific order referrer. The ID of the order referrer must be specified.",
      optional: true,
    },
    shippingProfileId: {
      type: "integer",
      label: "Shipping Profile ID",
      description: "Filter that restricts the search result to orders with a specific shipping profile. The ID of shipping profile must be specified.",
      optional: true,
    },
    shippingServiceProviderId: {
      type: "integer",
      label: "Shipping Service Provider ID",
      description: "Filter that restricts the search result to orders with a specific shipping service provider (like DHL, UPS, etc.). The ID of shipping service provider must be specified.",
      optional: true,
    },
    ownerUserId: {
      type: "integer",
      label: "Owner User ID",
      description: "Filter that restricts the search result to orders with a specific owner. The user ID of the owner must be specified.",
      optional: true,
    },
    warehouseId: {
      type: "integer",
      label: "Warehouse ID",
      description: "Filter that restricts the search result to orders with a specific main warehouse. The ID of the warehouse must be specified.",
      optional: true,
    },
    isEbayPlus: {
      type: "boolean",
      label: "Is eBay Plus",
      description: "Filter that restricts the search result to orders with the referrer eBay PLUS.",
      optional: true,
    },
    includedVariation: {
      type: "integer",
      label: "Included Variation",
      description: "Filter that restricts the search result to orders including a specific variation. The ID of the variation must be specified.",
      optional: true,
    },
    includedItem: {
      type: "integer",
      label: "Included Item",
      description: "Filter that restricts the search result to orders including a specific item. The ID of the item must be specified.",
      optional: true,
    },
    orderIds: {
      propDefinition: [
        plentyone,
        "orderId",
      ],
      type: "string[]",
      label: "Order IDs",
      description: "Filter that restricts the search result to orders with a specific ID.",
      optional: true,
    },
    countryId: {
      propDefinition: [
        plentyone,
        "countryId",
      ],
      optional: true,
    },
    orderItemName: {
      type: "string",
      label: "Order Item Name",
      description: "Filter that restricts the search result to orders including a specific item name. The name of the item must be specified.",
      optional: true,
    },
    variationNumber: {
      type: "integer",
      label: "Variation Number",
      description: "Filter that restricts the search result to orders including a specific variation number. The number of the variation must be specified.",
      optional: true,
    },
    packageNumber: {
      type: "string",
      label: "Package Number",
      description: "Filter that restricts the search result to orders including a specific package number. The number of the package must be specified.",
      optional: true,
    },
    externalOrderId: {
      type: "string",
      label: "External Order ID",
      description: "Filter that restricts the search result to orders including a specific external order ID. The external order ID must be specified.",
      optional: true,
    },
    clientId: {
      type: "integer",
      label: "Client ID",
      description: "Filter that restricts the search result to orders belonging to a specific client. The ID of the client must be specified.",
      optional: true,
    },
    paymentStatus: {
      type: "string",
      label: "Payment Status",
      description: "Filter that restricts the search result to orders with a specific payment status.",
      options: PAYMENT_STATUS_OPTIONS,
      optional: true,
    },
    paymentMethodId: {
      type: "integer",
      label: "Payment Method ID",
      description: "Filter that restricts the search result to orders with a specific payment method. The ID of the payment method must be specified.",
      optional: true,
    },
    with: {
      type: "string[]",
      label: "With",
      description: "Load additional relations for an order.",
      options: ORDER_WITH_OPTIONS,
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const response = await this.plentyone.getOrders({
        $,
        params: {
          typeID: this.typeID,
          contactId: this.contactId,
          contactData: this.contactData,
          referrerId: this.referrerId,
          shippingProfileId: this.shippingProfileId,
          shippingServiceProviderId: this.shippingServiceProviderId,
          ownerUserId: this.ownerUserId,
          warehouseId: this.warehouseId,
          isEbayPlus: this.isEbayPlus,
          includedVariation: this.includedVariation,
          includedItem: this.includedItem,
          orderIds: parseObject(this.orderIds),
          countryId: this.countryId,
          orderItemName: this.orderItemName,
          variationNumber: this.variationNumber,
          packageNumber: this.packageNumber,
          externalOrderId: this.externalOrderId,
          clientId: this.clientId,
          paymentStatus: this.paymentStatus,
          paymentMethodId: this.paymentMethodId,
          with: parseObject(this.with),
        },
      });

      $.export("$summary", `Successfully retrieved ${response.data?.length || 0} orders`);
      return response;
    } catch (error) {
      $.export("$summary", "Successfully retrieved 0 orders");
      return {};
    }
  },
};

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
PlentyONE	`plentyone`	`app`	This component uses the PlentyONE app.
Order Type ID	`typeID`	`integer`	Select a value from the drop down menu:`{ "label": "Sales order", "value": 1 }{ "label": "Delivery", "value": 2 }{ "label": "Returns", "value": 3 }{ "label": "Credit note", "value": 4 }{ "label": "Warranty", "value": 5 }{ "label": "Repair", "value": 6 }{ "label": "Offer", "value": 7 }{ "label": "Advance order", "value": 8 }{ "label": "Multi-order", "value": 9 }{ "label": "Multi credit note", "value": 10 }{ "label": "Multi delivery", "value": 11 }{ "label": "Reorder", "value": 12 }{ "label": "Partial delivery", "value": 13 }{ "label": "Subscription", "value": 14 }{ "label": "Redistribution", "value": 15 }`
Contact ID	`contactId`	`string`	Select a value from the drop down menu.
Contact Data	`contactData`	`string`	Filter that restricts the search result to orders with a specific contact data.
Referrer ID	`referrerId`	`integer`	Filter that restricts the search result to orders of a specific order referrer. The ID of the order referrer must be specified.
Shipping Profile ID	`shippingProfileId`	`integer`	Filter that restricts the search result to orders with a specific shipping profile. The ID of shipping profile must be specified.
Shipping Service Provider ID	`shippingServiceProviderId`	`integer`	Filter that restricts the search result to orders with a specific shipping service provider (like DHL, UPS, etc.). The ID of shipping service provider must be specified.
Owner User ID	`ownerUserId`	`integer`	Filter that restricts the search result to orders with a specific owner. The user ID of the owner must be specified.
Warehouse ID	`warehouseId`	`integer`	Filter that restricts the search result to orders with a specific main warehouse. The ID of the warehouse must be specified.
Is eBay Plus	`isEbayPlus`	`boolean`	Filter that restricts the search result to orders with the referrer eBay PLUS.
Included Variation	`includedVariation`	`integer`	Filter that restricts the search result to orders including a specific variation. The ID of the variation must be specified.
Included Item	`includedItem`	`integer`	Filter that restricts the search result to orders including a specific item. The ID of the item must be specified.
Order IDs	`orderIds`	`string[]`	Select a value from the drop down menu.
Country ID	`countryId`	`integer`	Select a value from the drop down menu.
Order Item Name	`orderItemName`	`string`	Filter that restricts the search result to orders including a specific item name. The name of the item must be specified.
Variation Number	`variationNumber`	`integer`	Filter that restricts the search result to orders including a specific variation number. The number of the variation must be specified.
Package Number	`packageNumber`	`string`	Filter that restricts the search result to orders including a specific package number. The number of the package must be specified.
External Order ID	`externalOrderId`	`string`	Filter that restricts the search result to orders including a specific external order ID. The external order ID must be specified.
Client ID	`clientId`	`integer`	Filter that restricts the search result to orders belonging to a specific client. The ID of the client must be specified.
Payment Status	`paymentStatus`	`string`	Select a value from the drop down menu:`{ "label": "Unpaid", "value": "unpaid" }{ "label": "Partly paid", "value": "partlyPaid" }{ "label": "Fully paid", "value": "fullyPaid" }{ "label": "Overpaid", "value": "overpaid" }`
Payment Method ID	`paymentMethodId`	`integer`	Filter that restricts the search result to orders with a specific payment method. The ID of the payment method must be specified.
With	`with`	`string[]`	Select a value from the drop down menu:`{ "label": "Addresses - The address objects that are associated with the order.", "value": "addresses" }{ "label": "Relations - The order relation reference instances that are associated with the order. These instances contain information such as the the reference type, the ID of the reference and the relation itself.", "value": "relations" }{ "label": "Comments - The order comments.", "value": "comments" }{ "label": "Location - The accounting location of the order.", "value": "location" }{ "label": "Payments - The payments that are associated with the order.", "value": "payments" }{ "label": "Documents - The documents that are associated with the order.", "value": "documents" }{ "label": "Contact Sender - The associated contact for the contact-sender relation.", "value": "contactSender" }{ "label": "Contact Receiver - The associated contact for the contact-receiver relation.", "value": "contactReceiver" }{ "label": "Warehouse Sender - The associated warehouse for the warehouse-sender relation.", "value": "warehouseSender" }{ "label": "Warehouse Receiver - The associated warehouse for the warehouse-receiver relation.", "value": "warehouseReceiver" }{ "label": "Order Items Variation - The variation that is associated with the order item.", "value": "orderItems.variation" }{ "label": "Order Items Variation Properties - The properties belonging to the variation.", "value": "orderItems.variation.propertiesV2" }{ "label": "Order Items Gift Card Codes - The gift card codes that are associated with the order item.", "value": "orderItems.giftCardCodes" }{ "label": "Order Items Transactions - The transactions that are associated with the order item.", "value": "orderItems.transactions" }{ "label": "Order Items Serial Numbers - The serial numbers that are associated with the order item.", "value": "orderItems.serialNumbers" }{ "label": "Order Items Variation Barcodes - The barcodes that are associated with variation of the order item.", "value": "orderItems.variationBarcodes" }{ "label": "Order Items Comments - The comments that are associated with the order item.", "value": "orderItems.comments" }{ "label": "Origin Order References - The references to other orders, e.g. returns or credit notes, associated with this order.", "value": "originOrderReferences" }{ "label": "Shipping Packages - The shipping packages that are associated with the order.", "value": "shippingPackages" }{ "label": "Shipping Packages Items - The orderPackageItems associated with the package.", "value": "shippingPackages.items" }{ "label": "Shipping Information - The shipping information for the order.", "value": "shippingInformation" }{ "label": "Payment Terms - The payment terms that are associated with the order.", "value": "paymentTerms" }{ "label": "Order Items Warehouse Locations - The warehouse locations that are associated with the order item.", "value": "orderItems.warehouseLocations" }`

Action Authentication#

PlentyONE uses OAuth authentication. When you connect your PlentyONE account, Pipedream will open a popup window where you can sign into PlentyONE and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any PlentyONE API.

Pipedream requests the following authorization scopes when you connect your account:

Try it

Add Order Note with PlentyONE API on New Scheduled Tasks from Pipedream API

Pipedream + PlentyONE

Try it

Get Order with PlentyONE API on New Scheduled Tasks from Pipedream API

Pipedream + PlentyONE

Try it

Get Order Properties with PlentyONE API on New Scheduled Tasks from Pipedream API

Pipedream + PlentyONE

Try it

Get Order Documents with PlentyONE API on New Scheduled Tasks from Pipedream API

Pipedream + PlentyONE

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

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

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it