View as Markdown
Returnista icon

Returnista ACTION

Get Return Requests

Gets a list of return requests for the given account. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Returnista account once, then configure and run Get Return Requests 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: "returnista-get-return-requests",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    returnista: { authProvisionId: "apn_xxxxxxx" },
    accountId: "Account ID",
    limit: 10,
  },
})

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.

Get Return Requests inputs
Property Type Description
accountId Account ID string
The unique identifier of your Returnista account. Find this in the Returnista dashboard under account settings.
Required
limit Limit integer
The number of objects to return per page
Optional
page Page integer
The page number to return
Optional
filter Filter string
A filter to apply to the results. Supports filtering by purchaseOrderNumber, status, createdAt, updatedAt, store, and other fields. For date filters, use operators: >, <, >=, <= (e.g., createdAt>2024-05-24T12:05:15.264Z). For other filters, use colon format (e.g., purchaseOrderNumber:12345 or status:draft)
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
returnista-get-return-requests
Version
0.0.2
App
Returnista
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes