Create Order with Starshipit API on New Customer Event (Instant) from WooCommerce API

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

Trigger workflow on

New Customer Event (Instant) from the WooCommerce 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 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a WooCommerce 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 Customer Event (Instant) trigger
1. Connect your WooCommerce account
2. Select one or more Event topics
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 Customer Event (Instant) on WooCommerce

Description:Emit new event each time the specified customer event(s) occur

Version:0.0.3

Key:woocommerce-new-customer-event

View on GitHub

WooCommerce Overview#

WooCommerce is a customizable, open-source eCommerce platform built on WordPress. With the WooCommerce API, you can tap into the heart of your eCommerce store to read, create, update, and delete products, orders, and customers. On Pipedream, you can harness this API to automate routine tasks, sync data across platforms, and enhance customer experiences. By connecting WooCommerce to a wide array of apps and services, you can streamline operations, trigger personalized marketing, and analyze your sales data with greater ease.

Trigger Code#

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

export default {
  ...common,
  key: "woocommerce-new-customer-event",
  name: "New Customer Event (Instant)",
  description: "Emit new event each time the specified customer event(s) occur",
  version: "0.0.3",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    async getSampleEvents({ perPage }) {
      return this.woocommerce.listCustomers({
        per_page: perPage,
        orderby: "registered_date",
      });
    },
    getTopic(topicType) {
      return `customer.${topicType}`;
    },
    generateMeta(eventType, {
      id, username, date_modified: dateModified,
    }) {
      const ts = Date.parse(dateModified);
      return {
        id: `${id}${ts}`,
        summary: `Customer "${username || id}" ${eventType}`,
        ts,
      };
    },
  },
};

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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce 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.
Event topics	`topics`	`string[]`	Select a value from the drop down menu:`createdupdateddeleted`

Trigger Authentication#

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

Find your API key at WooCommerce > Settings > Advanced > REST API. See the WooCommerce docs for more info. Enter the Key and Secret below.

About WooCommerce#

WooCommerce is the open-source ecommerce platform for WordPress.

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,