Create Order with Order Desk API on New Row Custom Query from PostgreSQL API

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

Trigger workflow on

New Row Custom Query from the PostgreSQL API

Next, do this

Create Order with the Order Desk 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 Order Desk 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 Custom Query trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
4. Select a Table
5. Select a Column
6. Configure SQL Query
7. Optional- Configure Values
Configure the Create Order action
1. Connect your Order Desk account
2. Configure Order Items
3. Optional- Configure Customer First Name
4. Optional- Configure Customer Last Name
5. Optional- Configure Customer Company
6. Optional- Configure Shipping First Name
7. Optional- Configure Shipping Last Name
8. Optional- Configure Shipping Company
9. Optional- Configure Source ID
10. Optional- Select a Source Name
11. Optional- Configure Email
12. Optional- Configure Shipping Method
13. Optional- Configure Quantity Total
14. Optional- Configure Weight Total
15. Optional- Configure Product Total
16. Optional- Configure Shipping Total
17. Optional- Configure Handling Total
18. Optional- Configure Tax Total
19. Optional- Configure Discount Total
20. Optional- Configure Order Total
21. Optional- Configure Credit Card Number
22. Optional- Configure Credit Card Expiration
23. Optional- Configure Processor Response
24. Optional- Configure Payment Type
25. Optional- Select a Payment Status
26. Optional- Configure Processor Balance
27. Optional- Configure Refund Total
28. Optional- Configure Customer ID
29. Optional- Configure IP Address
30. Optional- Configure Fulfillment ID
31. Optional- Configure Fulfillment Name
32. Optional- Configure Folder ID
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 Custom Query on PostgreSQL

Description:Emit new event when new rows are returned from a custom query that you provide. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.6

Key:postgresql-new-row-custom-query

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 Custom Query",
  key: "postgresql-new-row-custom-query",
  description: "Emit new event when new rows are returned from a custom query that you provide. [See the documentation](https://node-postgres.com/features/queries)",
  version: "2.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) => ({
          table: c.table,
          schema: c.schema,
        }),
      ],
    },
    query: {
      propDefinition: [
        common.props.postgresql,
        "query",
      ],
    },
    values: {
      propDefinition: [
        common.props.postgresql,
        "values",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateMeta(row, column) {
      return {
        id: row[column],
        summary: "New Row",
        ts: Date.now(),
      };
    },
  },
  async run() {
    const {
      schema,
      table,
      column,
      query,
      values = [],
    } = this;

    if (!Array.isArray(values)) {
      throw new Error("No valid values provided. The values property must be an array.");
    }

    const numberOfValues = query?.match(/\$/g)?.length || 0;
    if (values.length !== numberOfValues) {
      throw new Error("The number of values provided does not match the number of values in the query.");
    }

    const isColumnUnique = await this.isColumnUnique(schema, table, column);
    if (!isColumnUnique) {
      throw new Error("The column selected contains duplicate values. Column must be unique");
    }

    const rows = await this.postgresql.executeQuery({
      text: query,
      values,
    });
    for (const row of rows) {
      const meta = this.generateMeta(row, column);
      this.$emit(row, meta);
    }
  },
};

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.
SQL Query	`query`	`string`	Your custom SQL Query using `$1`, `$2`... to represent values (eg. `INSERT INTO users(name, email) VALUES($1, $2)`
Values	`values`	`string[]`	List of values represented in your SQL Query above

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 Order Desk

Description:Create Order [See the documentation](https://apidocs.orderdesk.com/#create-an-order).

Version:0.0.1

Key:order_desk-create-order

View on GitHub

Order Desk Overview#

The Order Desk API allows you to automate and streamline order management processes within the Order Desk platform. With this API, you have the power to create, update, and get detailed information on orders, inventory, and shipments. Pipedream's serverless platform enables you to connect the Order Desk API with numerous other apps and services to build dynamic workflows. Whether you're syncing order data, managing inventory, or connecting to fulfillment services, Pipedream can help you craft custom automations that save time and reduce manual errors.

Action Code#

import { getParsedOrderItems } from "../../common/validate-order-items.mjs";
import app  from "../../order_desk.app.mjs";

export default {
  name: "Create Order",
  description: "Create Order [See the documentation](https://apidocs.orderdesk.com/#create-an-order).",
  key: "order_desk-create-order",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    order_items: {
      propDefinition: [
        app,
        "order_items",
      ],
    },
    customer_first_name: {
      propDefinition: [
        app,
        "customer_first_name",
      ],
    },
    customer_last_name: {
      propDefinition: [
        app,
        "customer_last_name",
      ],
    },
    customer_company: {
      propDefinition: [
        app,
        "customer_company",
      ],
    },
    shipping_first_name: {
      propDefinition: [
        app,
        "shipping_first_name",
      ],
    },
    shipping_last_name: {
      propDefinition: [
        app,
        "shipping_last_name",
      ],
    },
    shipping_company: {
      propDefinition: [
        app,
        "shipping_company",
      ],
    },
    source_id: {
      propDefinition: [
        app,
        "source_id",
      ],
    },
    source_name: {
      propDefinition: [
        app,
        "source_name",
      ],
    },
    email: {
      propDefinition: [
        app,
        "email",
      ],
    },
    shipping_method: {
      propDefinition: [
        app,
        "shipping_method",
      ],
    },
    quantity_total: {
      propDefinition: [
        app,
        "quantity_total",
      ],
    },
    weight_total: {
      propDefinition: [
        app,
        "weight_total",
      ],
    },
    product_total: {
      propDefinition: [
        app,
        "product_total",
      ],
    },
    shipping_total: {
      propDefinition: [
        app,
        "shipping_total",
      ],
    },
    handling_total: {
      propDefinition: [
        app,
        "handling_total",
      ],
    },
    tax_total: {
      propDefinition: [
        app,
        "tax_total",
      ],
    },
    discount_total: {
      propDefinition: [
        app,
        "discount_total",
      ],
    },
    order_total: {
      propDefinition: [
        app,
        "order_total",
      ],
    },
    cc_number: {
      propDefinition: [
        app,
        "cc_number",
      ],
    },
    cc_exp: {
      propDefinition: [
        app,
        "cc_exp",
      ],
    },
    processor_response: {
      propDefinition: [
        app,
        "processor_response",
      ],
    },
    payment_type: {
      propDefinition: [
        app,
        "payment_type",
      ],
    },
    payment_status: {
      propDefinition: [
        app,
        "payment_status",
      ],
    },
    processor_balance: {
      propDefinition: [
        app,
        "processor_balance",
      ],
    },
    refund_total: {
      propDefinition: [
        app,
        "refund_total",
      ],
    },
    customer_id: {
      propDefinition: [
        app,
        "customer_id",
      ],
    },
    ip_address: {
      propDefinition: [
        app,
        "ip_address",
      ],
    },
    fulfillment_id: {
      propDefinition: [
        app,
        "fulfillment_id",
      ],
    },
    fulfillment_name: {
      propDefinition: [
        app,
        "fulfillment_name",
      ],
    },
    folder_id: {
      propDefinition: [
        app,
        "folder_id",
      ],
    },
  },
  async run({ $ }) {
    const {
      app,
      ...data
    } = this;

    const res = await app.createOrder({
      ...data,
      order_items: getParsedOrderItems(data.order_items),
    });
    $.export("summary", `Order successfully created with id "${res.order.id}".`);
    return res;
  },
};

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
Order Desk	`app`	`app`	This component uses the Order Desk app.
Order Items	`order_items`	`string[]`	A valid JSON string. Order Items Object can have the following properties: `id, name, price, quantity, weight, code, delivery_type, category_code, variation_list, metadata`. Please check the documentation in the description for more information.
Customer First Name	`customer_first_name`	`string`	Customer first name
Customer Last Name	`customer_last_name`	`string`	Customer last name
Customer Company	`customer_company`	`string`	Customer company
Shipping First Name	`shipping_first_name`	`string`	Shipping first name
Shipping Last Name	`shipping_last_name`	`string`	Shipping last name
Shipping Company	`shipping_company`	`string`	Shipping company
Source ID	`source_id`	`string`	Your order ID. If blank, Order Desk's internal ID will be used read-only.
Source Name	`source_name`	`string`	Select a value from the drop down menu:`Order DeskFoxyCartWooCommerceBigCommerceAmazonShopifyeBayMagentoMagento 2GumroadWufooInterspirePayPalStripeEtsyJetZapierSpark PaySnipcartRecurlyVolusionChargebeeWeeblyWalmartWalmart.comModular MerchantEcwidUltraCartnopCommerceSquarespaceCeleryE-junkieCommerceHQBrightStoresSamCartWayfairSpree`
Email	`email`	`string`	Customer email address
Shipping Method	`shipping_method`	`string`	Name of shipping method selected.
Quantity Total	`quantity_total`	`string`	Total number of items in the order.
Weight Total	`weight_total`	`string`	Total weight of the order.
Product Total	`product_total`	`string`	Total cost of all items in the order.
Shipping Total	`shipping_total`	`string`	Total cost of shipping.
Handling Total	`handling_total`	`string`	Total cost of handling.
Tax Total	`tax_total`	`string`	Total cost of tax.
Discount Total	`discount_total`	`string`	Total cost of discounts.
Order Total	`order_total`	`string`	Total cost of the order.
Credit Card Number	`cc_number`	`string`	Obfuscated credit card number. Enter only the last four digits.
Credit Card Expiration	`cc_exp`	`string`	Credit card expiration date in MM/YYYY format.
Processor Response	`processor_response`	`string`	Gateway transaction ID in format `<gateway_name>: <transaction_id>`
Payment Type	`payment_type`	`string`	Payment type. Can be `Visa`, `Paypal`, `Mastercard`, etc
Payment Status	`payment_status`	`string`	Select a value from the drop down menu:`ApprovedAuthorizedCapturedFully RefundedPartially RefundedPendingRejectedVoided`
Processor Balance	`processor_balance`	`string`	The amount that the was charged at the processor. This amount will be decremented when refunds are made. By default it will be set the same as `order_total`
Refund Total	`refund_total`	`string`	The amount that jhas been refunded on the order from within Order Desk. This is generally something that will be set internally.
Customer ID	`customer_id`	`string`	The ID of the customer. This is generally something that will be set internally.
IP Address	`ip_address`	`string`	The IP address of the customer.
Fulfillment ID	`fulfillment_id`	`string`	The internal ID of the fulfillment service will be saved here for some services.
Fulfillment Name	`fulfillment_name`	`string`	Once the order has been sent for fulfillment, the name of the fulfillment method is entered here.
Folder ID	`folder_id`	`string`	The ID number of the folder in which the order is stored. If nothing is entered when adding an order, the folder will be the first folder in the list.

Action Authentication#

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

To retrieve your API key,

Navigate to your Order Desk account and sign in
Go to “Store Settings” > “API”