# List Products — SureCart

> Return a list of products. See the documentation

- Key: `surecart-list-products`
- Type: Action (Read-only)
- Version: 1.0.0
- App: SureCart (`surecart`) — https://pipedream.com/apps/surecart.md
- This page (HTML): https://pipedream.com/apps/surecart/actions/list-products
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/surecart/actions/list-products/list-products.mjs

## Description

Return a list of products. [See the documentation](https://developer.surecart.com/api-reference/products/list)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `adHoc` | `boolean` | No | Filter for products with prices that allow ad hoc (custom) amounts. |
| `archived` | `boolean` | No | Filter products by archived status. |
| `downloadable` | `boolean` | No | Filter for products that have associated downloads. |
| `featured` | `boolean` | No | Filter for featured products only. |
| `ids` | `string[]` | No | Filter by specific IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56", "8f1e2d3c-4b5a-6789-0c1d-2e3f4a5b6c7d"] |
| `maxResults` | `integer` | No | The maximum total number of results to return across all pages. Example: 100 |
| `productCollectionIds` | `string[]` | No | Filter products by collection IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] |
| `productGroupIds` | `string[]` | No | Filter products by group IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] |
| `query` | `string` | No | Full-text search query to filter products by name. Example: Premium |
| `recurring` | `boolean` | No | Set to true to return only recurring (subscription) products, or false for one-time products. |
| `shippingEnabled` | `boolean` | No | Filter for products that have shipping enabled. |
| `shippingProfileIds` | `string[]` | No | Filter products by shipping profile IDs. Example: ["b47ca4c2-6cd2-41d5-aefb-4dc459642c56"] |
| `status` | `string[]` | No | Filter products by status. Example: ["published"] |
| `sort` | `string` | No | Sort results by the specified field. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "surecart",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "surecart-list-products",
  arguments: {
    adHoc: true,
    archived: true,
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "surecart-list-products",
    "configured_props": {
      "surecart": { "authProvisionId": "apn_xxxxxxx" },
      "adHoc": true,
      "archived": true
    }
  }'
```

---

- App: https://pipedream.com/apps/surecart.md · All apps: https://pipedream.com/apps