View as Markdown
Shopify  icon

Shopify ACTION

Create Refund

Create a refund on an existing order. Run Search for Orders first to obtain the order GID and the line item GIDs to refund. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shopify account once, then configure and run Create Refund 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-create-refund",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    orderId: "Order ID",
    refundLineItems: "Refund Line Items",
  },
})

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.

Create Refund inputs
Property Type Description
orderId Order ID string
The GID of the order to refund, e.g. gid://shopify/Order/820982911946154508. Run Search for Orders first to find the order ID.
Required
refundLineItems Refund Line Items string
Optional JSON array of line items to refund. Each object: lineItemId (GID, required), quantity (int, required), restockType (one of CANCEL, NO_RESTOCK, RETURN), locationId (GID, omit when NO_RESTOCK). Example: [{"lineItemId":"gid://shopify/LineItem/866550311766439020","quantity":1,"restockType":"RETURN"}]. Run Search for Orders to find line item GIDs.
Optional
notify Notify Customer boolean
Whether to send a refund notification to the customer.
Optional
note Note string
An optional note attached to the refund.
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-create-refund
Version
0.0.6
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes