← Easyship

Create Shipment with Easyship API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Create Shipment with the Easyship API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Create Shipment with the Easyship API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. 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
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Create Shipment with Easyship API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Easyship
 
Try it
Create Shipment with Easyship API on New Submission from Typeform API
Typeform + Easyship
 
Try it
Create Shipment with Easyship API on New Submission (Instant) from Jotform API
Jotform + Easyship
 
Try it
Create Shipment with Easyship API on New Scheduled Tasks from Pipedream API
Pipedream + Easyship
 
Try it
Create Shipment with Easyship API on New Download Counts from npm API
npm + Easyship
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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.
LabelPropTypeDescription
EasyshipeasyshipappThis component uses the Easyship app.
Origin NameoriginContactNamestring

The full name of a person at the origin address

Origin EmailoriginContactEmailstring

Email address used to reach the person in Origin Name

Origin Phone NumberoriginContactPhonestring

Phone number used to reach the person in Origin Name (may or may not be SMS-ready)

Origin Company NameoriginCompanyNamestring

The company or organization at the originaddress

Origin Street AddressoriginLine1string

Street address of the origin address

Origin CityoriginCitystring

City of the origin address

Origin StateoriginStatestring

State, Province, or other top-level administrative region of the origin address

Origin Postal CodeoriginPostalCodestring

Postal code of the origin address

Origin Country (Alpha-2 Code)originCountrystring

ISO 3166-1 alpha-2 code of the origin country

Destination NamedestinationNamestring

The full name of a person at the destination address.

Destination EmaildestinationEmailstring

Email address used to reach the person at the destination address.

Destination Phone NumberdestinationPhoneNumberstring

Phone number used to reach the person at the destination address (may or may not be SMS-ready).

Destination Company NamedestinationCompanyNamestring

The company or organization at the destination address.

Destination Street AddressdestinationStreetAddressstring

Street address of the destination address.

Destination CitydestinationCitystring

City of the destination address.

Destination StatedestinationStatestring

State, Province, or other top-level administrative region of the destination address.

Destination Postal CodedestinationPostalCodestring

Postal code of the destination address.

Destination Country (Alpha-2 Code)destinationCountrystring

ISO 3166-1 alpha-2 code of the destination country.

Number of ParcelsnumberOfParcelsinteger

The number of parcels to ship

Authentication

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

About Easyship

The leading global shipping platform for crowdfunding and eCommerce, powering makers worldwide.

More Ways to Use Easyship

Triggers

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

Actions

Find Shipment with the Easyship API

Find a shipment by ID. See the documentation

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
Pipedream Utils
Pipedream Utils
Utility functions to use within your Pipedream workflows
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Cloud-based customer relationship management (CRM) platform that helps businesses manage sales, marketing, customer support, and other business activities, ultimately aiming to improve customer relationships and streamline operations.
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.