Print Shipping Label with Starshipit API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Print Shipping Label with the Starshipit 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#

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

Configure the Print Shipping Label action
1. Connect your Starshipit account
2. Select a Order Number
3. Configure Carrier
4. Configure Carrier Service Code
5. Configure Number of Packages
6. Optional- Configure Reprint
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Print Shipping Label with Starshipit API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Starshipit

Try it

Print Shipping Label with Starshipit API on New Submission from Typeform API

Typeform + Starshipit

Try it

Print Shipping Label with Starshipit API on Custom Events from Zoom API

Zoom + Starshipit

Try it

Print Shipping Label with Starshipit API on New Submission (Instant) from Jotform API

Jotform + Starshipit

Try it

Print Shipping Label with Starshipit API on New Scheduled Tasks from Pipedream API

Pipedream + Starshipit

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.

Print Shipping Label on Starshipit

Description:Print a shipping label for a specific order. [See the documentation](https://api-docs.starshipit.com/#b6bc3576-a43f-4992-86d8-8fdf57f872f6)

Version:0.0.1

Key:starshipit-print-label

View on GitHub

Code#

import starshipit from "../../starshipit.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "starshipit-print-label",
  name: "Print Shipping Label",
  description: "Print a shipping label for a specific order. [See the documentation](https://api-docs.starshipit.com/#b6bc3576-a43f-4992-86d8-8fdf57f872f6)",
  version: "0.0.1",
  type: "action",
  props: {
    starshipit,
    orderNumber: {
      propDefinition: [
        starshipit,
        "orderNumber",
      ],
    },
    carrier: {
      type: "string",
      label: "Carrier",
      description: "The carrier that will be used when creating shipment",
    },
    carrierServiceCode: {
      type: "string",
      label: "Carrier Service Code",
      description: "Carrier service code for delivery",
    },
    numPackages: {
      type: "integer",
      label: "Number of Packages",
      description: "The number of packages in the order",
      reloadProps: true,
    },
    reprint: {
      type: "boolean",
      label: "Reprint",
      description: "  Returns labels previously generated for the printed order",
      default: false,
      optional: true,
    },
  },
  additionalProps() {
    const props = {};
    for (let i = 1; i <= this.numPackages; i++) {
      props[`package_${i}_weight`] = {
        type: "string",
        label: `Package ${i} Weight`,
        description: "Physical weight of the parcel in kilograms (kg)",
        optional: true,
      };
      props[`package_${i}_height`] = {
        type: "string",
        label: `Package ${i} Height`,
        description: "Height of the parcel in meters (m)",
        optional: true,
      };
      props[`package_${i}_width`] = {
        type: "string",
        label: `Package ${i} Width`,
        description: "Width of the parcel in meters (m)",
        optional: true,
      };
      props[`package_${i}_length`] = {
        type: "string",
        label: `Package ${i} Length`,
        description: "Length of the parcel in meters (m)",
        optional: true,
      };
    }
    return props;
  },
  methods: {
    parseFloat(i, type) {
      return utils.parseFloatProp(this, "package", i, type);
    },
  },
  async run({ $ }) {
    const packages = [];
    for (let i = 1; i <= this.numPackages; i++) {
      packages.push({
        weight: this.parseFloat(i, "weight"),
        height: this.parseFloat(i, "height"),
        width: this.parseFloat(i, "width"),
        length: this.parseFloat(i, "length"),
      });
    }

    const response = await this.starshipit.printShippingLabel({
      data: {
        order_number: this.orderNumber,
        carrier: this.carrier,
        carrier_service_code: this.carrierServiceCode,
        reprint: this.repring,
        packages,
      },
      $,
    });
    if (response?.success === false) {
      throw new Error(`${response.errors[0].message}: ${response.errors[0].details}`);
    }
    if (response) {
      $.export("$summary", `Successfully printed shipping label for order number ${this.orderNumber}`);
    }
    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.

Label	Prop	Type	Description
Starshipit	`starshipit`	`app`	This component uses the Starshipit app.
Order Number	`orderNumber`	`string`	Select a value from the drop down menu.
Carrier	`carrier`	`string`	The carrier that will be used when creating shipment
Carrier Service Code	`carrierServiceCode`	`string`	Carrier service code for delivery
Number of Packages	`numPackages`	`integer`	The number of packages in the order
Reprint	`reprint`	`boolean`	Returns labels previously generated for the printed order

Authentication#

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

To retrieve your API keys,