Create Order with Starshipit API on New Row from PostgreSQL API

Pipedream makes it easy to connect APIs for Starshipit, PostgreSQL and 2,400+ other apps remarkably fast.

Trigger workflow on

New Row from the PostgreSQL API

Next, do this

Create Order with the Starshipit 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 PostgreSQL trigger and Starshipit action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Row trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
4. Select a Table
5. Optional- Select a Column
Configure the Create Order action
1. Connect your Starshipit account
2. Configure Order Number
3. Select a Destination
4. Configure Number of Items
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 Row on PostgreSQL

Description:Emit new event when a new row is added to a table. [See the documentation](https://node-postgres.com/features/queries)

Version:3.0.6

Key:postgresql-new-row

View on GitHub

PostgreSQL Overview#

On Pipedream, you can leverage the PostgreSQL app to create workflows that automate database operations, synchronize data across platforms, and react to database events in real-time. Think handling new row entries, updating records from webhooks, or even compiling reports on a set schedule. Pipedream's serverless platform provides a powerful way to connect PostgreSQL with a variety of apps, enabling you to create tailored automation that fits your specific needs.

Trigger Code#

import common from "../common.mjs";

export default {
  ...common,
  name: "New Row",
  key: "postgresql-new-row",
  description: "Emit new event when a new row is added to a table. [See the documentation](https://node-postgres.com/features/queries)",
  version: "3.0.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    schema: {
      propDefinition: [
        common.props.postgresql,
        "schema",
      ],
    },
    table: {
      propDefinition: [
        common.props.postgresql,
        "table",
        (c) => ({
          schema: c.schema,
        }),
      ],
    },
    column: {
      propDefinition: [
        common.props.postgresql,
        "column",
        (c) => ({
          schema: c.schema,
          table: c.table,
        }),
      ],
      description: "An ID or timestamp column where new rows will always contain larger values than the previous row. Defaults to the table's primary key.",
      optional: true,
    },
  },
  hooks: {
    /** If column prop is left blank, get the table's primary key to use
     * for ordering and deduping. */
    async deploy() {
      const column = this.column
        ? this.column
        : await this.postgresql.getPrimaryKey(this.table, this.schema);
      this._setColumn(column);

      await this.initialRows(this.schema, this.table, column);
    },
  },
  methods: {
    ...common.methods,
    _getColumn() {
      return this.db.get("column");
    },
    _setColumn(column) {
      this.db.set("column", column);
    },
    generateMeta(row, column) {
      return {
        id: row[column],
        summary: "New Row Added",
        ts: Date.now(),
      };
    },
  },
  async run() {
    const column = this._getColumn();
    const isColumnUnique = await this.isColumnUnique(this.schema, this.table, column);
    if (!isColumnUnique) {
      throw new Error("The column selected contains duplicate values. Column must be unique");
    }

    await this.newRows(this.schema, this.table, column);
  },
};

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
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Schema	`schema`	`string`	Select a value from the drop down menu.
Table	`table`	`string`	Select a value from the drop down menu.
Column	`column`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs.

SSL Setup

Configure SSL on your PostgreSQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications.

About PostgreSQL#

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

Action#

Create Order on Starshipit

Description:Create an outbound order in Starshipit. [See the documentation](https://api-docs.starshipit.com/#b90251d2-1d1c-47b1-ac07-eeeb21cade7b)

Version:0.0.1

Key:starshipit-create-order

View on GitHub

Starshipit Overview#

The Starshipit API is a tool for optimizing and automating shipping and fulfillment processes. By integrating it with Pipedream, you can create powerful serverless workflows that connect Starshipit with other apps and services to streamline e-commerce operations, reduce manual entry, and improve customer experiences. From automating order dispatch to synchronizing tracking information across platforms, the possibilities are vast.

Action Code#

import starshipit from "../../starshipit.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "starshipit-create-order",
  name: "Create Order",
  description: "Create an outbound order in Starshipit. [See the documentation](https://api-docs.starshipit.com/#b90251d2-1d1c-47b1-ac07-eeeb21cade7b)",
  version: "0.0.1",
  type: "action",
  props: {
    starshipit,
    orderNumber: {
      type: "string",
      label: "Order Number",
      description: "The identifier of the order pulled from source e-Commerce platform (max length: 50)",
    },
    destination: {
      propDefinition: [
        starshipit,
        "contactId",
      ],
    },
    numItems: {
      type: "integer",
      label: "Number of Items",
      description: "Number of items in the order",
      reloadProps: true,
    },
  },
  additionalProps() {
    const props = {};
    for (let i = 1; i <= this.numItems; i++) {
      props[`item_${i}_description`] = {
        type: "string",
        label: `Item ${i} Description`,
        description: "Product name or description",
        optional: true,
      };
      props[`item_${i}_quantity`] = {
        type: "string",
        label: `Item ${i} Quantity`,
        description: "The number of product ordered",
        optional: true,
      };
      props[`item_${i}_weight`] = {
        type: "string",
        label: `Item ${i} Weight`,
        description: "Unit weight of the product in kilograms (kg)",
        optional: true,
      };
      props[`item_${i}_value`] = {
        type: "string",
        label: `Item ${i} Value`,
        description: "Unit price of the product",
        optional: true,
      };
    }
    return props;
  },
  methods: {
    async getOrderContact(destinationId) {
      const contacts = await this.starshipit.paginate({
        resourceFn: this.starshipit.listContacts,
        resourceName: "addresses",
      });
      return contacts.find(({ id }) => id === destinationId);
    },
    parseFloat(i, type) {
      return utils.parseFloatProp(this, "item", i, type);
    },
  },
  async run({ $ }) {
    const items = [];
    for (let i = 1; i <= this.numItems; i++) {
      items.push({
        description: this[`item_${i}_description`],
        quantity: this.parseFloat(i, "quantity"),
        weight: this.parseFloat(i, "weight"),
        value: this.parseFloat(i, "value"),
      });
    }
    const destination = await this.getOrderContact(this.destination);

    const response = await this.starshipit.createOrder({
      data: {
        order: {
          order_number: this.orderNumber,
          destination,
          items,
        },
      },
      $,
    });
    if (response?.success === false) {
      throw new Error(`${response.errors[0].message}: ${response.errors[0].details}`);
    }
    if (response?.order?.order_id) {
      $.export("$summary", `Successfully created order with ID: ${response.order.order_id}`);
    }
    return response;
  },
};

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
Starshipit	`starshipit`	`app`	This component uses the Starshipit app.
Order Number	`orderNumber`	`string`	The identifier of the order pulled from source e-Commerce platform (max length: 50)
Destination	`destination`	`string`	Select a value from the drop down menu.
Number of Items	`numItems`	`integer`	Number of items in the order

Action Authentication#

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

To retrieve your API keys,

Navigate to your Starshipit account and sign in
Go to “Settings” > “API”