CONNECT APP
Build with Easyship
Business Management
- API key
MCP
Give your agent Easyship tools
Every Easyship action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Easyship account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "easyship",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Shipment:
const result = await mcp.callTool({
name: "easyship-create-shipment",
arguments: {
originContactName: "Origin Name",
originContactEmail: "Origin Email",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "easyship",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Create Shipment:
result = await session.call_tool("easyship-create-shipment", {
"originContactName": "Origin Name",
"originContactEmail": "Origin Email",
})API PROXY
Call the Easyship API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Easyship API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://public-api.easyship.com/2024-09/account",
})
// Any allowed Easyship endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://public-api.easyship.com/2024-09/account
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9wdWJsaWMtYXBpLmVhc3lzaGlwLmNvbS8yMDI0LTA5L2FjY291bnQ?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Easyship actions from your backend
Connect a user's Easyship account once, then run Create Shipment on their behalf from your own code — TypeScript, Python, or plain HTTP.
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",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="easyship-create-shipment",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"easyship": {"authProvisionId": "apn_xxxxxxx"},
"originContactName": "Origin Name",
"originContactEmail": "Origin Email",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "easyship-create-shipment",
"configured_props": {
"easyship": { "authProvisionId": "apn_xxxxxxx" },
"originContactName": "Origin Name",
"originContactEmail": "Origin Email"
}
}'TOOLS
Easyship actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
EVENTS
Easyship triggers
Event sources your backend can deploy for users and receive through a webhook.
-
New Shipping Label Created (Instant)
triggerEmit new event when a new shipping label is createdInstantv0.0.1 -
Tracking Status Updated (Instant)
triggerEmit new event when a tracking status is updatedInstantv0.0.1 -
Warehouse State Updated (Instant)
triggerEmit new event when a warehouse state is updatedInstantv0.0.1
- App slug
- easyship
- Authentication
- API key
- Categories
- Business Management
- Actions
- 3
- Triggers
- 3
- API proxy
- Available