Create Picqer Order with Picqer API on New Column from MySQL API

Pipedream makes it easy to connect APIs for Picqer, MySQL and 2,700+ other apps remarkably fast.

Trigger workflow on

New Column from the MySQL API

Next, do this

Create Picqer Order with the Picqer 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 MySQL trigger and Picqer action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Column trigger
1. Connect your MySQL account
2. Configure timer
3. Select a Table
Configure the Create Picqer Order action
1. Connect your Picqer account
2. Optional- Select a Customer ID
3. Optional- Select a Template Id
4. Optional- Select a Shipping Provider Id
5. Configure Delivery Name
6. Optional- Configure Delivery Contact Name
7. Optional- Configure Delivery Address
8. Optional- Configure Delivery Address 2
9. Optional- Configure Delivery Zipcode
10. Optional- Configure Delivery City
11. Optional- Configure Delivery Region
12. Configure Delivery Country
13. Optional- Configure Invoice Name
14. Optional- Configure Invoice Contact Name
15. Optional- Configure Invoice Address
16. Optional- Configure Invoice Address 2
17. Optional- Configure Invoice Zipcode
18. Optional- Configure Invoice City
19. Optional- Configure Invoice Region
20. Configure Invoice Country
21. Optional- Configure Telephone
22. Optional- Configure Email Address
23. Optional- Configure Reference
24. Optional- Configure Customer Remarks
25. Optional- Configure Partial Delivery
26. Optional- Configure Discount
27. Optional- Configure Invoiced
28. Optional- Configure Preferred Delivery Date
29. Optional- Select a Language
30. Optional- Configure Products
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 Column on MySQL

Description:Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)

Version:2.0.5

Key:mysql-new-column

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

import common from "../common/table.mjs";

export default {
  ...common,
  key: "mysql-new-column",
  name: "New Column",
  description: "Emit new event when you add a new column to a table. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/show-columns.html)",
  type: "source",
  version: "2.0.5",
  dedupe: "unique",
  props: {
    ...common.props,
    db: "$.service.db",
  },
  methods: {
    ...common.methods,
    _getPreviousColumns() {
      return this.db.get("previousColumns");
    },
    _setPreviousColumns(previousColumns) {
      this.db.set("previousColumns", previousColumns);
    },
    async listResults() {
      const { table } = this;
      let previousColumns = this._getPreviousColumns() || [];
      const columns = await this.mysql.listNewColumns({
        table,
        previousColumns,
      });
      this.iterateAndEmitEvents(columns);

      const newColumnNames =
        columns
          .map((column) => column.Field)
          .filter((c) => !previousColumns.includes(c));

      previousColumns = previousColumns.concat(newColumnNames);
      this._setPreviousColumns(previousColumns);
    },
    generateMeta(column) {
      const columnName = column.Field;
      return {
        id: `${columnName}${this.table}`,
        summary: columnName,
        ts: Date.now(),
      };
    },
  },
};

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
MySQL	`mysql`	`app`	This component uses the MySQL app.
	`timer`	`$.interface.timer`
Table	`table`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs

SSL Setup

Configure SSL on your MySQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications

About MySQL#

MySQL is an open-source relational database management system.

Action#

Create Picqer Order on Picqer

Description:Create a new order in Picqer. [See the documentation](https://picqer.com/en/api/orders)

Version:0.0.1

Key:picqer-create-order

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { LANGUAGE_OPTIONS } from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import picqer from "../../picqer.app.mjs";

export default {
  key: "picqer-create-order",
  name: "Create Picqer Order",
  description: "Create a new order in Picqer. [See the documentation](https://picqer.com/en/api/orders)",
  version: "0.0.1",
  type: "action",
  props: {
    picqer,
    customerId: {
      propDefinition: [
        picqer,
        "customerId",
      ],
      reloadProps: true,
      optional: true,
    },
    templateId: {
      propDefinition: [
        picqer,
        "templateId",
      ],
      optional: true,
    },
    shippingProviderId: {
      propDefinition: [
        picqer,
        "shippingProviderId",
      ],
      optional: true,
    },
    deliveryName: {
      propDefinition: [
        picqer,
        "deliveryName",
      ],
      hidden: true,
    },
    deliveryContactName: {
      propDefinition: [
        picqer,
        "deliveryContactName",
      ],
      optional: true,
      hidden: true,
    },
    deliveryAddress: {
      propDefinition: [
        picqer,
        "deliveryAddress",
      ],
      optional: true,
      hidden: true,
    },
    deliveryAddress2: {
      propDefinition: [
        picqer,
        "deliveryAddress2",
      ],
      optional: true,
      hidden: true,
    },
    deliveryZipcode: {
      propDefinition: [
        picqer,
        "deliveryZipcode",
      ],
      optional: true,
      hidden: true,
    },
    deliveryCity: {
      propDefinition: [
        picqer,
        "deliveryCity",
      ],
      optional: true,
      hidden: true,
    },
    deliveryRegion: {
      propDefinition: [
        picqer,
        "deliveryRegion",
      ],
      optional: true,
      hidden: true,
    },
    deliveryCountry: {
      propDefinition: [
        picqer,
        "deliveryCountry",
      ],
      hidden: true,
    },
    invoiceName: {
      propDefinition: [
        picqer,
        "invoiceName",
      ],
      optional: true,
      hidden: true,
    },
    invoiceContactName: {
      propDefinition: [
        picqer,
        "invoiceContactName",
      ],
      optional: true,
      hidden: true,
    },
    invoiceAddress: {
      propDefinition: [
        picqer,
        "invoiceAddress",
      ],
      optional: true,
      hidden: true,
    },
    invoiceAddress2: {
      propDefinition: [
        picqer,
        "invoiceAddress2",
      ],
      optional: true,
      hidden: true,
    },
    invoiceZipcode: {
      propDefinition: [
        picqer,
        "invoiceZipcode",
      ],
      optional: true,
      hidden: true,
    },
    invoiceCity: {
      propDefinition: [
        picqer,
        "invoiceCity",
      ],
      optional: true,
      hidden: true,
    },
    invoiceRegion: {
      propDefinition: [
        picqer,
        "invoiceRegion",
      ],
      optional: true,
      hidden: true,
    },
    invoiceCountry: {
      propDefinition: [
        picqer,
        "invoiceCountry",
      ],
      description: "Country of invoice address (needs to be ISO 3166 2-char code).",
      hidden: true,
    },
    telephone: {
      propDefinition: [
        picqer,
        "telephone",
      ],
      optional: true,
    },
    emailAddress: {
      propDefinition: [
        picqer,
        "emailAddress",
      ],
      optional: true,
    },
    reference: {
      propDefinition: [
        picqer,
        "reference",
      ],
      optional: true,
    },
    customerRemarks: {
      propDefinition: [
        picqer,
        "customerRemarks",
      ],
      optional: true,
    },
    partialDelivery: {
      propDefinition: [
        picqer,
        "partialDelivery",
      ],
      optional: true,
    },
    discount: {
      propDefinition: [
        picqer,
        "discount",
      ],
      optional: true,
    },
    invoiced: {
      propDefinition: [
        picqer,
        "invoiced",
      ],
      optional: true,
    },
    preferredDeliveryDate: {
      propDefinition: [
        picqer,
        "preferredDeliveryDate",
      ],
      optional: true,
    },
    language: {
      propDefinition: [
        picqer,
        "language",
      ],
      options: LANGUAGE_OPTIONS,
      optional: true,
    },
    products: {
      type: "string[]",
      label: "Products",
      description: "List of objects of products to add to the order. **Format: [{\"idproduct\": 123, \"productcode\": \"ABC123\", \"name\": \"Product Name\", \"remarks\": \"Product remarks\", \"amount\": 100, \"idvatgroup\": 123}]**",
      optional: true,
    },
  },
  async additionalProps(fixedProps) {
    const props = {};
    const hasCustomerId = !!this.customerId;
    fixedProps.deliveryName.hidden = hasCustomerId;
    fixedProps.deliveryContactName.hidden = hasCustomerId;
    fixedProps.deliveryAddress.hidden = hasCustomerId;
    fixedProps.deliveryAddress2.hidden = hasCustomerId;
    fixedProps.deliveryZipcode.hidden = hasCustomerId;
    fixedProps.deliveryCity.hidden = hasCustomerId;
    fixedProps.deliveryRegion.hidden = hasCustomerId;
    fixedProps.deliveryCountry.hidden = hasCustomerId;
    fixedProps.invoiceName.hidden = hasCustomerId;
    fixedProps.invoiceContactName.hidden = hasCustomerId;
    fixedProps.invoiceAddress.hidden = hasCustomerId;
    fixedProps.invoiceAddress2.hidden = hasCustomerId;
    fixedProps.invoiceZipcode.hidden = hasCustomerId;
    fixedProps.invoiceCity.hidden = hasCustomerId;
    fixedProps.invoiceRegion.hidden = hasCustomerId;
    fixedProps.invoiceCountry.hidden = hasCustomerId;

    if (this.customerId) {
      const orderFields = await this.picqer.listOrderFields();

      for (const field of orderFields) {
        const propData = {
          type: `string${field.type === "multicheckbox"
            ? "[]"
            : ""}`,
          label: field.title,
          description: `Order field: ${field.title}`,
          optional: !field.required,
        };

        if (field.values.length) {
          propData.options = field.values;
        }

        props[`id${field.idorderfield}`] = propData;
      }
    }
    return props;
  },
  async run({ $ }) {
    const {
      picqer,
      customerId,
      templateId,
      shippingProviderId,
      deliveryName,
      deliveryContactName,
      deliveryAddress,
      deliveryAddress2,
      deliveryZipcode,
      deliveryCity,
      deliveryRegion,
      deliveryCountry,
      invoiceName,
      invoiceContactName,
      invoiceAddress,
      invoiceAddress2,
      invoiceZipcode,
      invoiceCity,
      invoiceRegion,
      invoiceCountry,
      telephone,
      emailAddress,
      reference,
      customerRemarks,
      partialDelivery,
      discount,
      invoiced,
      products,
      preferredDeliveryDate,
      language,
      ...otherFields
    } = this;

    if (!customerId && !deliveryName) {
      throw new ConfigurationError("Delivery Name is required if **Customer Id** is not provided");
    }
    if (!customerId && !deliveryCountry) {
      throw new ConfigurationError("Delivery Country is required if **Customer Id** is not provided");
    }

    const response = await picqer.createOrder({
      $,
      data: {
        idcustomer: customerId,
        idtemplate: templateId,
        idshippingprovider: shippingProviderId,
        deliveryname: deliveryName,
        deliverycontactname: deliveryContactName,
        deliveryaddress: deliveryAddress,
        deliveryaddress2: deliveryAddress2,
        deliveryzipcode: deliveryZipcode,
        deliverycity: deliveryCity,
        deliveryregion: deliveryRegion,
        deliverycountry: deliveryCountry,
        invoicename: invoiceName,
        invoicecontactname: invoiceContactName,
        invoiceaddress: invoiceAddress,
        invoiceaddress2: invoiceAddress2,
        invoicezipcode: invoiceZipcode,
        invoicecity: invoiceCity,
        invoiceregion: invoiceRegion,
        invoicecountry: invoiceCountry,
        telephone,
        emailaddress: emailAddress,
        reference,
        customerremarks: customerRemarks,
        partialdelivery: partialDelivery,
        discount: discount && parseFloat(discount),
        invoiced,
        preferreddeliverydate: preferredDeliveryDate,
        language,
        products: parseObject(products),
        orderfields: Object.entries(otherFields)?.map(([
          key,
          value,
        ]) => ({
          idorderfield: parseInt(key.replace("id", "")),
          value: Array.isArray(value)
            ? value.join(";")
            : value,
        })),
      },
    });

    $.export("$summary", `Order created successfully with ID ${response.idorder}`);
    return response;
  },
};

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
Picqer	`picqer`	`app`	This component uses the Picqer app.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Template Id	`templateId`	`string`	Select a value from the drop down menu.
Shipping Provider Id	`shippingProviderId`	`string`	Select a value from the drop down menu.
Telephone	`telephone`	`string`	Telephone number of the customer.
Email Address	`emailAddress`	`string`	Email address of the customer
Reference	`reference`	`string`	Reference for customer, will be printed on invoice and picking list
Customer Remarks	`customerRemarks`	`string`	Remarks from the customer, will be printed on picking and packing list
Partial Delivery	`partialDelivery`	`boolean`	If Picqer AutoSplit is enabled, order can be split over multiple picklists over multiple warehouses. If disabled, it will wait for all products to be available
Discount	`discount`	`string`	Discount percentage of order
Invoiced	`invoiced`	`boolean`	If this order is already invoiced, set this to true. This will make sure Picqer will not invoice this order
Preferred Delivery Date	`preferredDeliveryDate`	`string`	Customer supplied preferred delivery date, in format yyyy-mm-dd.
Language	`language`	`string`	Select a value from the drop down menu:`{ "label": "English", "value": "en" }{ "label": "Dutch", "value": "nl" }`
Products	`products`	`string[]`	List of objects of products to add to the order. Format: [{"idproduct": 123, "productcode": "ABC123", "name": "Product Name", "remarks": "Product remarks", "amount": 100, "idvatgroup": 123}]