Shopify ACTION
Cancel Order
Cancel an existing order. Run Search for Orders first to obtain the order GID. 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 Cancel 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-cancel-order",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
shopify: { authProvisionId: "apn_xxxxxxx" },
orderId: "Order ID",
reason: "Reason",
},
})
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": "shopify-cancel-order",
"configured_props": {
"shopify": { "authProvisionId": "apn_xxxxxxx" },
"orderId": "Order ID",
"reason": "Reason"
}
}'// 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": "shopify",
},
},
},
)
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: "shopify-cancel-order",
arguments: {
orderId: "Order ID",
reason: "Reason",
},
})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 |
|---|---|---|
orderId Order ID | string | The GID of the order to cancel, e.g. gid://shopify/Order/820982911946154508. Run Search for Orders first to find the order ID. Required |
reason Reason | string | The reason for cancelling the order. One of CUSTOMER, DECLINED, FRAUD, INVENTORY, OTHER, STAFF. Required |
restock Restock | boolean | Whether to restock the inventory committed to the order. Required |
notifyCustomer Notify Customer | boolean | Whether to send a notification to the customer about the cancellation. Optional |
staffNote Staff Note | string | An optional staff note about the cancellation (max 255 characters, not visible to the customer). Maps to the staffNote mutation argument. 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-cancel-order
- Version
- 0.0.6
- App
- Shopify
- Authentication
- OAuth
- Read-only
- No
- Destructive
- Yes
- Open world
- Yes
- Source
- View on GitHub ↗