View as Markdown
Shopify  icon

Shopify ACTION

Update Inventory Level

Sets the on-hand inventory level for an inventory item at a location. 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 Inventory Level 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-inventory-level",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    locationId: "Location ID",
    productId: "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.

Update Inventory Level inputs
Property Type Description
locationId Location ID string
The ID of the location that the inventory level belongs to. Options will display the name of the Location ID
Required Dynamic
productId Product ID string
The identifier of a product
Required Dynamic
inventoryItemId Inventory Item ID string
The ID of the inventory item associated with the inventory level. There is a 1:1 relationship between a product variant and an inventory item. Each product variant includes the ID of its related inventory item. To view a list of Inventory Items, choose a product using the field above
Required Dynamic
available Available integer
Sets the available inventory quantity
Required
reason Reason string
The reason for the quantity changes
Required
referenceDocumentUri Reference Document URI string
A freeform URI that represents why the inventory change happened. This can be the entity adjusting inventory quantities or the Shopify resource that's associated with the inventory adjustment. For example, a unit in a draft order might have been previously reserved, and a merchant later creates an order from the draft order. In this case, the referenceDocumentUri for the inventory adjustment is a URI referencing the order ID.
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-inventory-level
Version
0.0.24
App
Shopify
Authentication
OAuth
Read-only
No
Destructive
Yes
Open world
Yes