View as Markdown
Snipcart icon

Snipcart ACTION

Update Discount

Update a Discount. See the documentation
  • Action
  • Writes data
  • Destructive
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Snipcart account once, then configure and run Update Discount 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: "snipcart-update-discount",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    snipcart: { authProvisionId: "apn_xxxxxxx" },
    discountId: "Discount ID",
    name: "Name",
  },
})

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.

Update Discount inputs
Property Type Description
discountId Discount ID string
ID of the Discount
Required Dynamic
name Name string
Name of the discount
Optional
trigger Trigger string
Condition that will trigger the discount
Optional
code Code string
Code for the discount
Optional
totalToReach Total to Reach string
Minimum amount required to activate the discount. Required when discount Trigger is FixedAmount
Optional
type Type string
The type of action that the discount will apply to
Optional
amount Amount string
Discount amount. Required when discount type is FixedAmount
Optional
rate Rate string
Discount percentage, i.e.: 10. Required when discount type is Rate
Optional
maxNumberOfUsages Max Number of Usages integer
The maximum number of usage for the discount. If not specified, customers will be able to use this discount indefinitely.
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
snipcart-update-discount
Version
0.0.2
App
Snipcart
Authentication
API key
Read-only
No
Destructive
Yes
Open world
Yes