View as Markdown
Orderspace icon

Orderspace ACTION

Create Dispatch

Create a new dispatch. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Orderspace account once, then configure and run Create Dispatch 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: "orderspace-create-dispatch",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    orderspace: { authProvisionId: "apn_xxxxxxx" },
    orderId: "Order ID",
    comments: "Comments",
  },
})

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 Dispatch inputs
Property Type Description
orderId Order ID string
The ID of an order
Required Dynamic
comments Comments string
The comments to add to the dispatch
Optional
dispatchLines Dispatch Lines string[]
The lines of the dispatch. Each line should contain values for sku and quantity. See the documentation for information.
Required

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
orderspace-create-dispatch
Version
0.0.2
App
Orderspace
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes