Dispatch ACTION
Create Estimate
Create a delivery estimate to get pricing and timing options before placing an order. See the documentation
- Action
- Writes data
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Dispatch account once, then configure and run Create Estimate 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: "dispatch-create-estimate",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
dispatch: { authProvisionId: "apn_xxxxxxx" },
pickupBusinessName: "Pickup Business Name",
pickupAddress1: "Pickup Address Line 1",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "dispatch-create-estimate",
"configured_props": {
"dispatch": { "authProvisionId": "apn_xxxxxxx" },
"pickupBusinessName": "Pickup Business Name",
"pickupAddress1": "Pickup Address Line 1"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "dispatch",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "dispatch-create-estimate",
arguments: {
pickupBusinessName: "Pickup Business Name",
pickupAddress1: "Pickup Address Line 1",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
pickupBusinessName Pickup Business Name | string | Name of the pickup business. Required |
pickupAddress1 Pickup Address Line 1 | string | Pickup address line 1. Required |
pickupAddress2 Pickup Address Line 2 | string | Pickup address line 2. Optional |
pickupCity Pickup City | string | Pickup city. Required |
pickupStateProvinceCode Pickup State/Province | string | Pickup state or province code (e.g. MN). Required |
pickupPostalCode Pickup Postal Code | string | Pickup postal code (e.g. 55431). Required |
pickupDateTimeUtc Pickup Date/Time (UTC) | string | Desired pickup date/time in ISO 8601 format (e.g. 2019-08-09T13:00:00.000Z). If not provided, items are assumed ready for immediate pickup. Optional |
dropOffBusinessName Drop-Off Business Name | string | Name of the drop-off business. Required |
dropOffAddress1 Drop-Off Address Line 1 | string | Drop-off address line 1. Required |
dropOffAddress2 Drop-Off Address Line 2 | string | Drop-off address line 2. Optional |
dropOffCity Drop-Off City | string | Drop-off city. Required |
dropOffStateProvinceCode Drop-Off State/Province | string | Drop-off state or province code (e.g. MN). Required |
dropOffPostalCode Drop-Off Postal Code | string | Drop-off postal code (e.g. 55431). Required |
dropOffDateTimeUtc Drop-Off Date/Time (UTC) | string | Desired drop-off date/time in ISO 8601 format (e.g. 2019-08-09T16:00:00.000Z). Optional |
estimatedWeight Estimated Weight (lbs) | integer | Estimated weight of the delivery in pounds. Optional |
vehicleType Vehicle Type | string | Type or size of vehicle needed ( car, midsize, cargo_van, pickup_truck, box_truck). Optional |
addOns Add-Ons | string[] | List of add-on services to include (e.g. dolly, inside_delivery). Optional |
dedicatedVehicle Dedicated Vehicle | boolean | Whether the order should use a dedicated vehicle. Optional |
organizationId Organization ID | integer | Specify which organization the order should be placed under. Leave empty if not a multi-tier organization. Optional 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
- dispatch-create-estimate
- Version
- 0.0.2
- App
- Dispatch
- Authentication
- API key
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗