View as Markdown
Shopify  icon

Shopify ACTION

Update Order

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

IMPLEMENTATION

Call this tool

Connect a user's Shopify 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: "shopify-update-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    orderId: "Order ID",
    email: "Email",
  },
})

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 identifier of an order
Required Dynamic
email Email string
The email address associated with the order
Optional
note Note string
An optional note to attach to the order
Optional
tags Tags string[]
An array of tags to add
Optional
metafields Metafields string[]
An array of objects, each one representing a metafield. If adding a new metafield, the object should contain key, value, type, and namespace. Example: {{ [{ "key": "new", "value": "newvalue", "type": "single_line_text_field", "namespace": "global" }] }}. To update an existing metafield, use the id and value. Example: {{ [{ "id": "28408051400984", "value": "updatedvalue" }] }}
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
shopify-update-order
Version
0.0.9
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes