Deftship ACTION

Get Insurance Rate

Checks pricing for Insurance based on the supplied information. Also automatically creates an insurance and returns the pricing. See the documentation

Action
Read only
API key
SDK
MCP

Start building

IMPLEMENTATION

Call this tool

Connect a user's Deftship account once, then configure and run Get Insurance Rate from your backend or agent.

Pipedream Connect

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: "deftship-get-insurance-rate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    deftship: { authProvisionId: "apn_xxxxxxx" },
    carrier: "Insurance Carrier",
    serviceCode: "Service Code",
  },
})

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": "deftship-get-insurance-rate",
    "configured_props": {
      "deftship": { "authProvisionId": "apn_xxxxxxx" },
      "carrier": "Insurance Carrier",
      "serviceCode": "Service Code"
    }
  }'

// 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": "deftship",
      },
    },
  },
)

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: "deftship-get-insurance-rate",
  arguments: {
    carrier: "Insurance Carrier",
    serviceCode: "Service Code",
  },
})

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 Insurance Rate inputs
Property	Type	Description
`carrier` Insurance Carrier	`string`	Carrier of the order going to be insured Required Dynamic
`serviceCode` Service Code	`string`	Service code of this order Required Dynamic
`shipmentDate` Shipment Date	`string`	Shipment date, in `Y-m-d` Required
`fromName` From Address: Name	`string`	The name in the sender address Required
`fromAttention` From Address: Attention	`string`	Attention of the sender Required
`fromStreet` From Address: Street	`string`	The street address of the sender Required
`fromCity` From Address: City	`string`	The city address of the sender Required
`fromState` From Address: State	`string`	The state code of the sender Required
`fromZip` From Address: Zip Code	`string`	The zip code of the sender Required
`fromCountry` From Address: Country	`string`	The country code of the sender Required
`fromTelephone` From Address: Telephone	`string`	The telephone number of the sender Required
`toName` To Address: Name	`string`	The name in the receiver address Required
`toAttention` To Address: Attention	`string`	Attention of the receiver Required
`toStreet` To Address: Street	`string`	The street address of the receiver Required
`toCity` To Address: City	`string`	The city address of the receiver Required
`toState` To Address: State	`string`	The state code of the receiver Required
`toZip` To Address: Zip Code	`string`	The zip code of the receiver Required
`toCountry` To Address: Country	`string`	The country code of the receiver Required
`toTelephone` To Address: Telephone	`string`	The telephone number of the receiver Required
`trackingNumber` Tracking Number	`string`	Tracking number of the package going to be insured Required
`itemDescription` Item	`string`	Description of the item being shipped Required
`itemQuantity` Quantity	`integer`	Item piece count Required
`itemPrice` Price	`string`	Item piece price Required
`isInternational` Is International	`boolean`	Set to `true` if the shipment is international Optional
`isFreight` Is Freight	`boolean`	Set to `true` if the shipment is freight 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: deftship-get-insurance-rate
Version: 0.0.3
App: Deftship
Authentication: API key
Read-only: Yes
Destructive: No
Open world: Yes
Source: View on GitHub ↗

Call this tool #

Inputs #

Tool details #

Call this tool

Inputs

Tool details