View as Markdown
Shopify  icon

Shopify ACTION

Create Custom Collection

Create a new custom collection. 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 Custom Collection 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-custom-collection",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    title: "Title",
    products: ["Product ID"],
  },
})

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 Custom Collection inputs
Property Type Description
title Title string
The name of the custom collection
Required
products Product ID string[]
The identifier of a product
Optional Dynamic
metafields Metafields string[]
An array of objects, each one representing a metafield. If adding a new metafield, the object should contain key, value, type, and namespace. Example: {{ [{ "key": "new", "value": "newvalue", "type": "single_line_text_field", "namespace": "global" }] }}. To update an existing metafield, use the id and value. Example: {{ [{ "id": "28408051400984", "value": "updatedvalue" }] }}
Optional
imageUrl Image URL string
The source URL that specifies the location of the image
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-custom-collection
Version
0.0.17
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes