View as Markdown
Everstox icon

Everstox ACTION

List Returns

List returns from Everstox. 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 Returns 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-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)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

List Returns inputs
Property Type Description
orderNumber Order Number string
The number of the order
Optional Dynamic
rmaNumber RMA Number string
Filter by RMA number
Optional
updatedDateGte Updated Date Greater Than or Equal To string
Filter returns with updated date greater than or equal to the provided date. Example: 2021-02-23
Optional
updatedDateLte Updated Date Less Than or Equal To string
Filter returns with updated date less than or equal to the provided date. Example: 2021-02-23
Optional
createdDateGte Created Date Greater Than or Equal To string
Filter returns with created date greater than or equal to the provided date. Example: 2021-02-23
Optional
createdDateLte Created Date Less Than or Equal To string
Filter returns with created date less than or equal to the provided date. Example: 2021-02-23
Optional
returnReviewed Return Reviewed boolean
Filter returns by return reviewed status
Optional
productSku Product SKU string
Filter returns by product SKU
Optional
limit Limit integer
The number of items to return (default 10)
Optional
offset Offset integer
The number of items to skip before starting to collect the result set
Optional
orderBy Order By string
The field to order by
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-returns
Version
0.0.3
App
Everstox
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes