View as Markdown
Shopify  icon

Shopify ACTION

Search for Product Variant

Search for product variants or create one if not found. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shopify account once, then configure and run Search for Product Variant 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-search-product-variant",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    productId: "Product ID",
    productVariantId: "Product Variant 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.

Search for Product Variant inputs
Property Type Description
productId Product ID string
The identifier of a product
Required Dynamic
productVariantId Product Variant ID string
ID of the product variant. Takes precedence over Title
Optional Dynamic
title Title string
The name of the product variant
Optional
createIfNotFound Create If Not Found boolean
Creates the product variant with Title and the fields below if not found
Optional
optionIds Options string[]
The product options to apply to the product variant
Required Dynamic

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-search-product-variant
Version
0.0.23
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes