Find Tracking Status with Shipengine API on New Scheduled Tasks from AWS API

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

Trigger workflow on

New Scheduled Tasks from the AWS API

Next, do this

Find Tracking Status 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 AWS 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 New Scheduled Tasks trigger
1. Connect your AWS account
2. Select a AWS Region
3. Optional- Configure Secret
Configure the Find Tracking Status action
1. Connect your Shipengine account
2. Select a Carrier Code
3. Select a Tracking Number
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 Scheduled Tasks on AWS

Description:Creates a Step Function State Machine to publish a message to an SNS topic at a specific timestamp. The SNS topic delivers the message to this Pipedream source, and the source emits it as a new event.

Version:0.4.2

Key:aws-new-scheduled-tasks

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Trigger Code#

import base from "../common/scheduled.mjs";
import { toSingleLineString } from "../../common/utils.mjs";

export default {
  ...base,
  key: "aws-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  description: toSingleLineString(`
    Creates a Step Function State Machine to publish a message
    to an SNS topic at a specific timestamp. The SNS topic delivers
    the message to this Pipedream source, and the source emits it as a new event.
  `),
  version: "0.4.2",
  type: "source",
  dedupe: "unique", // Dedupe on SNS message ID
  methods: {
    ...base.methods,
    getStateMachineDefinition() {
      const { PD_COMPONENT: componentId } = process.env;
      const topicArn = this.getTopicArn();
      return {
        Comment: `Task Scheduler for Pipedream component ${componentId}`,
        StartAt: "Wait",
        States: {
          Wait: {
            Comment: "Wait until specified timestamp",
            Type: "Wait",
            TimestampPath: "$.timestamp",
            Next: "SendMessageToSNS",
          },
          SendMessageToSNS: {
            Type: "Task",
            Resource: "arn:aws:states:::sns:publish",
            Parameters: {
              "TopicArn": topicArn,
              "Message.$": "$",
            },
            End: true,
          },
        },
      };
    },
    getStateMachinePermissions() {
      const topicArn = this.getTopicArn();
      const document = {
        Version: "2012-10-17",
        Statement: [
          {
            Effect: "Allow",
            Action: [
              "sns:Publish",
            ],
            Resource: [
              topicArn,
            ],
          },
        ],
      };
      const name = "publish-messages-to-pipedream-sns-topic";
      return {
        document,
        name,
      };
    },
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
AWS Region	`region`	`string`	Select a value from the drop down menu.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `secret` parameter of each HTTP POST request

Trigger Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

Action#

Find Tracking Status on Shipengine

Description:Retrieves package tracking information. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/get_tracking_log).

Version:0.0.2

Key:shipengine-find-tracking-status

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";

export default {
  key: "shipengine-find-tracking-status",
  name: "Find Tracking Status",
  description: "Retrieves package tracking information. [See the docs](https://shipengine.github.io/shipengine-openapi/#operation/get_tracking_log).",
  type: "action",
  version: "0.0.2",
  props: {
    app,
    carrierCode: {
      label: "Carrier Code",
      description: "Carrier code used to retrieve tracking information. E.g. `stamps_com`",
      propDefinition: [
        app,
        "carrierId",
        () => ({
          mapper: ({
            friendly_name: label, carrier_code: value,
          }) => ({
            label,
            value,
          }),
        }),
      ],
    },
    trackingNumber: {
      label: "Tracking Number",
      description: "The tracking number associated with a shipment. E.g. `9405511899223197428490`",
      propDefinition: [
        app,
        "labelId",
        () => ({
          mapper: ({ tracking_number: value }) => value,
        }),
      ],
    },
  },
  methods: {
    getTrackingInfo(args = {}) {
      return this.app.makeRequest({
        path: "/tracking",
        ...args,
      });
    },
  },
  async run({ $: step }) {
    const {
      carrierCode,
      trackingNumber,
    } = this;

    const response = await this.getTrackingInfo({
      step,
      params: {
        carrier_code: carrierCode,
        tracking_number: trackingNumber,
      },
    });

    step.export("$summary", `Tracking status for ${trackingNumber} is ${response.status_description}`);

    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
Shipengine	`app`	`app`	This component uses the Shipengine app.
Carrier Code	`carrierCode`	`string`	Select a value from the drop down menu.
Tracking Number	`trackingNumber`	`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 + AWS#

Other Popular Integrations#

Find Tracking Status with Shipengine API on New SNS Messages from AWS API

AWS + Shipengine

Find Tracking Status with Shipengine API on New Scheduled Tasks from AWS API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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