Shopify ACTION
Refund Return
Processes an existing return in Shopify via the
returnProcess mutation, marking the specified return line items as processed. By default no refund is issued — to also issue a refund, include a financialTransfer object with an issueRefund operation (and its required orderTransactions) in Additional Fields. See the documentation.- Action
- Writes data
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Shopify account once, then configure and run Refund Return 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-refund-return",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
shopify: { authProvisionId: "apn_xxxxxxx" },
returnId: "Return ID",
returnLineItems: "Return Line Items",
},
})
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-refund-return",
"configured_props": {
"shopify": { "authProvisionId": "apn_xxxxxxx" },
"returnId": "Return ID",
"returnLineItems": "Return Line Items"
}
}'// 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-refund-return",
arguments: {
returnId: "Return ID",
returnLineItems: "Return Line Items",
},
})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 |
|---|---|---|
returnId Return ID | string | The return GID to refund, in the format gid://shopify/Return/222. Obtain this from the Create Return action output or by inspecting an order's returns. Required |
returnLineItems Return Line Items | string | JSON array of return line items to process. Each item accepts id (the ReturnLineItem GID) and quantity. Example: [{"id": "gid://shopify/ReturnLineItem/333", "quantity": 1}]. Required |
notifyCustomer Notify Customer | boolean | Whether to notify the customer about the refund. Optional |
additionalFields Additional Fields | object | JSON object of additional ReturnProcessInput fields (e.g. refundShipping, refundDuties, note, or financialTransfer to issue a refund). Example: {"refundShipping": {"fullRefund": true}}. 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-refund-return
- Version
- 0.1.2
- App
- Shopify
- Authentication
- OAuth
- Read-only
- No
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗