View as Markdown
ShipStation icon

ShipStation ACTION

Create Order

Create a new order. See docs here
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ShipStation 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: "shipstation-create-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shipstation: { authProvisionId: "apn_xxxxxxx" },
    orderNumber: "Order Number",
    orderDate: "Order Date",
  },
})

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
orderNumber Order Number string
A user-defined order number used to identify an order.
Required
orderDate Order Date string
The date the order was placed. E.g. 2015-06-29T08:46:27.0000000
Required
orderStatus Order Status string
The order's status.
Required
billTo Bill To string
The recipients billing address. Use the Address model.
Required
shipTo Ship To string
The recipient's shipping address. Use the Address model.
Required
customerUsername Customer Username string
The customer's username. Note: This property needs to be defined in order to generate a customer profile
Optional
customerEmail Customer Email string
The customer's email address.
Optional Dynamic
items Items string[]
An array of item objects. Use an array of OrderItem models.
Optional
gift Gift boolean
Specifies whether or not this Order is a gift
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
shipstation-create-order
Version
0.0.3
App
ShipStation
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes