View as Markdown
Returnista icon

Returnista ACTION

Create Return Location

Creates a new return location (warehouse or depot address) for an account. Required: accountId, name, companyName, phoneNumber, street, houseNumber, city, postalCode, countryCode (ISO 3166-1 alpha-2, e.g. NL, DE, GB, US). Optional: suffix, stateProvinceCode, attention, contactName. To update a location after creation, use Update Return Location with the returned ID. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Returnista account once, then configure and run Create Return Location 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-create-return-location",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    returnista: { authProvisionId: "apn_xxxxxxx" },
    accountId: "Account ID",
    name: "Name",
  },
})

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.

Create Return Location 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
name Name string
The name of the return location
Required
companyName Company Name string
The company name associated with the return location
Required
street Street string
The street of the return location
Required
houseNumber House Number string
The house number of the return location
Required
suffix Suffix string
The suffix of the return location address
Optional
city City string
The city of the return location
Required
postalCode Postal Code string
The postal code of the return location
Required
countryCode Country Code string
The ISO 3166-1 alpha-2 country code of the return location (e.g., NL, DE, GB, US)
Required
stateProvinceCode State/Province Code string
The state or province code of the return location
Optional
attention Attention string
The attention line for the return location, typically used to direct the return to a specific department or individual
Optional
phoneNumber Phone Number string
The phone number associated with the return location (e.g., +31201234567)
Required
contactName Contact Name string
A contact person's name associated with the return location
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-create-return-location
Version
1.0.1
App
Returnista
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes