Create Picqer Order with Picqer API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform 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 Typeform 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 Submission trigger
1. Connect your Typeform account
2. Select a Form
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform app.
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.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

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}]