View as Markdown
UPS icon

UPS ACTION

Create Shipment

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

IMPLEMENTATION

Call this tool

Connect a user's UPS 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: "ups-create-shipment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ups: { authProvisionId: "apn_xxxxxxx" },
    shipperName: "Shipper Name",
    shipperNumber: "Shipper 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.

Create Shipment inputs
Property Type Description
shipperName Shipper Name string
The name of the shipper
Required
shipperNumber Shipper Number string
Shipper's six digit alphanumeric account number
Required
shipperAddressLine Shipper Address Line string
The address line of the shipper
Required
shipperCity Shipper City string
The city of the shipper
Required
shipperStateProvinceCode Shipper State Province Code string
The state province code of the shipper
Required
shipperPostalCode Shipper Postal Code string
The postal code of the shipper
Required
shipperCountryCode Shipper Country Code string
The country code of the shipper
Required
shipToName Ship To Name string
The name of the ship to
Required
shipToAddressLine Ship To Address Line string
The address line of the ship to
Required
shipToCity Ship To City string
The city of the ship to
Required
shipToStateProvinceCode Ship To State Province Code string
The state province code of the ship to
Required
shipToPostalCode Ship To Postal Code string
The postal code of the ship to
Required
shipToCountryCode Ship To Country Code string
The country code of the ship to
Required
serviceCode Service Code string
The code of the service
Required
packagingCode Packaging Code string
The code of the packaging
Required
weightUnit Weight Unit string
The unit of weight for the package
Required
packageWeight Package Weight string
The weight of the package
Required

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
ups-create-shipment
Version
0.0.2
App
UPS
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes