Create Order with WooCommerce API on New Shipment Status from shipcloud API

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

Trigger workflow on

New Shipment Status from the shipcloud API

Next, do this

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

Select this integration
Configure the New Shipment Status trigger
1. Connect your shipcloud account
2. Select one or more Event types
Configure the Create Order action
1. Connect your WooCommerce account
2. Optional- Select a Status
3. Select a Customer
4. Select a Payment Method
5. Select one or more Products
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 Shipment Status on shipcloud

Description:Emit new event for shipment status changes [See docs here](https://developers.shipcloud.io/reference/#webhooks)

Version:0.0.1

Key:shipcloud-new-shipment-status

View on GitHub

shipcloud Overview#

Shipcloud is a shipping service provider API that streamlines parcel shipping processes for businesses of all sizes. With Shipcloud, you can access multiple carriers, compare shipping rates, create shipping labels, track parcels, and handle returns within a single interface. Utilizing this API on Pipedream enables automation of shipping workflows, leading to efficient and scalable logistics operations.

Trigger Code#

import shipcloud from "../../app/shipcloud.app.mjs";
import { defineSource, } from "@pipedream/types";
import { WEBHOOK_EVENT_TYPES } from "../../common/constants.mjs";
export default defineSource({
    name: "New Shipment Status",
    description: "Emit new event for shipment status changes [See docs here](https://developers.shipcloud.io/reference/#webhooks)",
    key: "shipcloud-new-shipment-status",
    version: "0.0.1",
    type: "source",
    props: {
        shipcloud,
        db: "$.service.db",
        http: {
            type: "$.interface.http",
            customResponse: true,
        },
        eventTypes: {
            label: "Event types",
            description: "The shipment update(s) that should trigger an event",
            type: "string[]",
            options: WEBHOOK_EVENT_TYPES,
        },
    },
    hooks: {
        async activate() {
            const data = {
                event_types: this.eventTypes,
                url: this.http.endpoint,
            };
            const { id } = await this.shipcloud.createHook(data);
            this.db.set("hookId", id);
        },
        async deactivate() {
            const id = this.db.get("hookId");
            await this.shipcloud.deleteHook({
                id,
            });
        },
    },
    async run(data) {
        this.http.respond({
            status: 200,
        });
        const { body } = data;
        let { id } = body;
        if (typeof id !== "string") {
            id = Date.now();
        }
        let summary = body.type;
        if (typeof summary !== "string") {
            summary = "Unknown event type";
        }
        const date = body.occured_at;
        const ts = typeof date === "string"
            ? new Date(date).valueOf()
            : Date.now();
        this.$emit(body, {
            id,
            summary,
            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
shipcloud	`shipcloud`	`app`	This component uses the shipcloud 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 types	`eventTypes`	`string[]`	Select a value from the drop down menu:`shipment.shipment.status.shipment.status.deletedshipment.tracking.*shipment.tracking.awaits_pickup_by_receivershipment.tracking.canceledshipment.tracking.delayedshipment.tracking.deliveredshipment.tracking.destroyedshipment.tracking.exceptionshipment.tracking.label_createdshipment.tracking.not_deliveredshipment.tracking.notificationshipment.tracking.out_for_deliveryshipment.tracking.picked_upshipment.tracking.transitshipment.tracking.unknown`

Trigger Authentication#

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

Go here to retrieve your API key: https://app.shipcloud.io/en/users/api_key

About shipcloud#

Shipcloud is the shipping service provider and represents a new generation in package shipping. A cloud-based service, it enables small and medium-sized online vendors to work easily and efficiently with all major shipping providers.

Action#

Create Order on WooCommerce

Description:Creates a new order. [See the docs](https://woocommerce.github.io/woocommerce-rest-api-docs/?javascript#create-an-order)

Version:0.0.2

Key:woocommerce-create-order

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.

Action Code#

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

export default {
  key: "woocommerce-create-order",
  name: "Create Order",
  description: "Creates a new order. [See the docs](https://woocommerce.github.io/woocommerce-rest-api-docs/?javascript#create-an-order)",
  version: "0.0.2",
  type: "action",
  props: {
    woocommerce,
    status: {
      propDefinition: [
        woocommerce,
        "orderStatus",
      ],
    },
    customer: {
      propDefinition: [
        woocommerce,
        "customer",
      ],
    },
    paymentMethod: {
      propDefinition: [
        woocommerce,
        "paymentMethod",
      ],
    },
    products: {
      propDefinition: [
        woocommerce,
        "products",
      ],
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.products) {
      for (const product of this.products) {
        props[`quantity${product.value}`] = {
          type: "integer",
          label: `Quantity of ${product.label}`,
          description: `Enter the quantity of ${product.label} for the new order`,
        };
      }
      return props;
    }
  },
  async run({ $ }) {
    const lineItems = this.products.map((product) => ({
      product_id: product.value,
      quantity: this[`quantity${product.value}`],
    }));
    const data = {
      status: this.status,
      customer_id: this.customer,
      payment_method: this.paymentMethod,
      line_items: lineItems,
    };
    const res = await this.woocommerce.createOrder(data);
    $.export("$summary", `Successfully created order ID: ${res.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
WooCommerce	`woocommerce`	`app`	This component uses the WooCommerce app.
Status	`status`	`string`	Select a value from the drop down menu:`pendingprocessingon-holdcompletedcancelledrefundedfailedtrash`
Customer	`customer`	`integer`	Select a value from the drop down menu.
Payment Method	`paymentMethod`	`string`	Select a value from the drop down menu.
Products	`products`	`string[]`	Select a value from the drop down menu.

Create Order with WooCommerce API on New Shipment Status from shipcloud API

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

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

Developers ♥ Pipedream

1-24of2,400+apps by most popular

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