View as Markdown
Shopify  icon

Shopify ACTION

List Discount Codes

Lists all discount codes for a given price rule in Shopify so you can obtain a valid discount code ID. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Shopify account once, then configure and run List Discount Codes 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-list-discount-codes",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    priceRuleId: "Price Rule ID",
    limit: 10,
  },
})

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.

List Discount Codes inputs
Property Type Description
priceRuleId Price Rule ID string
The ID of the price rule (e.g. 1234567890). Run List Price Rules first to retrieve valid IDs.
Required
limit Limit integer
Maximum number of discount codes to return. When omitted, all codes for the price rule are returned.
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-list-discount-codes
Version
0.0.4
App
Shopify
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes