CONNECT APP
Build with Lightspeed eCom (C-Series)
Commerce
- API key
MCP
Give your agent Lightspeed eCom (C-Series) tools
Every Lightspeed eCom (C-Series) action is exposed as an MCP tool on Pipedream's remote server. Point a client at it with your end user's ID and Connect resolves that user's Lightspeed eCom (C-Series) account for each tool call — you store no tokens.
// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "lightspeed_ecom_c_series",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// e.g. run Find Customers:
const result = await mcp.callTool({
name: "lightspeed_ecom_c_series-find-customers",
arguments: {
customerEmail: "Customer Email",
sinceId: "Since ID",
},
})# access_token: mint a short-lived token with the Connect SDK — see the MCP guide
headers = {
"Authorization": f"Bearer {access_token}",
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", # any stable ID for this user in your system
"x-pd-app-slug": "lightspeed_ecom_c_series",
}
async with streamablehttp_client("https://remote.mcp.pipedream.net/v3", headers=headers) as (read, write, _):
async with ClientSession(read, write) as session:
await session.initialize()
tools = await session.list_tools()
# e.g. run Find Customers:
result = await session.call_tool("lightspeed_ecom_c_series-find-customers", {
"customerEmail": "Customer Email",
"sinceId": "Since ID",
})API PROXY
Call the Lightspeed eCom (C-Series) API directly
For an endpoint with no pre-built tool, the Connect proxy forwards your request to the Lightspeed eCom (C-Series) API with the connected user's credentials attached. You store no tokens and write no refresh logic.
const resp = await pd.proxy.get({
externalUserId: "{external_user_id}", // any stable ID for this user in your system
accountId: "apn_xxxxxxx",
url: "https://api.example.com/v1/me",
})
// Any allowed Lightspeed eCom (C-Series) endpoint works here. Pipedream attaches the
// connected account's credentials to the outgoing request.# The path segment is the target URL, URL-safe base64 encoded:
# https://api.example.com/v1/me
curl "https://api.pipedream.com/v1/connect/{project_id}/proxy/aHR0cHM6Ly9hcGkuZXhhbXBsZS5jb20vdjEvbWU?external_user_id={external_user_id}&account_id=apn_xxxxxxx" \
-H "Authorization: Bearer {access_token}" \
-H "x-pd-environment: production"SDK
Run Lightspeed eCom (C-Series) actions from your backend
Connect a user's Lightspeed eCom (C-Series) account once, then run Find Customers on their behalf from your own code — TypeScript, Python, or plain HTTP.
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-customers",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
lightspeed_ecom_c_series: { authProvisionId: "apn_xxxxxxx" },
customerEmail: "Customer Email",
sinceId: "Since ID",
},
})from pipedream import Pipedream
pd = Pipedream(
client_id="{oauth_client_id}",
client_secret="{oauth_client_secret}",
project_id="{project_id}",
project_environment="production",
)
result = pd.actions.run(
id="lightspeed_ecom_c_series-find-customers",
external_user_id="{external_user_id}", # any stable ID for this user in your system
configured_props={
"lightspeed_ecom_c_series": {"authProvisionId": "apn_xxxxxxx"},
"customerEmail": "Customer Email",
"sinceId": "Since ID",
},
)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "lightspeed_ecom_c_series-find-customers",
"configured_props": {
"lightspeed_ecom_c_series": { "authProvisionId": "apn_xxxxxxx" },
"customerEmail": "Customer Email",
"sinceId": "Since ID"
}
}'TOOLS
Lightspeed eCom (C-Series) actions
On-demand operations your product or agent can configure and run on behalf of a connected user.
-
Find Customers
actionFind a customer by ID. See the documentationWritev0.0.1 -
Find Invoice
actionFind an invoice by ID. See the documentationWritev0.0.1 -
Find Order
actionFind an order by ID. See the documentationWritev0.0.1 -
Find Product
actionFind an product by ID. See the documentationWritev0.0.1 -
Find Shipment
actionFind a shipment by ID. See the documentationWritev0.0.1 -
Get Order
actionGet an order by ID. See the documentationWritev0.0.1 -
Get Order Products
actionGet an order products by ID. See the documentationWritev0.0.1 -
Get Product
actionGet a product by ID. See the documentationWritev0.0.1 -
Get Shipment
actionGet a shipment by ID. See the documentationWritev0.0.1 -
List Brand ID Options
actionRetrieves available options for the Brand ID field.Read-onlyv0.0.1 -
List Customer Email Options
actionRetrieves available options for the Customer Email field.Read-onlyv0.0.1 -
List Customer ID Options
actionRetrieves available options for the Customer ID field.Read-onlyv0.0.1 -
List Invoice Number Options
actionRetrieves available options for the Invoice Number field.Read-onlyv0.0.1 -
List Order ID Options
actionRetrieves available options for the Order ID field.Read-onlyv0.0.1 -
List Order Number Options
actionRetrieves available options for the Order Number field.Read-onlyv0.0.1 -
List Product ID Options
actionRetrieves available options for the Product ID field.Read-onlyv0.0.1 -
List Shipment ID Options
actionRetrieves available options for the Shipment ID field.Read-onlyv0.0.1 -
List Shipment Number Options
actionRetrieves available options for the Shipment Number field.Read-onlyv0.0.1
EVENTS
Lightspeed eCom (C-Series) triggers
Event sources your backend can deploy for users and receive through a webhook.
-
Customer Updated (Instant)
triggerEmit new event when a customer is updated.Instantv0.0.1 -
Invoice Updated (Instant)
triggerEmit new event when an invoice is updated.Instantv0.0.1 -
New Customer Created (Instant)
triggerEmit new event when a customer is created.Instantv0.0.1 -
New Invoice Created (Instant)
triggerEmit new event when an invoice is created.Instantv0.0.1 -
New Order Created (Instant)
triggerEmit new event when an order is created.Instantv0.0.1 -
New Product Created (Instant)
triggerEmit new event when a product is created.Instantv0.0.1 -
Order Shipped (Instant)
triggerEmit new event when an order is shipped.Instantv0.0.1 -
Order Updated (Instant)
triggerEmit new event when a order is updated.Instantv0.0.1 -
Product Deleted (Instant)
triggerEmit new event when a product is deleted.Instantv0.0.1 -
Product Updated (Instant)
triggerEmit new event when a product is updated.Instantv0.0.1
REFERENCE
App details
Reference metadata for the Lightspeed eCom (C-Series) connector in the Pipedream registry.
- App slug
- lightspeed_ecom_c_series
- Authentication
- API key
- Categories
- Commerce
- Actions
- 18
- Triggers
- 10
- API proxy
- Available