Search Customers with Printavo API on New Shipment Status from shipcloud API

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

Trigger workflow on

New Shipment Status from the shipcloud API

Next, do this

Search Customers with the Printavo API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

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

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a shipcloud trigger and Printavo 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 Search Customers action
1. Connect your Printavo account
2. Optional- Configure Query
3. Optional- Select a Sort Column
4. Optional- Select a Sort Order
5. Configure Max Results
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#

Search Customers on Printavo

Description:Search customers. [See the docs here](https://printavo.docs.apiary.io/#reference/customers/customers-collection/customers-search)

Version:0.0.1

Key:printavo-search-customers

View on GitHub

Printavo Overview#

The Printavo API allows for the automation of print shop management tasks, enabling users to streamline their operations by integrating their Printavo account with various other apps and services. With Pipedream's serverless platform, you can create workflows that trigger actions in Printavo or respond to events from Printavo, such as updating order statuses, syncing customer data, or automating notifications and reminders, all without writing complex code.

Action Code#

import app from "../../printavo.app.mjs";
import options from "../../common/options.mjs";

export default {
  name: "Search Customers",
  description: "Search customers. [See the docs here](https://printavo.docs.apiary.io/#reference/customers/customers-collection/customers-search)",
  key: "printavo-search-customers",
  version: "0.0.1",
  type: "action",
  props: {
    app,
    query: {
      type: "string",
      label: "Query",
      description: "Query to search",
      optional: true,
    },
    sortColumn: {
      type: "string",
      label: "Sort Column",
      description: "Column to sort by. Default is `first_name`",
      options: options.SORT_COLUMN,
      optional: true,
    },
    sortOrder: {
      type: "string",
      label: "Sort Order",
      description: "Order to sort by. Default is `asc`",
      options: options.SORT_ORDER,
      optional: true,
    },
    maxResults: {
      type: "integer",
      label: "Max Results",
      description: "Maximum number of results to return.",
      default: 100,
      min: 1,
      max: 10000,
    },
  },
  async run({ $ }) {
    const params = {
      query: this.query,
      sort_column: this.sortColumn,
      direction: this.sortOrder,
      page: 1,
    };

    let res = [];
    while (true) {
      const { data } = await this.app.searchCustomers(params);
      res = res.concat(data);
      if (data.length === 0 || res.length >= this.maxResults) {
        break;
      }
      params.page = params.page + 1;
    }

    $.export("$summary", `Successfully fetched ${res.length} register(s)`);
    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
Printavo	`app`	`app`	This component uses the Printavo app.
Query	`query`	`string`	Query to search
Sort Column	`sortColumn`	`string`	Select a value from the drop down menu:`first_namelast_namecompanyemailorders_countcreated_atcustomer_id`
Sort Order	`sortOrder`	`string`	Select a value from the drop down menu:`ascdesc`
Max Results	`maxResults`	`integer`	Maximum number of results to return.