View as Markdown
Shopify  icon

Shopify ACTION

Create Return

Creates a return for an order. 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 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-create-return",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    orderId: "Order ID",
    returnLineItems: "Return 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 Return inputs
Property Type Description
orderId Order ID string
The identifier of an order
Required Dynamic
returnLineItems Return Line Items string
JSON array of return line items. Each item requires fulfillmentLineItemId (GID), quantity, and returnReason (a required ReturnReason enum value: UNKNOWN, DEFECTIVE, NOT_AS_DESCRIBED, WRONG_ITEM, UNWANTED, SIZE_TOO_SMALL, SIZE_TOO_LARGE, STYLE, COLOR, or OTHER). When returnReason is OTHER, also provide returnReasonNote. Example: [{"fulfillmentLineItemId": "gid://shopify/FulfillmentLineItem/111", "quantity": 1, "returnReason": "UNKNOWN"}].
Required
additionalReturnFields Additional Return Fields object
JSON object of additional fields such as exchangeLineItems, requestedAt, or returnShippingFee. Example: {"requestedAt": "2026-01-15T00:00:00Z"}.
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-return
Version
0.0.5
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes