# List Products — ShipHero

> List products. See the documentation

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

## Description

List products. [See the documentation](https://developer.shiphero.com/getting-started/)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `sku` | `string` | No | The SKU of the product. |
| `createdFrom` | `string` | No | The date the product was created from. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg. YYYY-mm-dd YYYY-mm-dd HH:MM:SS YYYY-mm-ddTHH:MM:SS |
| `createdTo` | `string` | No | The date the product was created to. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg. YYYY-mm-dd YYYY-mm-dd HH:MM:SS YYYY-mm-ddTHH:MM:SS |
| `updatedFrom` | `string` | No | The date the product was updated from. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg. YYYY-mm-dd YYYY-mm-dd HH:MM:SS YYYY-mm-ddTHH:MM:SS |
| `updatedTo` | `string` | No | The date the product was updated to. A DateTime field type that understand ISO 8601 strings, besides datetime objects. It supports strings with and without times, as well as using T or space as delimiter Eg. YYYY-mm-dd YYYY-mm-dd HH:MM:SS YYYY-mm-ddTHH:MM:SS |
| `customerAccountId` | `string` | No | The ID of the customer account. |
| `hasKits` | `boolean` | No | Whether the product has kits. |
| `analyze` | `boolean` | No | Whether to analyze the product. |

## 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": "shiphero",
      },
    },
  },
)

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: "shiphero-list-products",
  arguments: {
    sku: "SKU",
    createdFrom: "Created From",
  },
})
```

**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: "shiphero-list-products",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    shiphero: { authProvisionId: "apn_xxxxxxx" },
    sku: "SKU",
    createdFrom: "Created From",
  },
})

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": "shiphero-list-products",
    "configured_props": {
      "shiphero": { "authProvisionId": "apn_xxxxxxx" },
      "sku": "SKU",
      "createdFrom": "Created From"
    }
  }'
```

---

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