View as Markdown
Shopify  icon

Shopify ACTION

Hold Fulfillment Order

Places a fulfillment order on hold. Run Search for Orders and inspect the order's fulfillment orders 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 Hold Fulfillment 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-hold-fulfillment-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    fulfillmentOrderId: "Fulfillment Order ID",
    reason: "Reason",
  },
})

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.

Hold Fulfillment Order inputs
Property Type Description
fulfillmentOrderId Fulfillment Order ID string
The identifier of a fulfillment order
Required Dynamic
reason Reason string
The reason for the hold. One of the Shopify FulfillmentHoldReason values, e.g. AWAITING_PAYMENT, INCORRECT_ADDRESS, or INVENTORY_OUT_OF_STOCK.
Required
reasonNotes Reason Notes string
Free-form notes explaining the hold reason.
Optional
notifyMerchant Notify Merchant boolean
Whether to notify the merchant about the hold.
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-hold-fulfillment-order
Version
0.0.5
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes