View as Markdown
Shopify  icon

Shopify ACTION

Submit Cancellation Request

Request cancellation of a fulfillment order. This is a fulfillment-service workflow distinct from cancelling the order itself. Run Get Fulfillment Orders first to obtain the fulfillment order GID. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shopify account once, then configure and run Submit Cancellation Request 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-submit-cancellation-request",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    fulfillmentOrderId: "Fulfillment Order ID",
    message: "Message",
  },
})

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.

Submit Cancellation Request inputs
Property Type Description
fulfillmentOrderId Fulfillment Order ID string
The GID of the fulfillment order to request cancellation for, e.g. gid://shopify/FulfillmentOrder/1234567890. Run Get Fulfillment Orders first to find the fulfillment order ID.
Required
message Message string
An optional message for the fulfillment service explaining the cancellation request.
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-submit-cancellation-request
Version
0.0.6
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes