View as Markdown
Orderspace icon

Orderspace ACTION

List Orders

List a list of orders. 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 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: "orderspace-list-orders",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    orderspace: { authProvisionId: "apn_xxxxxxx" },
    createdSince: "Created Since",
    createdBefore: "Created Before",
  },
})

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 Orders 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
createdBefore Created Before string
Return records created before the given date and time in ISO 8601 format, e.g. 2019-10-29T21:00
Optional
deliveryDateSince Delivery Date Since string
Return records with a delivery date since the given date and time in ISO 8601 format, e.g. 2019-10-29T21:00
Optional
deliveryDateBefore Delivery Date Before string
Return records with a delivery date before the given date and time in ISO 8601 format, e.g. 2019-10-29T21:00
Optional
number Number string
Return records with the specified number
Optional
status Status string
Return records with the specified status
Optional
reference Reference string
Return records with the specified reference
Optional
customerId Customer ID string
Return records with the specified customer
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-orders
Version
0.0.2
App
Orderspace
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes