View as Markdown
PlentyONE icon

PlentyONE ACTION

Add Order Note

Adds a note to an order in PlentyONE. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's PlentyONE account once, then configure and run Add Order Note 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: "plentyone-add-order-note",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    plentyone: { authProvisionId: "apn_xxxxxxx" },
    orderId: "Order ID",
    text: "Note Text",
  },
})

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 Order Note inputs
Property Type Description
orderId Order ID string
ID of the order to retrieve documents for.
Required Dynamic
text Note Text string
The text of the note to add.
Required
isVisibleForContact Is Visible for Contact boolean
Whether the note is visible to the contact.
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
plentyone-add-order-note
Version
0.0.2
App
PlentyONE
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes