View as Markdown
Shipengine icon

Shipengine ACTION

Search Labels

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.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shipengine account once, then configure and run Search Labels 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-search-labels",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shipengine: { authProvisionId: "apn_xxxxxxx" },
    labelStatus: "Label Status",
    carrierId: "Carrier ID",
  },
})

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.

Search Labels inputs
Property Type Description
labelStatus Label Status string
The status of the label. E.g. processing
Required
carrierId Carrier ID string
The ID of the carrier. E.g. se-28529731
Required Dynamic
serviceCode Service Code string
The service code of the label.
Required Dynamic
trackingNumber Tracking Number string
The tracking number associated with a shipment. E.g. 9405511899223197428490
Required Dynamic
shipmentId Shipment ID string
The ID of the shipment. E.g. se-28529731
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-search-labels
Version
0.0.4
App
Shipengine
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes