Create Shipping Order with Shipday API on New Row (Custom Query) from MySQL API

Pipedream makes it easy to connect APIs for Shipday, MySQL and 2,000+ other apps remarkably fast.

Trigger workflow on

New Row (Custom Query) from the MySQL API

Next, do this

Create Shipping Order with the Shipday API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a MySQL trigger and Shipday 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 MySQL account
2. Configure timer
3. Select a Table
4. Optional- Select a De-duplication Key
5. Configure Where condition
6. Configure Values
Configure the Create Shipping Order action
1. Connect your Shipday account
2. Configure Order Number
3. Configure Customer Name
4. Configure Customer Address
5. Configure Customer Email
6. Configure Customer Phone Number
7. Configure Restaurant Name
8. Configure Restaurant Address
9. Optional- Configure Expected Delivery Date
10. Optional- Configure Expected Pickup Time
11. Optional- Configure Expected Delivery Time
12. Optional- Configure Pickup Latitude
13. Optional- Configure Pickup Longitude
14. Optional- Configure Delivery Latitude
15. Optional- Configure Delivery Longitude
16. Optional- Configure Tips
17. Optional- Configure Tax
18. Optional- Configure Discount Amount
19. Optional- Configure Delivery Fee
20. Optional- Configure Total Order Cost
21. Optional- Configure Pickup Instruction
22. Optional- Configure Delivery Instruction
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 MySQL

Description:Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)

Version:2.0.4

Key:mysql-new-row-custom-query

View on GitHub

MySQL Overview#

The MySQL application on Pipedream enables direct interaction with your MySQL databases, allowing you to perform CRUD operations—create, read, update, delete—on your data with ease. You can leverage these capabilities to automate data synchronization, report generation, and event-based triggers that kick off workflows in other apps. With Pipedream's serverless platform, you can connect MySQL to hundreds of other services without managing infrastructure, crafting complex code, or handling authentication.

Trigger Code#

import common from "../common/table.mjs";
import { v4 as uuidv4 } from "uuid";

const { mysql } = common.props;

export default {
  ...common,
  key: "mysql-new-row-custom-query",
  name: "New Row (Custom Query)",
  description: "Emit new event when new rows are returned from a custom query. [See the docs here](https://dev.mysql.com/doc/refman/8.0/en/select.html)",
  version: "2.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    column: {
      propDefinition: [
        mysql,
        "column",
        (c) => ({
          table: c.table,
        }),
      ],
      label: "De-duplication Key",
      description:
        "The name of a column in the table to use for de-duplication",
      optional: true,
    },
    condition: {
      propDefinition: [
        mysql,
        "whereCondition",
      ],
    },
    values: {
      propDefinition: [
        mysql,
        "whereValues",
      ],
    },
  },
  methods: {
    ...common.methods,
    async listResults() {
      const {
        table,
        condition,
        values,
      } = this;

      const numberOfQuestionMarks = condition?.match(/\?/g)?.length;

      if (!numberOfQuestionMarks) {
        throw new Error("No valid condition provided. At least one question mark character ? must be provided.");
      }

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

      if (values.length !== numberOfQuestionMarks) {
        throw new Error("The number of values provided does not match the number of question marks ? in the condition.");
      }

      const rows = await this.mysql.findRows({
        table,
        condition,
        values,
      });
      this.iterateAndEmitEvents(rows);
    },
    generateMeta(row) {
      const id = this.column
        ? row[this.column]
        : uuidv4();
      return {
        id,
        summary: `New Row ${id}`,
        ts: Date.now(),
      };
    },
  },
};

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
MySQL	`mysql`	`app`	This component uses the MySQL app.
	`timer`	`$.interface.timer`
Table	`table`	`string`	Select a value from the drop down menu.
De-duplication Key	`column`	`string`	Select a value from the drop down menu.
Where condition	`condition`	`string`	In this expression you can write your own conditions (eg. `column1 = ? or column2 = ?`). Depending on the number of `?` symbols likewise you need to add the same number of values.
Values	`values`	`string[]`	This is the list of values that will match every `?` symbol in the where expression. If you want to build yourself the values (eg. `{{["string1", "string2"]}}`)

Trigger Authentication#

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

Before you connect to your MySQL database from Pipedream, please make sure your database is either:

Accessible from the public internet (You may need to add a firewall rule on 0.0.0.0/0 on port 3306), or
Accessible from a static IP that you've configured using a VPC in Pipedream, and enabled the workflow to connect through that VPC

SSL Setup

Configure SSL on your MySQL 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 MySQL#

MySQL is an open-source relational database management system.

Action#

Create Shipping Order on Shipday

Description:Creates a new shipping order. [See the documentation](https://docs.shipday.com/reference/insert-delivery-order)

Version:0.0.1

Key:shipday-create-order

View on GitHub

Shipday Overview#

The Shipday API lets you manage and automate delivery operations seamlessly. By integrating with Pipedream, you can orchestrate workflows that trigger from various events, sync data between services, and automate notifications or order tracking. With Pipedream's serverless platform, you can craft custom workflows that react in real-time to changes in delivery statuses, new order placements, or updates from other integrated services. This flexibility allows businesses to enhance their delivery processes, improve customer communication, and streamline operations.

Action Code#

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

export default {
  key: "shipday-create-order",
  name: "Create Shipping Order",
  description: "Creates a new shipping order. [See the documentation](https://docs.shipday.com/reference/insert-delivery-order)",
  version: "0.0.1",
  type: "action",
  props: {
    shipday,
    orderNumber: {
      propDefinition: [
        shipday,
        "orderNumber",
      ],
    },
    customerName: {
      propDefinition: [
        shipday,
        "customerName",
      ],
    },
    customerAddress: {
      propDefinition: [
        shipday,
        "customerAddress",
      ],
    },
    customerEmail: {
      propDefinition: [
        shipday,
        "customerEmail",
      ],
    },
    customerPhoneNumber: {
      propDefinition: [
        shipday,
        "customerPhoneNumber",
      ],
    },
    restaurantName: {
      propDefinition: [
        shipday,
        "restaurantName",
      ],
    },
    restaurantAddress: {
      propDefinition: [
        shipday,
        "restaurantAddress",
      ],
    },
    expectedDeliveryDate: {
      propDefinition: [
        shipday,
        "expectedDeliveryDate",
      ],
    },
    expectedPickupTime: {
      propDefinition: [
        shipday,
        "expectedPickupTime",
      ],
    },
    expectedDeliveryTime: {
      propDefinition: [
        shipday,
        "expectedDeliveryTime",
      ],
    },
    pickupLatitude: {
      propDefinition: [
        shipday,
        "pickupLatitude",
      ],
    },
    pickupLongitude: {
      propDefinition: [
        shipday,
        "pickupLongitude",
      ],
    },
    deliveryLatitude: {
      propDefinition: [
        shipday,
        "deliveryLatitude",
      ],
    },
    deliveryLongitude: {
      propDefinition: [
        shipday,
        "deliveryLongitude",
      ],
    },
    tips: {
      propDefinition: [
        shipday,
        "tips",
      ],
    },
    tax: {
      propDefinition: [
        shipday,
        "tax",
      ],
    },
    discountAmount: {
      propDefinition: [
        shipday,
        "discountAmount",
      ],
    },
    deliveryFee: {
      propDefinition: [
        shipday,
        "deliveryFee",
      ],
    },
    totalOrderCost: {
      propDefinition: [
        shipday,
        "totalOrderCost",
      ],
    },
    pickupInstruction: {
      propDefinition: [
        shipday,
        "pickupInstruction",
      ],
    },
    deliveryInstruction: {
      propDefinition: [
        shipday,
        "deliveryInstruction",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.shipday.createShippingOrder({
      data: {
        orderNumber: this.orderNumber,
        customerName: this.customerName,
        customerAddress: this.customerAddress,
        customerEmail: this.customerEmail,
        customerPhoneNumber: this.customerPhoneNumber,
        restaurantName: this.restaurantName,
        restaurantAddress: this.restaurantAddress,
        expectedDeliveryDate: this.expectedDeliveryDate,
        expectedPickupTime: this.expectedPickupTime,
        expectedDeliveryTime: this.expectedDeliveryTime,
        pickupLatitude: this.pickupLatitude,
        pickupLongitude: this.pickupLongitude,
        deliveryLatitude: this.deliveryLatitude,
        deliveryLongitude: this.deliveryLongitude,
        tips: this.tips,
        tax: this.tax,
        discountAmount: this.discountAmount,
        deliveryFee: this.deliveryFee,
        totalOrderCost: this.totalOrderCost,
        pickupInstruction: this.pickupInstruction,
        deliveryInstruction: this.deliveryInstruction,
      },
    });
    if (response?.orderId) {
      $.export("$summary", `Successfully created shipping order with ID: ${response.orderId}`);
    }
    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
Shipday	`shipday`	`app`	This component uses the Shipday app.
Order Number	`orderNumber`	`string`	Alphanumeric identifier for the order object
Customer Name	`customerName`	`string`	The name of the customer
Customer Address	`customerAddress`	`string`	The address of the customer
Customer Email	`customerEmail`	`string`	The email address of the customer
Customer Phone Number	`customerPhoneNumber`	`string`	Phone number of the customer with country code
Restaurant Name	`restaurantName`	`string`	The name of the restaurant
Restaurant Address	`restaurantAddress`	`string`	The address of the restaurant
Expected Delivery Date	`expectedDeliveryDate`	`string`	Expected delivery date in UTC for the particular order ( yyyy-mm-dd format)
Expected Pickup Time	`expectedPickupTime`	`string`	Expected pickup time in UTC for the particular order (format hh:mm:ss)
Expected Delivery Time	`expectedDeliveryTime`	`string`	Expected Delivery Time in UTC for the particular order (format hh:mm:ss)
Pickup Latitude	`pickupLatitude`	`string`	The latitude of the pickup location
Pickup Longitude	`pickupLongitude`	`string`	The longitude of the pickup location
Delivery Latitude	`deliveryLatitude`	`string`	The latitude of the delivery location
Delivery Longitude	`deliveryLongitude`	`string`	The longitude of the delivery location
Tips	`tips`	`string`	Tips amount for the order
Tax	`tax`	`string`	The tax for the order
Discount Amount	`discountAmount`	`string`	The discount amount for the order
Delivery Fee	`deliveryFee`	`string`	The delivery fee for the order
Total Order Cost	`totalOrderCost`	`string`	The total cost of the order
Pickup Instruction	`pickupInstruction`	`string`	The pickup instructions for the order
Delivery Instruction	`deliveryInstruction`	`string`	The delivery instructions for the order