View as Markdown
Sendcloud icon

Sendcloud ACTION

List Shipping Methods

List shipping methods. 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 Shipping Methods 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-shipping-methods",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    sendcloud: { authProvisionId: "apn_xxxxxxx" },
    country: "country",
    servicePointId: 10,
  },
})

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 Shipping Methods inputs
Property Type Description
country country string
Country of the recipient
Required
servicePointId Service Point integer
The service point ID of the recipient.
Optional Dynamic
fromPostalCode From Postal Code string
Postal code of the sender (<= 12 chars). Required if the carrier is zonal.
Optional
isReturn Is Return boolean
If true, returns shipping methods usable for return shipments.
Optional
senderAddress Sender Address ID string
Sender address ID or all to retrieve all available shipping methods. Required if the carrier is zonal.
Optional Dynamic
toCountry To Country string
Recipient country (ISO 3166-1 alpha-2). Required if the carrier is zonal and to compute remote surcharges.
Optional
toPostalCode To Postal Code string
Postal code of the recipient (<= 12 chars). Required if the carrier is zonal and to compute remote surcharges.
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-shipping-methods
Version
0.0.4
App
Sendcloud
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes