View as Markdown
Shopify  icon

Shopify ACTION

Create Metafield

Creates a metafield belonging to a resource. 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 Metafield 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-metafield",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    ownerResource: "Resource Type",
    name: "Name",
  },
})

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 Metafield inputs
Property Type Description
ownerResource Resource Type string
Filter by the resource type on which the metafield is attached to
Required
name Name string
The human-readable name for the metafield definition
Required
namespace Namespace string
A container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields with the same key name. Must have between 3-255 characters.
Required
key Key string
The key of the metafield. Keys can be up to 64 characters long and can contain alphanumeric characters, hyphens, underscores, and periods.
Required
type Type string
The type of data that the metafield stores in the value field. Refer to the list of supported types.
Required
pin Pin boolean
Whether to pin the metafield definition
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-metafield
Version
0.0.21
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes