View as Markdown
Sendcloud icon

Sendcloud ACTION

Get Return Portal Settings

Get return portal settings for the current brand/user. 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 Portal Settings 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-portal-settings",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sendcloud: { authProvisionId: "apn_xxxxxxx" },
    brandDomain: "Brand Domain",
    language: "Language",
  },
})

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 Portal Settings inputs
Property Type Description
brandDomain Brand Domain string
Domain of the brand configured for your return portal (e.g., my-shop).
Required Dynamic
language Language string
Translate the portal and context to this language.
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-get-return-portal-settings
Version
0.0.3
App
Sendcloud
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes