# Search Orders — Commerce Tools

> Search Orders using the Order Search API. The endpoint must be activated and indexed for your Project first - run the Change Order Search Status action to enable it, then the Reindex Orders action to build the index. See the documentation.

- Key: `commerce_tools-search-orders`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Commerce Tools (`commerce_tools`) — https://pipedream.com/apps/commerce-tools.md
- This page (HTML): https://pipedream.com/apps/commerce-tools/actions/search-orders
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/commerce_tools/actions/search-orders/search-orders.mjs

## Description

Search Orders using the Order Search API. The endpoint must be [activated and indexed](https://docs.commercetools.com/api/projects/order-search#activation-of-the-api) for your Project first - run the **Change Order Search Status** action to enable it, then the **Reindex Orders** action to build the index. [See the documentation](https://docs.commercetools.com/api/projects/order-search#search-orders).

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `query` | `object` | Yes | The Order search query as a JSON object. For example: { "exact": { "field": "orderState", "value": "Open" } }. |
| `sort` | `string[]` | No | An array of OrderSearchSorting objects, each added as a separate JSON string controlling how results are sorted. For example: { "field": "createdAt", "order": "desc" }. |
| `limit` | `integer` | No | The maximum number of search results to return (max 100). |
| `offset` | `integer` | No | The number of results to skip (for pagination). |

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

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: "commerce_tools-search-orders",
  arguments: {
    query: "Query",
    sort: ["Sort"],
  },
})
```

**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: "commerce_tools-search-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    commerce_tools: { authProvisionId: "apn_xxxxxxx" },
    query: "Query",
    sort: ["Sort"],
  },
})

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": "commerce_tools-search-orders",
    "configured_props": {
      "commerce_tools": { "authProvisionId": "apn_xxxxxxx" },
      "query": "Query",
      "sort": ["Sort"]
    }
  }'
```

---

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