View as Markdown
Shopify  icon

Shopify ACTION

Get Discount Code

Retrieves a single discount code that belongs to a price rule in Shopify. Run List Price Rules to find a valid price rule ID and List Discount Codes to find 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 Get Discount Code 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-discount-code",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shopify: { authProvisionId: "apn_xxxxxxx" },
    priceRuleId: "Price Rule ID",
    discountCodeId: "Discount Code 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.

Get Discount Code 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
discountCodeId Discount Code ID string
The ID of the discount code (e.g. 9876543210). Run List Discount Codes first to retrieve valid IDs for the chosen price rule.
Required

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-discount-code
Version
0.0.4
App
Shopify
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes