CONNECT APP
Build with ShipStation
Commerce
- API key
MCP
Give your agent ShipStation tools
Every ShipStation 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 ShipStation 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": "shipstation",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Create Order:
const result = await mcp.callTool({
name: "shipstation-create-order",
arguments: {
orderNumber: "Order Number",
orderDate: "Order Date",
},
})# 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": "shipstation",
}
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 Order:
result = await session.call_tool("shipstation-create-order", {
"orderNumber": "Order Number",
"orderDate": "Order Date",
})API PROXY
Call the ShipStation API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the ShipStation 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://ssapi.shipstation.com/users/",
})
// Any allowed ShipStation 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://ssapi.shipstation.com/users/
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9zc2FwaS5zaGlwc3RhdGlvbi5jb20vdXNlcnMv?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run ShipStation actions from your backend
Connect a user's ShipStation account once, then run Create Order 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: "shipstation-create-order",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
shipstation: { authProvisionId: "apn_xxxxxxx" },
orderNumber: "Order Number",
orderDate: "Order Date",
},
})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="shipstation-create-order",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"shipstation": {"authProvisionId": "apn_xxxxxxx"},
"orderNumber": "Order Number",
"orderDate": "Order Date",
},
)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": "shipstation-create-order",
"configured_props": {
"shipstation": { "authProvisionId": "apn_xxxxxxx" },
"orderNumber": "Order Number",
"orderDate": "Order Date"
}
}'TOOLS
ShipStation actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Create Order
actionCreate a new order. See docs hereWritev0.0.3 -
Get Order
actionRetrieve a single order by its ID. See the documentationRead-onlyv0.0.1 -
List Customer Email Options
actionRetrieves available options for the Customer Email field. See the documentationRead-onlyv0.0.2 -
List Orders
actionList orders optionally filtered by various criteria. See the documentationRead-onlyv0.0.2 -
List Store Options
actionRetrieves available options for the Store field. See the documentationRead-onlyv0.0.2
EVENTS
ShipStation triggers
Event sources your backend can deploy for users and receive through a webhook.
MULTI-APP
Use ShipStation with other popular apps
Most products don't stop at one integration. Pair ShipStation with the other apps your users rely on, and ship use cases that span both.
- App slug
- shipstation
- Authentication
- API key
- Categories
- Commerce
- Actions
- 5
- Triggers
- 2
- API proxy
- Available