View as Markdown
Lightspeed eCom (C-Series) icon

Lightspeed eCom (C-Series) ACTION

Get Shipment

Get a shipment by ID. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Lightspeed eCom (C-Series) account once, then configure and run Get Shipment 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: "lightspeed_ecom_c_series-get-shipment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    lightspeed_ecom_c_series: { authProvisionId: "apn_xxxxxxx" },
    shipmentId: "Shipment 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 Shipment inputs
Property Type Description
shipmentId Shipment ID string
Retrieve a shipment based on the shipment ID
Required Dynamic

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
lightspeed_ecom_c_series-get-shipment
Version
0.0.1
App
Lightspeed eCom (C-Series)
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes