View as Markdown
Easyship icon

Easyship ACTION

Create Shipment

Create a new shipment in Easyship. See the docs
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Easyship 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: "easyship-create-shipment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    easyship: { authProvisionId: "apn_xxxxxxx" },
    originContactName: "Origin Name",
    originContactEmail: "Origin Email",
  },
})

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
originContactName Origin Name string
The full name of a person at the origin address
Required
originContactEmail Origin Email string
Email address used to reach the person in Origin Name
Required
originContactPhone Origin Phone Number string
Phone number used to reach the person in Origin Name (may or may not be SMS-ready)
Required
originCompanyName Origin Company Name string
The company or organization at the originaddress
Required
originLine1 Origin Street Address string
Street address of the origin address
Required
originCity Origin City string
City of the origin address
Required
originState Origin State string
State, Province, or other top-level administrative region of the origin address
Required
originPostalCode Origin Postal Code string
Postal code of the origin address
Required
originCountry Origin Country (Alpha-2 Code) string
ISO 3166-1 alpha-2 code of the origin country
Optional
destinationName Destination Name string
The full name of a person at the destination address.
Required
destinationEmail Destination Email string
Email address used to reach the person at the destination address.
Required
destinationPhoneNumber Destination Phone Number string
Phone number used to reach the person at the destination address (may or may not be SMS-ready).
Required
destinationCompanyName Destination Company Name string
The company or organization at the destination address.
Optional
destinationStreetAddress Destination Street Address string
Street address of the destination address.
Required
destinationCity Destination City string
City of the destination address.
Required
destinationState Destination State string
State, Province, or other top-level administrative region of the destination address.
Required
destinationPostalCode Destination Postal Code string
Postal code of the destination address.
Required
destinationCountry Destination Country (Alpha-2 Code) string
ISO 3166-1 alpha-2 code of the destination country.
Required
numberOfParcels Number of Parcels integer
The number of parcels to ship
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
easyship-create-shipment
Version
0.0.2
App
Easyship
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes