View as Markdown
Shopify  icon

Shopify ACTION

Search for Orders

Search for an order or a list of orders. 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 Orders 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-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    sortKey: "Sort Key",
  },
})

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 Orders inputs
Property Type Description
query Query string
The search query. See the documentation
Optional
sortKey Sort Key string
The key to sort the results by
Optional
reverse Sort Descending boolean
Sort the results in descending order. Defaults to ascending
Optional
max Max Records integer
Optionally limit the maximum number of records to return. Leave blank to retrieve all records.
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-orders
Version
0.0.10
App
Shopify
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes