View as Markdown
Returnless icon

Returnless ACTION

List Return Orders

Retrieve a list of return orders. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Returnless account once, then configure and run List Return Orders 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: "returnless-list-return-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    returnless: { authProvisionId: "apn_xxxxxxx" },
    returnType: "Return Type",
    createdAfter: "Created After",
  },
})

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 Return Orders inputs
Property Type Description
returnType Return Type string
The type of return orders to retrieve
Optional
createdAfter Created After string
Only return return-orders that were created after the given date. Example: 2025-01-01T00:00:00+00:00
Optional
createdBefore Created Before string
Only return return-orders that were created before the given date. Example: 2025-01-10T00:00:00+00:00
Optional
updatedAfter Updated After string
Only return return-orders that were updated after the given date. Example: 2025-01-01T00:00:00+00:00
Optional
updatedBefore Updated Before string
Only return return-orders that were updated before the given date. Example: 2025-01-10T00:00:00+00:00
Optional
finalizedAfter Finalized After string
Only return return-orders that were finalized after the given date. Example: 2025-01-01T00:00:00+00:00
Optional
finalizedBefore Finalized Before string
Only return return-orders that were finalized before the given date. Example: 2025-01-10T00:00:00+00:00
Optional
orderDateAfter Order Date After string
Only return return-orders that were ordered after the given date. Example: 2025-01-01T00:00:00+00:00
Optional
orderDateBefore Order Date Before string
Only return return-orders that were ordered before the given date. Example: 2025-01-10T00:00:00+00:00
Optional
returnNumber Return Order Number string
The number of a return order to filter by
Optional Dynamic
orderNumber Order Number string
The number of the sales order to filter by
Optional Dynamic
returnStatus Return Status ID string
The ID of the return status to filter by
Optional Dynamic
requestStatus Request Status ID string
The ID of the request status to filter by
Optional Dynamic
maxResults Max Results integer
The maximum number of results to return
Optional
sort Sort string
The field to sort the return-orders 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
returnless-list-return-orders
Version
0.0.4
App
Returnless
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes