View as Markdown
Shopify  icon

Shopify ACTION

Update Product Variant

Update an existing product variant. See the documentation
  • Action
  • Writes data
  • Destructive
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shopify account once, then configure and run Update 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-update-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.

Update Product Variant inputs
Property Type Description
productId Product ID string
The identifier of a product
Required Dynamic
productVariantId Product Variant ID string
The identifier of a product variant
Required Dynamic
optionIds Options string[]
The product options to apply to the product variant
Optional Dynamic
price Price string
The price of the product variant
Optional
image Image string
The URL of an image to be added to the product variant
Optional
sku Sku string
A unique identifier for the product variant in the shop
Optional
barcode Barcode string
The barcode, UPC, or ISBN number for the product
Optional
weight Weight string
The weight of the product variant in the unit system specified with Weight Unit
Optional
weightUnit Weight Unit string
The unit of measurement that applies to the product variant's weight. If you don't specify a value for weight_unit, then the shop's default unit of measurement is applied.
Optional
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

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