View as Markdown
Paazl icon

Paazl ACTION

Create Shipment For Order

Generates a shipment at the carrier for the shipping option specified in POST order. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Paazl account once, then configure and run Create Shipment For 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: "paazl-create-shipment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    paazl: { authProvisionId: "apn_xxxxxxx" },
    orderReference: "Reference",
    type: "Label Type",
  },
})

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 For Order inputs
Property Type Description
orderReference Reference string
Your reference for the order
Required
type Label Type string
Format of the generated label(s)
Required
size Label Size string
Size of the generated label(s)
Required
quantity Quantity integer
Optional. If Quantity is 1 then one extra label is generated. If Quantity is greater than 1, extra labels are generated. Mutually exclusive with parcels.
Optional
enableParcels Enable Custom Parcels boolean
Enable to specify custom parcel details (mutually exclusive with quantity)
Optional
parcelWeight Parcel Weight string
The gross weight of the parcel in kilograms (required if enabling parcels)
Optional
parcelLength Parcel Length integer
The length of the parcel in centimeters
Optional
parcelWidth Parcel Width integer
The width of the parcel in centimeters
Optional
parcelHeight Parcel Height integer
The height of the parcel in centimeters
Optional
parcelVolume Parcel Volume string
The volume of the parcel, including packaging, in cubic meters
Optional
parcelReference Parcel Reference string
A reference for the parcel
Optional
parcelDescription Parcel Description string
A general description of the contents of the parcel
Optional
parcelCodValue Parcel COD Value string
The amount that has to be paid by receiver before receiving the goods
Optional
parcelCodCurrency Parcel COD Currency string
The ISO 4217 code for the currency (default: EUR)
Optional
parcelInsuredValue Parcel Insured Value string
The amount for which this is insured by the carrier
Optional
parcelInsuredCurrency Parcel Insured Currency string
The ISO 4217 code for the currency (default: EUR)
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
paazl-create-shipment
Version
0.0.2
App
Paazl
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes