View as Markdown
ShipHero icon

ShipHero ACTION

Update Order

Update an order. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's ShipHero account once, then configure and run Update 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: "shiphero-update-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shiphero: { authProvisionId: "apn_xxxxxxx" },
    orderId: "Order ID",
    orderNumber: "Order Number",
  },
})

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.

Update Order inputs
Property Type Description
orderId Order ID string
The ID of the order.
Required Dynamic
orderNumber Order Number string
The order number.
Optional
partnerOrderId Partner Order ID string
The partner order ID.
Optional
fulfillmentStatus Fulfillment Status string
The fulfillment status.
Optional
orderDate Order Date string

The order date. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg.

  • YYYY-mm-dd
  • YYYY-mm-dd HH:MM:SS
  • YYYY-mm-ddTHH:MM:SS
Optional
totalTax Total Tax string
The total tax for the order.
Optional
subtotal Subtotal string
The subtotal for the order.
Optional
totalDiscounts Total Discounts string
The total discounts for the order.
Optional
totalPrice Total Price string
The total price for the order.
Optional
customInvoiceUrl Custom Invoice URL string
The custom invoice URL for the order.
Optional
profile Profile string
The profile for the order.
Optional
packingNote Packing Note string
The packing note for the order.
Optional
requiredShipDate Required Ship Date string

The required ship date for the order. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg.

  • YYYY-mm-dd
  • YYYY-mm-dd HH:MM:SS
  • YYYY-mm-ddTHH:MM:SS
Optional
tags Tags string[]
The tags for the order.
Optional
priorityFlag Priority Flag boolean
The priority flag for the order.
Optional
giftNote Gift Note string
The gift note for the 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
shiphero-update-order
Version
0.0.2
App
ShipHero
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes