View as Markdown
Orderspace icon

Orderspace ACTION

List Customers

List a list of customers. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Orderspace account once, then configure and run List Customers 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: "orderspace-list-customers",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    orderspace: { authProvisionId: "apn_xxxxxxx" },
    createdSince: "Created Since",
    companyName: "Company 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.

List Customers inputs
Property Type Description
createdSince Created Since string
Return records created since the given date and time in ISO 8601 format, e.g. 2019-10-29T21:00
Optional
companyName Company Name string
Return customers with the specified company name
Optional
buyersEmailAddress Buyer's Email Address string
Return customers with the specified buyers email address
Optional
status Status string
Return customers with the specified status
Optional
reference Reference string
Return customers with the specified reference
Optional
paymentTermId Payment Term ID string
Return customers with the specified payment terms
Optional Dynamic
customerGroupId Customer Group ID string
Return customers in the specified group
Optional Dynamic
priceListId Price List ID string
Return customers with the specified price list
Optional Dynamic
maxResults Max Results integer
The maximum number of results to return. The default is 50 and the maximum limit is 200
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
orderspace-list-customers
Version
0.0.2
App
Orderspace
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes