# Change Order Status — AmeriCommerce

> Changes the status of an existing order. See the documentation.

- Key: `americommerce-change-order-status`
- Type: Action (Write)
- Version: 0.0.2
- App: AmeriCommerce (`americommerce`) — https://pipedream.com/apps/americommerce.md
- This page (HTML): https://pipedream.com/apps/americommerce/actions/change-order-status
- Hints: destructive · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/americommerce/actions/change-order-status/change-order-status.mjs

## Description

Changes the status of an existing order. [See the documentation](https://developers.cart.com/docs/rest-api/6898d9f254dfb-update-an-order-status).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `orderStatusId` | `string` | Yes | The ID of the order status. Options are loaded from the connected account. |
| `name` | `string` | No | The name of the order status. |
| `isOpen` | `boolean` | No | Indicates whether the order status is open. |
| `isDeclined` | `boolean` | No | Indicates whether the order status is declined. |
| `isCancelled` | `boolean` | No | Indicates whether the order status is cancelled. |
| `isShipped` | `boolean` | No | Indicates whether the order status is shipped. |
| `color` | `string` | No | The color of the order status. |
| `emailTemplateId` | `string` | No | The ID of the email template. Options are loaded from the connected account. |
| `isFullyRefunded` | `boolean` | No | Indicates whether the order status is fully refunded. |
| `isPartiallyRefunded` | `boolean` | No | Indicates whether the order status is partially refunded. |
| `isQuoteStatus` | `boolean` | No | Indicates whether the order status is a quote status. |
| `isPartiallyShipped` | `boolean` | No | Indicates whether the order status is partially shipped. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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",
  },
})
```

**TypeScript**

```ts
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**

```bash
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"
    }
  }'
```

---

- App: https://pipedream.com/apps/americommerce.md · All apps: https://pipedream.com/apps