View as Markdown
Shopify  icon

Shopify ACTION

Get Metafields

Retrieves a list of metafields that belong to a resource. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shopify account once, then configure and run Get Metafields 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-get-metafields",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    ownerResource: "Resource Type",
    namespace: ["Namespace"],
  },
})

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.

Get Metafields inputs
Property Type Description
ownerResource Resource Type string
Filter by the resource type on which the metafield is attached to
Required
namespace Namespace string[]
Filter results by namespace
Optional
key Key string[]
Filter results by key
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-get-metafields
Version
0.0.22
App
Shopify
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes