View as Markdown
Lightspeed eCom (C-Series) icon

Lightspeed eCom (C-Series) ACTION

Find Shipment

Find 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 Find 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-find-shipment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    lightspeed_ecom_c_series: { authProvisionId: "apn_xxxxxxx" },
    customerId: "Customer ID",
    orderNumber: "Order Number",
  },
})

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.

Find Shipment inputs
Property Type Description
customerId Customer ID string
Retrieve all shipments from a specific customer based on the customerid
Optional Dynamic
orderNumber Order Number string
Retrieve a shipment based on the order number
Optional Dynamic
shipmentNumber Shipment Number string
Retrieve a shipment based on the shipment number
Optional Dynamic
sinceId Since ID string
Restrict results to after the specified ID
Optional
createdAtMin Created At Min string
Show shipments created after date. Format: YYYY-MM-DD HH:MM:SS
Optional
createdAtMax Created At Max string
Show shipments created before date. Format: YYYY-MM-DD HH:MM:SS
Optional
updatedAtMin Updated At Min string
Show shipments last updated after date. Format: YYYY-MM-DD HH:MM:SS
Optional
updatedAtMax Updated At Max string
Show shipments last updated before date. Format: YYYY-MM-DD HH:MM:SS
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
lightspeed_ecom_c_series-find-shipment
Version
0.0.1
App
Lightspeed eCom (C-Series)
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes