# Search Products — Akeneo

> Search products from Akeneo. See the documentation

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

## Description

Search products from Akeneo. [See the documentation](https://api.akeneo.com/api-reference.html#get_products)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `search` | `string` | No | Filter products, for more details see the Filters section |
| `scope` | `string` | No | Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section Options are loaded from the connected account. |
| `locales` | `string` | No | Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section Options are loaded from the connected account. |
| `attributes` | `string` | No | Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section Options are loaded from the connected account. |
| `convertMeasurements` | `boolean` | No | Convert values of measurement attributes to the unit configured in the channel provided by the parameter "scope". Therefore, this parameter requires the "scope" parameter to be provided. |
| `withCount` | `boolean` | No | Return the count of items in the response. Be careful: on large catalogs, enabling counts can significantly impact performance. |
| `withAttributeOptions` | `boolean` | No | Return labels of attribute options in the response. See thelinked_data format section for more details. |
| `withAssetShareLinks` | `boolean` | No | Return asset collection share link urls in the response. See the linked_data format section for more details. |
| `withQualityScores` | `boolean` | No | Return product quality scores in the response |
| `withCompletenesses` | `boolean` | No | Return product completenesses in the response |
| `page` | `integer` | No | The page number to return |
| `limit` | `integer` | No | The number of items to return per page |

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

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: "akeneo-search-products",
  arguments: {
    search: "Search",
    scope: "Scope",
  },
})
```

**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: "akeneo-search-products",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    akeneo: { authProvisionId: "apn_xxxxxxx" },
    search: "Search",
    scope: "Scope",
  },
})

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": "akeneo-search-products",
    "configured_props": {
      "akeneo": { "authProvisionId": "apn_xxxxxxx" },
      "search": "Search",
      "scope": "Scope"
    }
  }'
```

---

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