Get Tracking Details 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

Get Tracking Details 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 Get Tracking Details with the Starshipit API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Tracking Details action
1. Connect your Starshipit account
2. Optional- Select a Tracking Number
3. Optional- Select a Order Number
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#

Get Tracking Details with Starshipit API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Starshipit

Try it

Get Tracking Details with Starshipit API on New Submission from Typeform API

Typeform + Starshipit

Try it

Get Tracking Details with Starshipit API on Custom Events from Zoom API

Zoom + Starshipit

Try it

Get Tracking Details with Starshipit API on New Submission (Instant) from Jotform API

Jotform + Starshipit

Try it

Get Tracking Details 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.

Get Tracking Details on Starshipit

Description:Retrieve tracking details using a tracking number or order number. [See the documentation](https://api-docs.starshipit.com/#a655a3b4-ea39-42c4-acb4-d868ad40dc47)

Version:0.0.1

Key:starshipit-get-tracking

View on GitHub

Code#

import starshipit from "../../starshipit.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "starshipit-get-tracking",
  name: "Get Tracking Details",
  description: "Retrieve tracking details using a tracking number or order number. [See the documentation](https://api-docs.starshipit.com/#a655a3b4-ea39-42c4-acb4-d868ad40dc47)",
  version: "0.0.1",
  type: "action",
  props: {
    starshipit,
    trackingNumber: {
      propDefinition: [
        starshipit,
        "trackingNumber",
      ],
    },
    orderNumber: {
      propDefinition: [
        starshipit,
        "orderNumber",
        () => ({
          shipped: true,
        }),
      ],
      description: "The order number of a shipped order to get tracking details for",
      optional: true,
    },
  },
  async run({ $ }) {
    if (!this.trackingNumber && !this.orderNumber) {
      throw new ConfigurationError("Either tracking number or order number must be provided.");
    }
    const { results } = await this.starshipit.getTrackingDetails({
      params: {
        tracking_number: this.trackingNumber,
        order_number: this.orderNumber,
      },
      $,
    });
    if (results?.order_number) {
      $.export("$summary", `Successfully retrieved tracking details for order ${results.order_number}.`);
    }
    return results;
  },
};

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.
Tracking Number	`trackingNumber`	`string`	Select a value from the drop down menu.
Order Number	`orderNumber`	`string`	Select a value from the drop down menu.

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,