View as Markdown
Shipengine icon

Shipengine ACTION

Start Tracking a Package

Allows you to subscribe to tracking updates for a package. See the docs.
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shipengine account once, then configure and run Start Tracking a Package from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "shipengine-start-tracking-package",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shipengine: { authProvisionId: "apn_xxxxxxx" },
    carrierCode: "Carrier Code",
    trackingNumber: "Tracking Number",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Start Tracking a Package inputs
Property Type Description
carrierCode Carrier Code string
Carrier code used to retrieve tracking information. E.g. stamps_com
Required Dynamic
trackingNumber Tracking Number string
The tracking number associated with a shipment. E.g. 9405511899223197428490
Required Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
shipengine-start-tracking-package
Version
0.0.3
App
Shipengine
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes