View as Markdown
Orderspace icon

Orderspace ACTION

Create Order

Create a new order. 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 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: "orderspace-create-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    orderspace: { authProvisionId: "apn_xxxxxxx" },
    customerId: "Customer ID",
    shippingAddressLine1: "Address Line 1",
  },
})

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 Order inputs
Property Type Description
customerId Customer ID string
The ID of a customer
Required Dynamic
shippingAddressLine1 Address Line 1 string
The first line of the shipping address
Required
shippingAddressLine2 Address Line 2 string
The second line of the shipping address
Optional
shippingCity City string
The city of the shipping address
Required
shippingState State string
The state of the shipping address
Required
shippingPostalCode Postal Code string
The postal code of the shipping address
Required
shippingCountry Country string
The 2 letter country code of the shipping address
Required
billingAddressLine1 Address Line 1 string
The first line of the billing address
Required
billingAddressLine2 Address Line 2 string
The second line of the billing address
Optional
billingCity City string
The city of the billing address
Required
billingState State string
The state of the billing address
Required
billingPostalCode Postal Code string
The postal code of the billing address
Required
billingCountry Country string
The 2 letter country code of the billing address
Required
orderLines Order Lines string[]
The lines of the order. See the documentation for information about line format.
Required
deliveryDate Delivery Date string
The date the order is due (YYYY-MM-DD)
Optional
reference Reference string
The reference for the order
Optional
internalNote Internal Note string
An internal note for the order
Optional
customerPoNumber Customer PO Number string
The customer's purchase order number for this order
Optional
customerNote Customer Note string
The customer's note on this 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
orderspace-create-order
Version
0.0.2
App
Orderspace
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes