Create Shipment with shipcloud API on Daily schedule from Schedule API

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

Trigger workflow on

Daily schedule from the Schedule API

Next, do this

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

Select this integration
Configure the Daily schedule trigger
1. Connect your Schedule account
2. Configure Cron Schedule
Configure the Create Shipment action
1. Connect your shipcloud account
2. Select a Carrier
3. Select a Service
4. Select a Recipient Address
5. Select a Sender Address
6. Configure Package
7. Optional- Configure Additional Options
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#

Daily schedule on Schedule

Description:Trigger your workflow every day.

Version:0.0.1

Key:schedule-daily

View on GitHub

Schedule Overview#

The Schedule app in Pipedream is a powerful tool that allows you to trigger workflows at regular intervals, ranging from every minute to once a year. This enables the automation of repetitive tasks and the scheduling of actions to occur without manual intervention. By leveraging this API, you can execute code, run integrations, and process data on a reliable schedule, all within Pipedream's serverless environment.

Trigger Code#

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

export default {
  name: "Daily schedule",
  version: "0.0.1",
  key: "schedule-daily",
  type: "source",
  description: "Trigger your workflow every day.",
  props: {
    schedule,
    cron: {
      propDefinition: [
        schedule,
        "cron",
      ],
      default: {
        cron: "0 11 * * *",
      },
    },
  },
};

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
Schedule	`schedule`	`app`	This component uses the Schedule app.
Cron Schedule	`cron`	`$.interface.timer`	Enter a cron expression

Trigger Authentication#

The Schedule API does not require authentication.

About Schedule#

Trigger workflows on an interval or cron schedule.

Action#

Create Shipment on shipcloud

Description:Create a shipment [See docs here](https://developers.shipcloud.io/reference/#creating-a-shipment)

Version:0.0.1

Key:shipcloud-create-shipment

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.

Action Code#

import shipcloud from "../../app/shipcloud.app.mjs";
import { defineAction } from "@pipedream/types";
export default defineAction({
    name: "Create Shipment",
    description: "Create a shipment [See docs here](https://developers.shipcloud.io/reference/#creating-a-shipment)",
    key: "shipcloud-create-shipment",
    version: "0.0.1",
    type: "action",
    props: {
        shipcloud,
        carrier: {
            propDefinition: [
                shipcloud,
                "carrier",
            ],
        },
        service: {
            propDefinition: [
                shipcloud,
                "service",
            ],
        },
        toAddress: {
            propDefinition: [
                shipcloud,
                "address",
            ],
        },
        fromAddress: {
            propDefinition: [
                shipcloud,
                "address",
            ],
            label: "Sender Address",
        },
        package: {
            propDefinition: [
                shipcloud,
                "package",
            ],
        },
        additionalOptions: {
            type: "object",
            label: "Additional Options",
            description: "Optional parameters to pass, such as `description` or `notification_email` [(more info on the Shipcloud Docs)](https://developers.shipcloud.io/reference/#creating-a-shipment)",
            optional: true,
        },
    },
    async run({ $ }) {
        const params = {
            $,
            data: {
                carrier: this.carrier,
                service: this.service,
                to: JSON.parse(this.toAddress),
                from: JSON.parse(this.fromAddress),
                package: this.package,
                additionalOptions: this.additionalOptions,
            },
        };
        const data = await this.shipcloud.createShipment(params);
        $.export("$summary", "Created shipment successfully");
        return data;
    },
});

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
shipcloud	`shipcloud`	`app`	This component uses the shipcloud app.
Carrier	`carrier`	`string`	Select a value from the drop down menu:`{ "label": "Angel DE", "value": "angel_de" }{ "label": "Cargo International", "value": "cargo_international" }{ "label": "DHL", "value": "dhl" }{ "label": "DHL Express", "value": "dhl_express" }{ "label": "DPAG", "value": "dpag" }{ "label": "DPD", "value": "dpd" }{ "label": "GLS", "value": "gls" }{ "label": "go", "value": "go" }{ "label": "hermes", "value": "hermes" }{ "label": "iloxx (MyDPD Business", "value": "iloxx" }{ "label": "PARCEL.ONE", "value": "parcel_one" }{ "label": "UPS", "value": "ups" }`
Service	`service`	`string`	Select a value from the drop down menu:`{ "label": "Standard", "value": "standard" }{ "label": "One Day", "value": "one_day" }{ "label": "One Day Early", "value": "one_day_early" }{ "label": "Returns", "value": "returns" }{ "label": "Asendia e-PAQ Standard Economy", "value": "asendia_epaq_standard_economy" }{ "label": "Asendia e-PAQ Standard Priority", "value": "asendia_epaq_standard_priority" }{ "label": "Cargo International Express", "value": "cargo_international_express" }{ "label": "DHL Europaket", "value": "dhl_europaket" }{ "label": "DHL Prio", "value": "dhl_prio" }{ "label": "DHL Warenpost", "value": "dhl_warenpost" }{ "label": "DPAG Warenpost", "value": "dpag_warenpost" }{ "label": "DPAG Warenpost Signature", "value": "dpag_warenpost_signature" }{ "label": "DPAG Warenpost Untracked", "value": "dpag_warenpost_untracked" }{ "label": "GLS Express 0800", "value": "gls_express_0800" }{ "label": "GLS Express 0900", "value": "gls_express_0900" }{ "label": "GLS Express 1000", "value": "gls_express_1000" }{ "label": "GLS Express 1200", "value": "gls_express_1200" }{ "label": "UPS Express 1200", "value": "ups_express_1200" }`
Recipient Address	`toAddress`	`string`	Select a value from the drop down menu.
Sender Address	`fromAddress`	`string`	Select a value from the drop down menu.
Package	`package`	`object`	Object describing the package. Required fields are `height`, `length`, `weight` and `width`. (See more info on the Shipcloud Docs)
Additional Options	`additionalOptions`	`object`	Optional parameters to pass, such as `description` or `notification_email` (more info on the Shipcloud Docs)