AmeriCommerce ACTION
Change Order Status
Changes the status of an existing order. See the documentation.
- Action
- Writes data
- Destructive
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's AmeriCommerce account once, then configure and run Change Order Status 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: "americommerce-change-order-status",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
americommerce: { authProvisionId: "apn_xxxxxxx" },
orderStatusId: "Order Status ID",
name: "Name",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "americommerce-change-order-status",
"configured_props": {
"americommerce": { "authProvisionId": "apn_xxxxxxx" },
"orderStatusId": "Order Status ID",
"name": "Name"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "americommerce",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "americommerce-change-order-status",
arguments: {
orderStatusId: "Order Status ID",
name: "Name",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
orderStatusId Order Status ID | string | The ID of the order status. Required Dynamic |
name Name | string | The name of the order status. Optional |
isOpen Is Open | boolean | Indicates whether the order status is open. Optional |
isDeclined Is Declined | boolean | Indicates whether the order status is declined. Optional |
isCancelled Is Cancelled | boolean | Indicates whether the order status is cancelled. Optional |
isShipped Is Shipped | boolean | Indicates whether the order status is shipped. Optional |
color Color | string | The color of the order status. Optional |
emailTemplateId Email Template ID | string | The ID of the email template. Optional Dynamic |
isFullyRefunded Is Fully Refunded | boolean | Indicates whether the order status is fully refunded. Optional |
isPartiallyRefunded Is Partially Refunded | boolean | Indicates whether the order status is partially refunded. Optional |
isQuoteStatus Is Quote Status | boolean | Indicates whether the order status is a quote status. Optional |
isPartiallyShipped Is Partially Shipped | boolean | Indicates whether the order status is partially shipped. 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
- americommerce-change-order-status
- Version
- 0.0.2
- App
- AmeriCommerce
- Authentication
- API key
- Read-only
- No
- Destructive
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗