View as Markdown
Billbee icon

Billbee ACTION

Add Shipment To Order

Add a shipment to an existing order. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Billbee account once, then configure and run Add Shipment To 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: "billbee-add-shipment-to-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    billbee: { authProvisionId: "apn_xxxxxxx" },
    orderId: "Order ID",
    shippingProviderId: "Shipping Provider ID",
  },
})

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.

Add Shipment To Order inputs
Property Type Description
orderId Order ID string
The ID of the order
Required Dynamic
shippingProviderId Shipping Provider ID string
The ID of the shipping provider
Optional Dynamic
shippingProviderProductId Shipping Provider Product ID string
The ID of the shipping provider product/service
Optional Dynamic
shippingId Shipping ID string
The ID of the shipment
Optional Dynamic
carrierId Carrier ID string
The ID of the carrier
Optional Dynamic
shipmentType Shipment Type string
The type of the shipment
Optional Dynamic
comment Comment string
Additional comment for the shipment
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
billbee-add-shipment-to-order
Version
0.0.3
App
Billbee
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes