Find Shipment with Lightspeed eCom (C-Series) API on New Flow Event from TextIt API

Pipedream makes it easy to connect APIs for Lightspeed eCom (C-Series), TextIt and 2,900+ other apps remarkably fast.

Trigger workflow on

New Flow Event from the TextIt 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 TextIt 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 Flow Event trigger
1. Connect your TextIt account
2. Select a Resthook event
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 Flow Event on TextIt

Description:Emit new event for each new flow event

Version:0.0.1

Key:textit-new-flow-event

View on GitHub

TextIt Overview#

TextIt is an API that specializes in automating SMS, voice, and social messaging workflows. By leveraging Pipedream's integration capabilities, the TextIt API can be used to create powerful communication automations that respond in real-time to incoming messages, dispatch notifications, and interact with users. With Pipedream, these automations can be connected to a plethora of services to enhance CRM systems, facilitate survey collection, or streamline event-driven notifications.

Trigger Code#

import textit from "../../textit.app.mjs";

export default {
  name: "New Flow Event",
  version: "0.0.1",
  key: "textit-new-flow-event",
  description: "Emit new event for each new flow event",
  type: "source",
  props: {
    textit,
    db: "$.service.db",
    http: "$.interface.http",
    resthookEvent: {
      propDefinition: [
        textit,
        "resthookEvent",
      ],
    },
  },
  methods: {
    _getWebhookId() {
      return this.db.get("webhookId");
    },
    _setWebhookId(webhookId) {
      this.db.set("webhookId", webhookId);
    },
    emitEvent(event) {
      const data = event.data ?? event;

      this.$emit(data, {
        id: data.run.uuid,
        summary: `New event with id ${data.run.uuid}`,
        ts: Date.parse(data.run.created_on),
      });
    },
  },
  hooks: {
    async deploy() {
      const response = await this.textit.getResthookEvents({
        params: {
          resthook: this.resthook,
        },
      });

      response.results.reverse().forEach(this.emitEvent);
    },
    async activate() {
      const response = await this.textit.createWebhook({
        data: {
          resthook: this.resthookEvent,
          target_url: this.http.endpoint,
        },
      });

      this._setWebhookId(response.id);
    },
    async deactivate() {
      const webhookId = this._getWebhookId();
      await this.textit.removeWebhook(webhookId);
    },
  },
  async run(event) {
    this.emitEvent(event.body);
  },
};

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
TextIt	`textit`	`app`	This component uses the TextIt app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Resthook event	`resthookEvent`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Log in to your TextIt account, and head to the TextIt API v2 page. The API Key should appear on the top right if logged in.

About TextIt#

TextIt provides a way of automating conversational interactions over SMS, messaging bots and phone calls.

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 Flow Event from TextIt API

Pipedream makes it easy to connect APIs for Lightspeed eCom (C-Series), TextIt and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

1
-
24
of
2,900+
apps by most popular