Shopify ACTION
Search for Products
Search for products. See the documentation
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Shopify account once, then configure and run Search for Products 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-products",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
shopify: { authProvisionId: "apn_xxxxxxx" },
title: "Title",
exactMatch: true,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "shopify-search-products",
"configured_props": {
"shopify": { "authProvisionId": "apn_xxxxxxx" },
"title": "Title",
"exactMatch": true
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "shopify",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "shopify-search-products",
arguments: {
title: "Title",
exactMatch: true,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
title Title | string | The name of the product Optional |
exactMatch Exact Match | boolean | The product title search should be an exact match Optional |
productIds Product IDs | string[] | Select multiple Product IDs or provide Product IDs as a JSON array. For example: {{ ["gid://shopify/Product/1", "gid://shopify/Product/2"] }} Optional Dynamic |
collectionId Collection ID | string | The identifier of a collection Optional Dynamic |
productType Product Type | string | A categorization for the product used for filtering and searching products Optional |
vendor Vendor | string | The name of the product's vendor Optional |
maxResults Max Results | integer | The maximum number of results to return Optional |
sortKey Sort Key | string | The key to sort the results by. Keys RELEVANCE and INVENTORY_TOTAL not for use with Collection ID. Optional |
reverse Sort Descending | boolean | Sort the results in descending order. Defaults to ascending. 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-search-products
- Version
- 0.0.24
- App
- Shopify
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗