View as Markdown
Universal API icon

Universal API ACTION

Get Distributor Order

Retrieve a single distributor order by ID from Universal API. Run List Distributor Orders first to discover valid IDs. See the documentation.
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Universal API account once, then configure and run Get Distributor Order 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: "universal_api-get-distributor-order",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    universal_api: { authProvisionId: "apn_xxxxxxx" },
    consumerId: "Consumer ID",
    orderId: "Order ID",
  },
})

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 Distributor Order inputs
Property Type Description
consumerId Consumer ID string
The consumer ID. Run List Consumers first to find valid IDs.
Required
orderId Order ID string
The distributor order ID. Run List Distributor Orders first to find valid IDs.
Required
distributorServiceId Service ID string
x-uapi-service-id header identifying which Distributor integration to use (required by the API for this endpoint). One of: webmercs, netset.
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
universal_api-get-distributor-order
Version
0.0.2
App
Universal API
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes