Search Labels with Shipengine API on Custom Interval from Schedule API

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

Trigger workflow on

Custom Interval from the Schedule API

Next, do this

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

Select this integration
Configure the Custom Interval trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Search Labels action
1. Connect your Shipengine account
2. Select a Label Status
3. Select a Carrier ID
4. Select a Service Code
5. Select a Tracking Number
6. Select a Shipment ID
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#

Custom Interval on Schedule

Description:Trigger your workflow every N hours, minutes or seconds.

Version:0.0.2

Key:schedule-custom-interval

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Custom Interval",
  version: "0.0.2",
  key: "schedule-custom-interval",
  type: "source",
  description: "Trigger your workflow every N hours, minutes or seconds.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Search Labels on Shipengine

Description:By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/list_labels).

Version:0.0.2

Key:shipengine-search-labels

View on GitHub

Shipengine Overview#

The Shipengine API enables robust automation possibilities for shipping logistics. From label creation, rate comparison, to tracking shipments, the API provides the tools to streamline e-commerce and shipping workflows. By harnessing Shipengine's capabilities through Pipedream, you can build seamless integrations that connect your shipping operations with other business processes, enhancing efficiency and reducing manual overhead.

Action Code#

import app from "../../shipengine.app.mjs";
import constants from "../../common/constants.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "shipengine-search-labels",
  name: "Search Labels",
  description: "By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/list_labels).",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    labelStatus: {
      type: "string",
      label: "Label Status",
      description: "The status of the label. E.g. `processing`",
      options: constants.LABEL_STATUSES,
    },
    carrierId: {
      propDefinition: [
        app,
        "carrierId",
      ],
    },
    serviceCode: {
      propDefinition: [
        app,
        "serviceCode",
        ({ carrierId }) => ({
          carrierId,
        }),
      ],
    },
    trackingNumber: {
      label: "Tracking Number",
      description: "The tracking number associated with a shipment. E.g. `9405511899223197428490`",
      propDefinition: [
        app,
        "labelId",
        () => ({
          mapper: ({ tracking_number: value }) => value,
        }),
      ],
    },
    shipmentId: {
      propDefinition: [
        app,
        "shipmentId",
      ],
    },
  },
  async run({ $: step }) {
    const {
      labelStatus,
      serviceCode,
      carrierId,
      trackingNumber,
      shipmentId,
    } = this;

    const stream = this.app.getResourcesStream({
      resourcesFn: this.app.listLabels,
      resourcesFnArgs: {
        step,
        params: {
          label_status: labelStatus,
          service_code: serviceCode,
          carrier_id: carrierId,
          tracking_number: trackingNumber,
          shipment_id: shipmentId,
          page_size: constants.DEFAULT_LIMIT,
        },
      },
      resourcesName: "labels",
    });

    const resources = await utils.streamIterator(stream);

    step.export("$summary", `Successfully retrieved ${utils.summaryEnd(resources.length, "label")}.`);

    return resources;
  },
};

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
Shipengine	`app`	`app`	This component uses the Shipengine app.
Label Status	`labelStatus`	`string`	Select a value from the drop down menu:`processingcompletederrorvoided`
Carrier ID	`carrierId`	`string`	Select a value from the drop down menu.
Service Code	`serviceCode`	`string`	Select a value from the drop down menu.
Tracking Number	`trackingNumber`	`string`	Select a value from the drop down menu.
Shipment ID	`shipmentId`	`string`	Select a value from the drop down menu.

Action Authentication#

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

Get your API key in the API Management section

About Shipengine#

Shipping API & multi carrier shipping system

More Ways to Connect Shipengine + Schedule#

Other Popular Integrations#

Find Tracking Status with Shipengine API on Daily schedule from Schedule API

Schedule + Shipengine

Try it

Find Tracking Status with Shipengine API on Weekly schedule from Schedule API

Schedule + Shipengine

Try it

Find Tracking Status with Shipengine API on Custom Interval from Schedule API

Schedule + Shipengine

Try it

Find Tracking Status with Shipengine API on Monthly Schedule from Schedule API

Schedule + Shipengine

Try it

Search Labels with Shipengine API on Daily schedule from Schedule API

Schedule + Shipengine

Try it

Popular Triggers#

Custom Interval from the Schedule API

Trigger your workflow every N hours, minutes or seconds.

Try it

Daily schedule from the Schedule API

Trigger your workflow every day.

Try it

Monthly Schedule from the Schedule API

Trigger your workflow on one or more days each month at a specific time (with timezone support).

Try it

Weekly schedule from the Schedule API

Trigger your workflow on one or more days each week at a specific time (with timezone support).

Try it

New Shipping Label Created from the Shipengine API

Emit new event when a new label is shipped. See the docs.

Try it

Popular Actions#

Find Tracking Status with the Shipengine API

Retrieves package tracking information. See the docs.

Try it

Search Labels with the Shipengine API

By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. See the docs.

Try it

Start Tracking a Package with the Shipengine API

Allows you to subscribe to tracking updates for a package. See the docs.

Try it

Validate An Address with the Shipengine API

Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. See the docs.

Try it