View as Markdown
Sendcloud icon

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Integration Shipments inputs
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