View as Markdown
Trunkrs icon

Trunkrs ACTION

List Shipments

List all shipments. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Trunkrs account once, then configure and run List Shipments 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: "trunkrs-list-shipments",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    trunkrs: { authProvisionId: "apn_xxxxxxx" },
    sort: "Sort",
    maxResults: 10,
  },
})

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.

List Shipments inputs
Property Type Description
sort Sort string
The field to sort by. Fields prepended with a dash (-) are sorted in descending order.
Required
maxResults Max Results integer
The maximum number of shipments to return. Default: 100
Optional
offset Offset integer
The offset to start from. Default: 0
Optional

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
trunkrs-list-shipments
Version
0.0.2
App
Trunkrs
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes