List Integration Shipments with Sendcloud API

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

Trigger workflow on

HTTP requests, schedules and app events

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#

Create a workflow to List Integration Shipments with the Sendcloud API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

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
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

List Integration Shipments with Sendcloud API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Sendcloud

Try it

List Integration Shipments with Sendcloud API on New Submission from Typeform API

Typeform + Sendcloud

Try it

List Integration Shipments with Sendcloud API on New Submission (Instant) from Jotform API

Jotform + Sendcloud

Try it

List Integration Shipments with Sendcloud API on New Scheduled Tasks from Pipedream API

Pipedream + Sendcloud

Try it

List Integration Shipments with Sendcloud API on New Download Counts from npm API

npm + Sendcloud

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

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

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;
  },
};

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
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.

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,