Sendcloud ACTION
List Integration Shipments
List integration shipments. See the documentation
- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Sendcloud account once, then configure and run List Integration Shipments 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: "sendcloud-list-integration-shipments",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
sendcloud: { authProvisionId: "apn_xxxxxxx" },
integrationId: "Integration ID",
senderAddress: "Sender Address ID",
},
})
console.log(result)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": "sendcloud-list-integration-shipments",
"configured_props": {
"sendcloud": { "authProvisionId": "apn_xxxxxxx" },
"integrationId": "Integration ID",
"senderAddress": "Sender Address ID"
}
}'// 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": "sendcloud",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "sendcloud-list-integration-shipments",
arguments: {
integrationId: "Integration ID",
senderAddress: "Sender Address ID",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
integrationId Integration ID | string | The ID of the integration Required Dynamic |
senderAddress Sender Address ID | string | Specify a sender address ID to display proper allowed_shipping_methods. Required Dynamic |
externalOrderIds External Order IDs | string[] | Filter to shipments where external_order_id matches one of these values. Optional |
externalShipmentIds External Shipment IDs | string[] | Filter to shipments where external_shipment_id matches one of these values. Optional |
endDate End Date | string | Displays orders up to the given date (inclusive). Format: YYYY-MM-DD. Defaults to current date. Optional |
orderNumber Order Number | string | Filter to shipments matching this order number. Optional |
shippingRules Enable Shipping Rules | boolean | Enable shipping rules when retrieving orders (impacts allowed_shipping_methods). Optional |
startDate Start Date | string | Displays orders from the given date (inclusive). Format: YYYY-MM-DD. Defaults to one year ago. 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
- sendcloud-list-integration-shipments
- Version
- 0.0.4
- App
- Sendcloud
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗