# List Returns — Everstox

> List returns from Everstox. See the documentation

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

## Description

List returns from Everstox. [See the documentation](https://api.everstox.com/api/v1/ui/#/Returns%20V2/district_core.api.shops.returns_v2.returns_v2.ReturnsV2.index)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `orderNumber` | `string` | No | The number of the order Options are loaded from the connected account. |
| `rmaNumber` | `string` | No | Filter by RMA number |
| `updatedDateGte` | `string` | No | Filter returns with updated date greater than or equal to the provided date. Example: 2021-02-23 |
| `updatedDateLte` | `string` | No | Filter returns with updated date less than or equal to the provided date. Example: 2021-02-23 |
| `createdDateGte` | `string` | No | Filter returns with created date greater than or equal to the provided date. Example: 2021-02-23 |
| `createdDateLte` | `string` | No | Filter returns with created date less than or equal to the provided date. Example: 2021-02-23 |
| `returnReviewed` | `boolean` | No | Filter returns by return reviewed status |
| `productSku` | `string` | No | Filter returns by product SKU |
| `limit` | `integer` | No | The number of items to return (default 10) |
| `offset` | `integer` | No | The number of items to skip before starting to collect the result set |
| `orderBy` | `string` | No | The field to order by |

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

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: "everstox-list-returns",
  arguments: {
    orderNumber: "Order Number",
    rmaNumber: "RMA Number",
  },
})
```

**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: "everstox-list-returns",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    everstox: { authProvisionId: "apn_xxxxxxx" },
    orderNumber: "Order Number",
    rmaNumber: "RMA Number",
  },
})

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": "everstox-list-returns",
    "configured_props": {
      "everstox": { "authProvisionId": "apn_xxxxxxx" },
      "orderNumber": "Order Number",
      "rmaNumber": "RMA Number"
    }
  }'
```

---

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