View as Markdown
Deftship icon

Deftship ACTION

Create Parcel Order

Initializes a new parcel order within Deftship. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Deftship account once, then configure and run Create Parcel Order 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: "deftship-create-parcel-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    deftship: { authProvisionId: "apn_xxxxxxx" },
    fromName: "From Address: Name",
    fromStreet: "From Address: Street",
  },
})

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 Parcel Order inputs
Property Type Description
fromName From Address: Name string
The name in the sender address
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
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 From Address: Telephone string
The telephone number of the sender
Required
itemCount Count integer
Pieces count
Required
length Length string
Length of the parcel
Required
width Width string
Width of the parcel
Required
height Height string
Height of the parcel
Required
lengthUnit Length Unit string
By default, length unit is taken from your preferences. However, it can be overwritten using this field.
Optional
weight Weight string
Weight of the parcel
Required
weightUnit Weight Unit string
By default, weight unit is taken from your preferences. However, it can be overwritten using this field.
Optional
additionalFields Additional Fields object
An object of key/value pairs containing additional fields to add to the order
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-create-parcel-order
Version
0.0.2
App
Deftship
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes