Create Shipment with Easyship API on New Submission (Instant) from Jotform API

Pipedream makes it easy to connect APIs for Easyship, Jotform and 2,500+ other apps remarkably fast.

Trigger workflow on

New Submission (Instant) from the Jotform API

Next, do this

Create Shipment with the Easyship 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 Jotform trigger and Easyship 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 (Instant) trigger
1. Connect your Jotform account
2. Optional- Select a Team
3. Select a Form
Configure the Create Shipment action
1. Connect your Easyship account
2. Configure Origin Name
3. Configure Origin Email
4. Configure Origin Phone Number
5. Configure Origin Company Name
6. Configure Origin Street Address
7. Configure Origin City
8. Configure Origin State
9. Configure Origin Postal Code
10. Optional- Configure Origin Country (Alpha-2 Code)
11. Configure Destination Name
12. Configure Destination Email
13. Configure Destination Phone Number
14. Optional- Configure Destination Company Name
15. Configure Destination Street Address
16. Configure Destination City
17. Configure Destination State
18. Configure Destination Postal Code
19. Configure Destination Country (Alpha-2 Code)
20. Configure Number of Parcels
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 (Instant) on Jotform

Description:Emit new event when a form is submitted

Version:0.1.6

Key:jotform-new-submission

View on GitHub

Jotform Overview#

Jotform’s API is a powerhouse for automating form and survey data management. With Pipedream, harness this API to trigger workflows from new form submissions, manipulate and analyze your form data, and sync it across various platforms. Think streamlined data entry to CRMs, instant notifications for new leads or feedback, and timely data backups to cloud storage.

Trigger Code#

import jotform from "../../jotform.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "jotform-new-submission",
  name: "New Submission (Instant)",
  description: "Emit new event when a form is submitted",
  version: "0.1.6",
  type: "source",
  dedupe: "unique",
  props: {
    jotform,
    http: "$.interface.http",
    teamId: {
      propDefinition: [
        jotform,
        "teamId",
      ],
    },
    formId: {
      propDefinition: [
        jotform,
        "formId",
        (c) => ({
          teamId: c.teamId,
          excludeDeleted: true,
        }),
      ],
    },
  },
  hooks: {
    async deploy() {
      const { content: form } = await this.jotform.getForm(this.formId, this.teamId);
      const { content: submissions } = await this.jotform.getFormSubmissions({
        formId: this.formId,
        teamId: this.teamId,
        params: {
          limit: 25,
          orderby: "created_at",
        },
      });
      for (let submission of submissions.reverse()) {
        const meta = {
          id: submission.id,
          summary: form.title,
          ts: Date.now(),
        };
        this.$emit(submission, meta);
      }
    },
    async activate() {
      return (await this.jotform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        teamId: this.teamId,
      }));
    },
    async deactivate() {
      return (await this.jotform.deleteHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        teamId: this.teamId,
      }));
    },
  },
  async run(event) {
    const { body } = event;
    let { content: submission } = await this.jotform.getFormSubmission({
      submissionId: body.submissionID,
      teamId: this.teamId,
    });

    // insert answers from the webhook event
    const rawRequest = JSON.parse(body.rawRequest);
    for (const key of Object.keys(rawRequest)) {
      const regex = /^q(\d+)_/;
      const match = key.match(regex);
      if (match && match[1]) {
        submission.answers[match[1]].answer = rawRequest[key];
      }
    }

    this.$emit(submission, {
      summary: body.formTitle || JSON.stringify(body),
      id: body.submissionID,
      ts: Date.now(),
    });
  },
  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
Jotform	`jotform`	`app`	This component uses the Jotform 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.
Team	`teamId`	`string`	Select a value from the drop down menu.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

About Jotform#

Jotform enables you to create online forms, collect responses directly in your email, and create fillable PDF forms.

Action#

Create Shipment on Easyship

Description:Create a new shipment in Easyship. [See the docs](https://developers.easyship.com/reference/shipments_create)

Version:0.0.1

Key:easyship-create-shipment

View on GitHub

Easyship Overview#

The Easyship API unlocks the potential for seamless shipping processes, by integrating a multitude of courier services into your workflow. With this API, you can automate the retrieval of shipping rates, create shipments, manage orders, and track packages in transit. This streamlines the logistics side of e-commerce, ensuring that businesses can focus on what they do best – sell products – while the shipping details are handled efficiently in the background.

Action Code#

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

export default {
  key: "easyship-create-shipment",
  name: "Create Shipment",
  description: "Create a new shipment in Easyship. [See the docs](https://developers.easyship.com/reference/shipments_create)",
  version: "0.0.1",
  type: "action",
  props: {
    easyship,
    originContactName: {
      type: "string",
      label: "Origin Name",
      description: "The full name of a person at the origin address",
    },
    originContactEmail: {
      type: "string",
      label: "Origin Email",
      description: "Email address used to reach the person in `Origin Name`",
    },
    originContactPhone: {
      type: "string",
      label: "Origin Phone Number",
      description: "Phone number used to reach the person in `Origin Name` (may or may not be SMS-ready)",
    },
    originCompanyName: {
      type: "string",
      label: "Origin Company Name",
      description: "The company or organization at the originaddress",
    },
    originLine1: {
      type: "string",
      label: "Origin Street Address",
      description: "Street address of the origin address",
    },
    originCity: {
      type: "string",
      label: "Origin City",
      description: "City of the origin address",
    },
    originState: {
      type: "string",
      label: "Origin State",
      description: "State, Province, or other top-level administrative region of the origin address",
    },
    originPostalCode: {
      type: "string",
      label: "Origin Postal Code",
      description: "Postal code of the origin address",
    },
    originCountry: {
      type: "string",
      label: "Origin Country (Alpha-2 Code)",
      description: "ISO 3166-1 alpha-2 code of the origin country",
      optional: true,
    },
    destinationName: {
      type: "string",
      label: "Destination Name",
      description: "The full name of a person at the destination address.",
    },
    destinationEmail: {
      type: "string",
      label: "Destination Email",
      description: "Email address used to reach the person at the destination address.",
    },
    destinationPhoneNumber: {
      type: "string",
      label: "Destination Phone Number",
      description: "Phone number used to reach the person at the destination address (may or may not be SMS-ready).",
    },
    destinationCompanyName: {
      type: "string",
      label: "Destination Company Name",
      description: "The company or organization at the destination address.",
      optional: true,
    },
    destinationStreetAddress: {
      type: "string",
      label: "Destination Street Address",
      description: "Street address of the destination address.",
    },
    destinationCity: {
      type: "string",
      label: "Destination City",
      description: "City of the destination address.",
    },
    destinationState: {
      type: "string",
      label: "Destination State",
      description: "State, Province, or other top-level administrative region of the destination address.",
    },
    destinationPostalCode: {
      type: "string",
      label: "Destination Postal Code",
      description: "Postal code of the destination address.",
    },
    destinationCountry: {
      type: "string",
      label: "Destination Country (Alpha-2 Code)",
      description: "ISO 3166-1 alpha-2 code of the destination country.",
    },
    numberOfParcels: {
      type: "integer",
      label: "Number of Parcels",
      description: "The number of parcels to ship",
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.numberOfParcels > 0) {
      for (let i = 1; i <= this.numberOfParcels; i++) {
        props[`parcelWeight${i}`] = {
          type: "string",
          label: `Parcel ${i} Weight (kg)`,
          description: `Item actual weight in kg of parcel ${i}`,
        };
        props[`parcelLength${i}`] = {
          type: "string",
          label: `Parcel ${i} Length (cm)`,
          description: `Length of parcel ${i}`,
        };
        props[`parcelWidth${i}`] = {
          type: "string",
          label: `Parcel ${i} Width (cm)`,
          description: `Width of parcel ${i}`,
        };
        props[`parcelHeight${i}`] = {
          type: "string",
          label: `Parcel ${i} Height (cm)`,
          description: `Height of parcel ${i}`,
        };
        props[`parcelDescription${i}`] = {
          type: "string",
          label: `Parcel ${i} Description`,
          description: `Description of parcel ${i}`,
        };
        props[`parcelValue${i}`] = {
          type: "string",
          label: `Parcel ${i} Value`,
          description: `Value of parcel ${i}`,
        };
        props[`parcelCurrency${i}`] = {
          type: "string",
          label: `Parcel ${i} Currency`,
          description: `Currency of parcel ${i} value`,
        };
        props[`parcelCategory${i}`] = {
          type: "string",
          label: `Parcel ${i} Category`,
          description: `Category of parcel ${i}`,
          options: await this.getCategoriesOptions(),
        };
      }
    }
    return props;
  },
  methods: {
    async getCategoriesOptions() {
      const categories = await this.easyship.getPaginatedResources({
        fn: this.easyship.listCategories,
        resourceKey: "item_categories",
      });
      return categories.map((c) => ({
        label: c.name,
        value: c.slug,
      }));
    },
  },
  async run({ $ }) {
    const parcelItems = [];
    for (let i = 1; i <= this.numberOfParcels; i++) {
      parcelItems.push({
        dimensions: {
          length: this[`parcelLength${i}`],
          width: this[`parcelWidth${i}`],
          height: this[`parcelHeight${i}`],
        },
        actual_weight: this[`parcelWeight${i}`],
        description: this[`parcelDescription${i}`],
        declared_customs_value: this[`parcelValue${i}`],
        declared_currency: this[`parcelCurrency${i}`] || "USD",
        category: this[`parcelCategory${i}`],
      });
    }
    const response = await this.easyship.createShipment({
      $,
      data: {
        origin_address: {
          contact_name: this.originContactName,
          contact_email: this.originContactEmail,
          contact_phone: this.originContactPhone,
          company_name: this.originCompanyName,
          line_1: this.originLine1,
          city: this.originCity,
          state: this.originState,
          postal_code: this.originPostalCode,
          country_alpha2: this.originCountry,
        },
        destination_address: {
          contact_name: this.destinationName,
          contact_email: this.destinationEmail,
          contact_phone: this.destinationPhoneNumber,
          company_name: this.destinationCompanyName,
          line_1: this.destinationStreetAddress,
          city: this.destinationCity,
          state: this.destinationState,
          postal_code: this.destinationPostalCode,
          country_alpha2: this.destinationCountry,
        },
        parcels: [
          {
            items: parcelItems,
          },
        ],
      },
    });
    $.export("$summary", `Created shipment with ID: ${response.shipment.easyship_shipment_id}`);
    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
Easyship	`easyship`	`app`	This component uses the Easyship app.
Origin Name	`originContactName`	`string`	The full name of a person at the origin address
Origin Email	`originContactEmail`	`string`	Email address used to reach the person in `Origin Name`
Origin Phone Number	`originContactPhone`	`string`	Phone number used to reach the person in `Origin Name` (may or may not be SMS-ready)
Origin Company Name	`originCompanyName`	`string`	The company or organization at the originaddress
Origin Street Address	`originLine1`	`string`	Street address of the origin address
Origin City	`originCity`	`string`	City of the origin address
Origin State	`originState`	`string`	State, Province, or other top-level administrative region of the origin address
Origin Postal Code	`originPostalCode`	`string`	Postal code of the origin address
Origin Country (Alpha-2 Code)	`originCountry`	`string`	ISO 3166-1 alpha-2 code of the origin country
Destination Name	`destinationName`	`string`	The full name of a person at the destination address.
Destination Email	`destinationEmail`	`string`	Email address used to reach the person at the destination address.
Destination Phone Number	`destinationPhoneNumber`	`string`	Phone number used to reach the person at the destination address (may or may not be SMS-ready).
Destination Company Name	`destinationCompanyName`	`string`	The company or organization at the destination address.
Destination Street Address	`destinationStreetAddress`	`string`	Street address of the destination address.
Destination City	`destinationCity`	`string`	City of the destination address.
Destination State	`destinationState`	`string`	State, Province, or other top-level administrative region of the destination address.
Destination Postal Code	`destinationPostalCode`	`string`	Postal code of the destination address.
Destination Country (Alpha-2 Code)	`destinationCountry`	`string`	ISO 3166-1 alpha-2 code of the destination country.
Number of Parcels	`numberOfParcels`	`integer`	The number of parcels to ship

Try it

Get Form Submissions with Jotform API on Tracking Status Updated (Instant) from Easyship API

Easyship + Jotform

Try it

Get Monthly User Usage with Jotform API on Tracking Status Updated (Instant) from Easyship API

Easyship + Jotform

Try it

Get User Submissions with Jotform API on Tracking Status Updated (Instant) from Easyship API

Easyship + Jotform

Try it

Get Form Submissions with Jotform API on Warehouse State Updated (Instant) from Easyship API

Easyship + Jotform

Try it

Popular Triggers#

New Submission (Instant) from the Jotform API

Emit new event when a form is submitted

Try it

New Shipping Label Created (Instant) from the Easyship API

Emit new event when a new shipping label is created

Try it

Tracking Status Updated (Instant) from the Easyship API

Emit new event when a tracking status is updated

Try it

Warehouse State Updated (Instant) from the Easyship API

Emit new event when a warehouse state is updated

Try it

Popular Actions#

Get Form Submissions with the Jotform API

Gets a list of form responses See the docs here

Try it

Get Monthly User Usage with the Jotform API

Gets number of form submissions received this month. Also, get number of SSL form submissions, payment form submissions and upload space used by user See the docs here

Try it

Get User Submissions with the Jotform API

Gets a list of all submissions for all forms on the account See the docs here

Try it

Create Shipment with the Easyship API

Create a new shipment in Easyship. See the docs

Try it

Find Shipment with the Easyship API

Find a shipment by ID. See the documentation

Try it