View as Markdown
Shopify  icon

Shopify ACTION

Get Draft Orders

Retrieve a list of draft 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 Get Draft 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-get-draft-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.

Get Draft Orders inputs
Property Type Description
query Query string
Filter draft orders using Shopify API search syntax. Available filters: created_at (time), customer_id (id), id (id with range support like id:>=1234), status (string, e.g., status:OPEN), tag (string), updated_at (time), source (string), or default search (case-insensitive multi-field search). Examples: status:OPEN, created_at:>2019-12-01, customer_id:544365967, tag:fraud. See the documentation
Optional
sortKey Sort Key string
The key to sort the results by. Options: CREATED_AT, ID, NUMBER, STATUS, TOTAL_PRICE, UPDATED_AT, CUSTOMER_NAME
Optional
maxResults Max Results integer
The maximum number of results to return
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-get-draft-orders
Version
0.0.10
App
Shopify
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes