View as Markdown
AmeriCommerce icon

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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Change Order Status inputs
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