Find Shipment with Lightspeed eCom (C-Series) API on New Pub/Sub Messages from Google Cloud API

Pipedream makes it easy to connect APIs for Lightspeed eCom (C-Series), Google Cloud and 3,000+ other apps remarkably fast.

Trigger workflow on

New Pub/Sub Messages from the Google Cloud API

Next, do this

Find Shipment with the Lightspeed eCom (C-Series) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Google Cloud trigger and Lightspeed eCom (C-Series) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Pub/Sub Messages trigger
1. Connect your Google Cloud account
2. Select a Type
Configure the Find Shipment action
1. Connect your Lightspeed eCom (C-Series) account
2. Optional- Select a Customer ID
3. Optional- Select a Order Number
4. Optional- Select a Shipment Number
5. Optional- Configure Since ID
6. Optional- Configure Created At Min
7. Optional- Configure Created At Max
8. Optional- Configure Updated At Min
9. Optional- Configure Updated At Max
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Pub/Sub Messages on Google Cloud

Description:Emit new Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.

Version:0.1.7

Key:google_cloud-new-pubsub-messages

View on GitHub

Google Cloud Overview#

The Google Cloud API opens a world of possibilities for enhancing cloud operations and automating tasks. It empowers you to manage, scale, and fine-tune various services within the Google Cloud Platform (GCP) programmatically. With Pipedream, you can harness this power to create intricate workflows, trigger cloud functions based on events from other apps, manage resources, and analyze data, all in a serverless environment. The ability to interconnect GCP services with numerous other apps enriches automation, making it easier to synchronize data, streamline development workflows, and deploy applications efficiently.

Trigger Code#

import { PubSub } from "@google-cloud/pubsub"; import googleCloud from "../../google_cloud.app.mjs"; export default { key: "google_cloud-new-pubsub-messages", name: "New Pub/Sub Messages", description: "Emit new Pub/Sub topic in your GCP account. Messages published to this topic are emitted from the Pipedream source.", version: "0.1.7", type: "source", dedupe: "unique", // Dedupe on Pub/Sub message ID props: { googleCloud, http: "$.interface.http", db: "$.service.db", topicType: { type: "string", label: "Type", description: "Do you have an existing Pub/Sub topic, or would you like to create a new one?", options: [ "existing", "new", ], reloadProps: true, }, }, async additionalProps() { const topic = { type: "string", label: "Pub/Sub Topic Name", description: "Select a Pub/Sub topic from your GCP account to watch", options: async () => { return this.getTopics(); }, }; if (this.topicType === "new") { topic.description = "**Pipedream will create a Pub/Sub topic with this name in your account**, converting it to a [valid Pub/Sub topic name](https://cloud.google.com/pubsub/docs/admin#resource_names)."; delete topic.options; } return { topic, }; }, methods: { _getTopicName() { return this.db.get("topicName"); }, _setTopicName(topicName) { this.db.set("topicName", topicName); }, _getSubscriptionName() { return this.db.get("subscriptionName"); }, _setSubscriptionName(subscriptionName) { this.db.set("subscriptionName", subscriptionName); }, async getTopics() { const sdkParams = this.googleCloud.sdkParams(); const pubSubClient = new PubSub(sdkParams); const topics = (await pubSubClient.getTopics())[0]; if (topics.length > 0) { return topics.map((topic) => topic.name); } return []; }, convertNameToValidPubSubTopicName(name) { // For valid names, see https://cloud.google.com/pubsub/docs/admin#resource_names return name // Must not start with `goog`. We add a `pd-` at the beginning if that's the case. .replace(/(^goog.*)/g, "pd-$1") // Must start with a letter, otherwise we add `pd-` at the beginning. .replace(/^(?![a-zA-Z]+)/, "pd-") // Only certain characters are allowed, the rest will be replaced with a `-`. .replace(/[^a-zA-Z0-9_\-.~+%]+/g, "-"); }, }, hooks: { async activate() { const sdkParams = this.googleCloud.sdkParams(); const pubSubClient = new PubSub(sdkParams); const currentTopic = { name: this.topic, }; if (this.topicType === "new") { const topicName = this.convertNameToValidPubSubTopicName(this.topic); console.log(`Creating Pub/Sub topic ${topicName}`); const [ topic, ] = await pubSubClient.createTopic(topicName); currentTopic.name = topic.name; } this._setTopicName(currentTopic.name); const pushEndpoint = this.http.endpoint; const subscriptionName = this.convertNameToValidPubSubTopicName(pushEndpoint); const subscriptionOptions = { pushConfig: { pushEndpoint, }, }; console.log( `Subscribing this source's URL to the Pub/Sub topic: ${pushEndpoint} (under name ${subscriptionName}).`, ); const [ subscriptionResult, ] = await pubSubClient .topic(currentTopic.name) .createSubscription(subscriptionName, subscriptionOptions); this._setSubscriptionName(subscriptionResult.name); }, async deactivate() { const sdkParams = this.googleCloud.sdkParams(); const pubSubClient = new PubSub(sdkParams); const subscriptionName = this._getSubscriptionName(); if (subscriptionName) { await pubSubClient.subscription(subscriptionName).delete(); } if (this.topicType === "new") { const topicName = this._getTopicName(); if (topicName) { await pubSubClient.topic(topicName).delete(); } } }, }, async run(event) { const { data, messageId, publishTime, } = event.body.message; if (!data) { console.warn("No message present, exiting"); return; } const dataString = Buffer.from(data, "base64").toString("utf-8"); const metadata = { id: messageId, summary: dataString, ts: +new Date(publishTime), }; let dataObj; try { dataObj = JSON.parse(dataString); } catch (err) { console.error( `Couldn't parse message as JSON. Emitting raw message. Error: ${err}`, ); dataObj = { rawMessage: dataString, }; } this.$emit(dataObj, metadata); }, };

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Google Cloud	`googleCloud`	`app`	This component uses the Google Cloud app.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Type	`topicType`	`string`	Select a value from the drop down menu:`existingnew`

Trigger Authentication#

Google Cloud uses API keys for authentication. When you connect your Google Cloud account, Pipedream securely stores the keys so you can easily authenticate to Google Cloud APIs in both code and no-code steps.

Create a service account in GCP and set the permissions you need for Pipedream workflows.
Generate a service account key
Download the key details in JSON format
Upload the key below.

About Google Cloud#

The Google Cloud Platform, including BigQuery

Action#

Find Shipment on Lightspeed eCom (C-Series)

Description:Find a shipment by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/shipment/#get-all-shipments)

Version:0.0.1

Key:lightspeed_ecom_c_series-find-shipment

View on GitHub

Action Code#

import app from "../../lightspeed_ecom_c_series.app.mjs"; export default { key: "lightspeed_ecom_c_series-find-shipment", name: "Find Shipment", description: "Find a shipment by ID. [See the documentation](https://developers.lightspeedhq.com/ecom/endpoints/shipment/#get-all-shipments)", version: "0.0.1", type: "action", annotations: { destructiveHint: false, openWorldHint: true, readOnlyHint: false, }, props: { app, customerId: { propDefinition: [ app, "customerId", ], description: "Retrieve all shipments from a specific customer based on the customerid", optional: true, }, orderNumber: { propDefinition: [ app, "orderNumber", ], description: "Retrieve a shipment based on the order number", optional: true, }, shipmentNumber: { propDefinition: [ app, "shipmentNumber", ], optional: true, }, sinceId: { type: "string", label: "Since ID", description: "Restrict results to after the specified ID", optional: true, }, createdAtMin: { propDefinition: [ app, "createdAtMin", ], description: "Show shipments created after date. **Format: `YYYY-MM-DD HH:MM:SS`**", }, createdAtMax: { propDefinition: [ app, "createdAtMax", ], description: "Show shipments created before date. **Format: `YYYY-MM-DD HH:MM:SS`**", }, updatedAtMin: { propDefinition: [ app, "updatedAtMin", ], description: "Show shipments last updated after date. **Format: `YYYY-MM-DD HH:MM:SS`**", }, updatedAtMax: { propDefinition: [ app, "updatedAtMax", ], description: "Show shipments last updated before date. **Format: `YYYY-MM-DD HH:MM:SS`**", }, }, async run({ $ }) { const response = this.app.paginate({ fn: this.app.listShipment, $, params: { customer: this.customerId, order: this.orderNumber, number: this.shipmentNumber, since_id: this.sinceId, created_at_min: this.createdAtMin, created_at_max: this.createdAtMax, updated_at_min: this.updatedAtMin, updated_at_max: this.updatedAtMax, }, dataField: "shipments", }); const shipments = []; for await (const shipment of response) { shipments.push(shipment); } $.export("$summary", `Successfully found ${shipments.length} shipment${shipments.length === 1 ? "" : "s"}`); return shipments; }, };

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Lightspeed eCom (C-Series)	`app`	`app`	This component uses the Lightspeed eCom (C-Series) app.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Order Number	`orderNumber`	`string`	Select a value from the drop down menu.
Shipment Number	`shipmentNumber`	`string`	Select a value from the drop down menu.
Since ID	`sinceId`	`string`	Restrict results to after the specified ID
Created At Min	`createdAtMin`	`string`	Show shipments created after date. Format: `YYYY-MM-DD HH:MM:SS`
Created At Max	`createdAtMax`	`string`	Show shipments created before date. Format: `YYYY-MM-DD HH:MM:SS`
Updated At Min	`updatedAtMin`	`string`	Show shipments last updated after date. Format: `YYYY-MM-DD HH:MM:SS`
Updated At Max	`updatedAtMax`	`string`	Show shipments last updated before date. Format: `YYYY-MM-DD HH:MM:SS`

Action Authentication#

Lightspeed eCom (C-Series) uses API keys for authentication. When you connect your Lightspeed eCom (C-Series) account, Pipedream securely stores the keys so you can easily authenticate to Lightspeed eCom (C-Series) APIs in both code and no-code steps.

Find Shipment with Lightspeed eCom (C-Series) API on New Pub/Sub Messages from Google Cloud API

Pipedream makes it easy to connect APIs for Lightspeed eCom (C-Series), Google Cloud and 3,000+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of3,000+apps by most popular

1
-
24
of
3,000+
apps by most popular