Create Article with Shopify API on New Shipment Status from shipcloud API

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

Trigger workflow on

New Shipment Status from the shipcloud API

Next, do this

Create Article with the Shopify 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 Shopify 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 Article action
1. Connect your Shopify account
2. Select a Blog ID
3. Configure Title
4. Configure Body HTML
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 Article on Shopify

Description:Create a new blog article. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/article#post-blogs-blog-id-articles)

Version:0.0.4

Key:shopify_developer_app-create-article

View on GitHub

Shopify Overview#

The Shopify Admin REST & GraphQL API unleashes a myriad of possibilities to automate and enhance online store operations. It provides programmatic access to Shopify functionalities, allowing users to manage products, customers, orders, and more. Leveraging the Shopify Admin API within Pipedream, developers can create custom workflows that automate repetitive tasks, sync data across platforms, and respond dynamically to events in Shopify.

This integration can be used as a custom app on your store, or for automating actions on behalf of merchants through your Shopify app.

Looking for integrating into the Shopify Partner API for your apps, themes or referrals? Check out our Shopify Partner API integration.

Action Code#

import app from "../../common/rest-admin.mjs";
import common from "../../../shopify/actions/create-article/common.mjs";

export default {
  ...common,
  key: "shopify_developer_app-create-article",
  name: "Create Article",
  description: "Create a new blog article. [See The Documentation](https://shopify.dev/docs/api/admin-rest/2023-04/resources/article#post-blogs-blog-id-articles)",
  version: "0.0.4",
  type: "action",
  props: {
    app,
    blogId: {
      propDefinition: [
        app,
        "blogId",
      ],
    },
    title: {
      description: "The title of the article.",
      propDefinition: [
        app,
        "title",
      ],
    },
    bodyHtml: {
      description: "The text content of the article, complete with HTML markup.",
      propDefinition: [
        app,
        "bodyHtml",
      ],
    },
  },
};

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
Shopify	`app`	`app`	This component uses the Shopify app.
Blog ID	`blogId`	`string`	Select a value from the drop down menu.
Title	`title`	`string`	The title of the article.
Body HTML	`bodyHtml`	`string`	The text content of the article, complete with HTML markup.

Action Authentication#

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

Get your Access Token

Create a custom app in Shopify to obtain your Admin API access token. See our detailed instructions here.

Enter your Admin API access token below, and save it in a secure location (we recommend using a password manager such as 1Password)

Create Article with Shopify API on New Shipment Status from shipcloud API

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

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

Developers ♥ Pipedream

Get your Access Token

1-24of2,400+apps by most popular

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