Everstox ACTION
List Products
List products in an Everstox shop. Use this to browse or audit the product catalog, check inventory by SKU or name, or filter by warehouse. Results default to 10 per page — use
limit and offset together to paginate through large catalogs. See the documentation- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Everstox account once, then configure and run List Products from your backend or agent.
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-products",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
everstox: { authProvisionId: "apn_xxxxxxx" },
search: "Search",
sku: ["SKUs"],
},
})
console.log(result)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-products",
"configured_props": {
"everstox": { "authProvisionId": "apn_xxxxxxx" },
"search": "Search",
"sku": ["SKUs"]
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{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-products",
arguments: {
search: "Search",
sku: ["SKUs"],
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
search Search | string | Search for name or SKU Optional |
sku SKUs | string[] | Filter products by SKU. If the number of SKUs exceeds 10, exact_search is enforced Optional |
name Name | string | Filter products by name Optional |
gtin GTIN | string | Filter products by GTIN — returns products with at least one unit whose GTIN contains this value Optional |
customAttributeKey Custom Attribute Key | string | Filter products by custom attribute key — returns products with at least one custom attribute whose key contains this value Optional |
customAttributeValue Custom Attribute Value | string | Filter products by custom attribute value — returns products with at least one custom attribute whose value contains this value Optional |
status Status | string | Filter products by status (default all) Optional |
bundleProduct Bundle Product | boolean | Filter for bundle products Optional |
exactSearch Exact Search | boolean | If true, searches for exact SKU and name matches (default true) Optional |
stockRunwayLte Stock Runway Less Than or Equal To | integer | Filter for stocks with runway lower than or equal to the number of days provided Optional |
stockRunwayLt Stock Runway Less Than | integer | Filter for stocks with runway lower than the number of days provided Optional |
stockRunwayGte Stock Runway Greater Than or Equal To | integer | Filter for stocks with runway greater than or equal to the number of days provided Optional |
warehouseIds Warehouse IDs | string[] | Warehouse IDs Optional Dynamic |
orderBy Order By | string | Fields to order the result set by Optional |
fields Fields | string | Fields to include in the response Optional |
fieldSet Field Set | string | full includes all sub-entities (default); minimal returns essential fields optimized for performance Optional |
limit Limit | integer | The number of products to return (default 10) Optional |
offset Offset | integer | The number of products to skip before starting to collect the result set Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- everstox-list-products
- Version
- 0.0.2
- App
- Everstox
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗