View as Markdown
Trunkrs icon

Trunkrs ACTION

Create Shipment

Create a new shipment. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Trunkrs account once, then configure and run Create Shipment 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-create-shipment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    trunkrs: { authProvisionId: "apn_xxxxxxx" },
    orderReference: "Order Reference",
    senderName: "Sender Name",
  },
})

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.

Create Shipment inputs
Property Type Description
orderReference Order Reference string
Internal order reference provided by customer, this must be unique
Required
senderName Sender Name string
The name of the sender
Required
senderEmailAddress Sender Email Address string
The email address of the sender
Required
senderStreetAddress Sender Street Address string
The street address of the sender
Required
senderPostalCode Sender Postal Code string
The postal code of the sender
Required
senderCity Sender City string
The city of the sender
Required
senderCountry Country string
The country of the sender
Required
recipientName Recipient Name string
The name of the recipient
Required
recipientEmailAddress Recipient Email Address string
The email address of the recipient
Required
recipientStreetAddress Recipient Street Address string
The street address of the recipient
Required
recipientPostalCode Recipient Postal Code string
The postal code of the recipient
Required
recipientCity Recipient City string
The city of the recipient
Required
recipientCountry Country string
The country of the sender
Required
parcelWeightUnit Parcel Weight Unit string
The unit of weight for the parcels
Required
parcelWeights Parcel Weights string[]
An array of weights for the parcels in the unit provided by the parcelWeightUnit prop
Required
timeSlotId Time Slot ID string
The ID of the time slot to use for the shipment
Optional Dynamic
service Service string
Specifies the service level of this parcel. To use the freezer service, set the value to SAME_DAY_FROZEN_FOOD.
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-create-shipment
Version
0.0.2
App
Trunkrs
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes