View as Markdown
Sendcloud icon

Sendcloud ACTION

Get Return

Retrieve a return by ID. 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 Get Return 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-get-return",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sendcloud: { authProvisionId: "apn_xxxxxxx" },
    fromDate: "From Date",
    toDate: "To Date",
  },
})

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.

Get Return inputs
Property Type Description
fromDate From Date string
Excludes all returns before this datetime. Example: 2022-04-06 00:00:00
Required
toDate To Date string
Excludes all returns after this datetime. Example: 2022-04-07 00:00:00
Required
returnId Return ID string
The unique identifier of the return
Required Dynamic

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-get-return
Version
0.0.3
App
Sendcloud
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes