View as Markdown
shipcloud icon

shipcloud ACTION

Create Shipment Quote

Create a shipment quote See docs here
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's shipcloud account once, then configure and run Create Shipment Quote 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: "shipcloud-create-shipment-quote",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shipcloud: { authProvisionId: "apn_xxxxxxx" },
    carrier: "Carrier",
    service: "Service",
  },
})

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.

Create Shipment Quote inputs
Property Type Description
carrier Carrier string
The carrier you want to use
Required
service Service string
The service that should be used for the shipment
Required
toAddress Recipient Address string
Select an Address from the list.
Alternatively, you can provide a custom JSON-stringified Address object.
Example address object: {"company":"MusterCompany","first_name":"Max","last_name":"Mustermann","street":"Musterstraße","street_no":"42","zip_code":"54321","city":"Musterstadt"}
Required Dynamic
fromAddress Sender Address string
Select an Address from the list.
Alternatively, you can provide a custom JSON-stringified Address object.
Example address object: {"company":"MusterCompany","first_name":"Max","last_name":"Mustermann","street":"Musterstraße","street_no":"42","zip_code":"54321","city":"Musterstadt"}
Required Dynamic
package Package object
Object describing the package. Required fields are height, length, weight and width.
(See more info on the Shipcloud Docs)
Required

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
shipcloud-create-shipment-quote
Version
0.0.2
App
shipcloud
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes