# Hold Fulfillment Order — Shopify 

> 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.

- Key: `shopify-hold-fulfillment-order`
- Type: Action (Write)
- Version: 0.0.5
- App: Shopify  (`shopify`) — https://pipedream.com/apps/shopify.md
- This page (HTML): https://pipedream.com/apps/shopify/actions/hold-fulfillment-order
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/shopify/actions/hold-fulfillment-order/hold-fulfillment-order.mjs

## Description

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](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentOrderHold).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `fulfillmentOrderId` | `string` | Yes | The identifier of a fulfillment order Options are loaded from the connected account. |
| `reason` | `string` | Yes | The reason for the hold. One of the Shopify FulfillmentHoldReason values, e.g. AWAITING_PAYMENT, INCORRECT_ADDRESS, or INVENTORY_OUT_OF_STOCK. |
| `reasonNotes` | `string` | No | Free-form notes explaining the hold reason. |
| `notifyMerchant` | `boolean` | No | Whether to notify the merchant about the hold. |

## 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": "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-hold-fulfillment-order",
  arguments: {
    fulfillmentOrderId: "Fulfillment Order ID",
    reason: "Reason",
  },
})
```

**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: "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)
```

**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": "shopify-hold-fulfillment-order",
    "configured_props": {
      "shopify": { "authProvisionId": "apn_xxxxxxx" },
      "fulfillmentOrderId": "Fulfillment Order ID",
      "reason": "Reason"
    }
  }'
```

---

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