List Integration Shipments with Sendcloud API on New Event (Instant) from ShipStation API

Pipedream makes it easy to connect APIs for Sendcloud, ShipStation and 2,800+ other apps remarkably fast.

Trigger workflow on

New Event (Instant) from the ShipStation API

Next, do this

List Integration Shipments with the Sendcloud 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 ShipStation trigger and Sendcloud action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Event (Instant) trigger
1. Connect your ShipStation account
2. Select a Event Type
3. Optional- Select a Store
Configure the List Integration Shipments action
1. Connect your Sendcloud account
2. Select a Integration ID
3. Select a Sender Address ID
4. Optional- Configure External Order IDs
5. Optional- Configure External Shipment IDs
6. Optional- Configure End Date
7. Optional- Configure Order Number
8. Optional- Configure Enable Shipping Rules
9. Optional- Configure Start Date
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 Event (Instant) on ShipStation

Description:Emit new event for each new webhook event received. [See docs here](https://www.shipstation.com/docs/api/webhooks/subscribe/)

Version:0.0.1

Key:shipstation-new-event

View on GitHub

ShipStation Overview#

The ShipStation API allows for streamlined management of shipping operations for e-commerce. With it, you can automate order processing, label creation, and tracking updates. Pipedream excels as a platform for integrating ShipStation with other services to create custom workflows.

Trigger Code#

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

export default {
  ...base,
  key: "shipstation-new-event",
  name: "New Event (Instant)",
  description: "Emit new event for each new webhook event received. [See docs here](https://www.shipstation.com/docs/api/webhooks/subscribe/)",
  version: "0.0.1",
  type: "source",
  methods: {
    ...base.methods,
    async emitEvent(event) {
      const { body } = event;

      const resource = await this.shipstation.getResourceByUrl({
        url: body.resource_url,
      });

      const ts = new Date();

      this.$emit(resource, {
        id: ts,
        summary: `New event ${ts.getTime()} received`,
        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
ShipStation	`shipstation`	`app`	This component uses the ShipStation 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 Type	`eventType`	`string`	Select a value from the drop down menu:`{ "label": "On New Orders", "value": "ORDER_NOTIFY" }{ "label": "On New Items", "value": "ITEM_ORDER_NOTIFY" }{ "label": "On Orders Shipped", "value": "SHIP_NOTIFY" }{ "label": "On Items Shipped", "value": "ITEM_SHIP_NOTIFY" }`
Store	`storeId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

The ShipStation API uses Basic HTTP authentication. Use your ShipStation API Key as the username and API Secret as the password. You can find your API Key under Settings

About ShipStation#

Import, manage and ship your orders with ShipStation

Action#

List Integration Shipments on Sendcloud

Description:List integration shipments. [See the documentation](https://api.sendcloud.dev/docs/sendcloud-public-api/branches/v2/integrations/operations/list-integration-shipments)

Version:0.0.2

Key:sendcloud-list-integration-shipments

View on GitHub

Sendcloud Overview#

The Sendcloud API offers a suite of tools for streamlining shipping processes for e-commerce businesses. Using the API, you can create and manage shipments, print shipping labels, track packages, and handle returns with ease. When integrated with Pipedream, the Sendcloud API enables you to automate your shipping workflow, connect with other apps and services, and create custom notifications and actions based on shipping events.

Action Code#

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

export default {
  key: "sendcloud-list-integration-shipments",
  name: "List Integration Shipments",
  description: "List integration shipments. [See the documentation](https://api.sendcloud.dev/docs/sendcloud-public-api/branches/v2/integrations/operations/list-integration-shipments)",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  type: "action",
  props: {
    app,
    integrationId: {
      propDefinition: [
        app,
        "integrationId",
      ],
    },
    senderAddress: {
      propDefinition: [
        app,
        "senderAddress",
      ],
    },
    externalOrderIds: {
      type: "string[]",
      label: "External Order IDs",
      description: "Filter to shipments where `external_order_id` matches one of these values.",
      optional: true,
    },
    externalShipmentIds: {
      type: "string[]",
      label: "External Shipment IDs",
      description: "Filter to shipments where `external_shipment_id` matches one of these values.",
      optional: true,
    },
    endDate: {
      type: "string",
      label: "End Date",
      description: "Displays orders up to the given date (inclusive). Format: `YYYY-MM-DD`. Defaults to current date.",
      optional: true,
    },
    orderNumber: {
      type: "string",
      label: "Order Number",
      description: "Filter to shipments matching this order number.",
      optional: true,
    },
    shippingRules: {
      type: "boolean",
      label: "Enable Shipping Rules",
      description: "Enable shipping rules when retrieving orders (impacts `allowed_shipping_methods`).",
      optional: true,
    },
    startDate: {
      type: "string",
      label: "Start Date",
      description: "Displays orders from the given date (inclusive). Format: `YYYY-MM-DD`. Defaults to one year ago.",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      integrationId,
      endDate,
      externalOrderIds,
      externalShipmentIds,
      orderNumber,
      senderAddress,
      shippingRules,
      startDate,
    } = this;

    const response = await app.paginate({
      requester: app.listIntegrationShipments,
      requesterArgs: {
        $,
        integrationId,
        params: {
          end_date: endDate,
          external_order_ids: externalOrderIds,
          external_shipment_ids: externalShipmentIds,
          order_number: orderNumber,
          sender_address: senderAddress,
          shipping_rules: shippingRules,
          start_date: startDate,
        },
      },
      resultsKey: "results",
    });

    $.export("$summary", `Successfully retrieved \`${response.length}\` integration shipment(s)`);

    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
Sendcloud	`app`	`app`	This component uses the Sendcloud app.
Integration ID	`integrationId`	`string`	Select a value from the drop down menu.
Sender Address ID	`senderAddress`	`string`	Select a value from the drop down menu.
External Order IDs	`externalOrderIds`	`string[]`	Filter to shipments where `external_order_id` matches one of these values.
External Shipment IDs	`externalShipmentIds`	`string[]`	Filter to shipments where `external_shipment_id` matches one of these values.
End Date	`endDate`	`string`	Displays orders up to the given date (inclusive). Format: `YYYY-MM-DD`. Defaults to current date.
Order Number	`orderNumber`	`string`	Filter to shipments matching this order number.
Enable Shipping Rules	`shippingRules`	`boolean`	Enable shipping rules when retrieving orders (impacts `allowed_shipping_methods`).
Start Date	`startDate`	`string`	Displays orders from the given date (inclusive). Format: `YYYY-MM-DD`. Defaults to one year ago.

Action Authentication#

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

To retrieve your API Keys,

Navigate to your Sendcloud account and sign in
Click on the settings menu with the gear icon on the top right
Go to “Integrations”
Search for “API” within the Search Integrations box, and click Connect

List Integration Shipments with Sendcloud API on New Event (Instant) from ShipStation API

Pipedream makes it easy to connect APIs for Sendcloud, ShipStation and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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