View as Markdown
SureCart icon

SureCart ACTION

List Products

Return a list of products. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's SureCart account once, then configure and run List Products 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: "surecart-list-products",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    surecart: { authProvisionId: "apn_xxxxxxx" },
    adHoc: true,
    archived: true,
  },
})

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 Products inputs
Property Type Description
adHoc Ad Hoc boolean
Filter for products with prices that allow ad hoc (custom) amounts.
Optional
archived Archived boolean
Filter products by archived status.
Optional
downloadable Downloadable boolean
Filter for products that have associated downloads.
Optional
featured Featured boolean
Filter for featured products only.
Optional
ids IDs string[]
Filter by specific IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56", "8f1e2d3c-4b5a-6789-0c1d-2e3f4a5b6c7d"]
Optional
maxResults Max Results integer
The maximum total number of results to return across all pages. Example: 100
Optional
productCollectionIds Product Collection IDs string[]
Filter products by collection IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"]
Optional
productGroupIds Product Group IDs string[]
Filter products by group IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"]
Optional
query Query string
Full-text search query to filter products by name. Example: Premium
Optional
recurring Recurring boolean
Set to true to return only recurring (subscription) products, or false for one-time products.
Optional
shippingEnabled Shipping Enabled boolean
Filter for products that have shipping enabled.
Optional
shippingProfileIds Shipping Profile IDs string[]
Filter products by shipping profile IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"]
Optional
status Status string[]
Filter products by status. Example: ["published"]
Optional
sort Sort string
Sort results by the specified field.
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
surecart-list-products
Version
1.0.0
App
SureCart
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes