Create Order with Printful API on New Download Counts from npm API

Pipedream makes it easy to connect APIs for Printful, npm and 2,500+ other apps remarkably fast.

Trigger workflow on

New Download Counts from the npm API

Next, do this

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

Select this integration
Configure the New Download Counts trigger
1. Connect your npm account
2. Configure timer
3. Select a Period
4. Optional- Configure Package
Configure the Create Order action
1. Connect your Printful account
2. Select a Store ID
3. Optional- Configure External ID
4. Configure Recipient Name
5. Optional- Configure Recipient Company Name
6. Configure Address 1
7. Optional- Configure Address 2
8. Configure City
9. Configure State Code
10. Configure Country Code
11. Optional- Configure Tax Number
12. Configure ZIP/Postal Code
13. Optional- Configure Phone
14. Optional- Configure Email
15. Optional- Configure Gift Subject
16. Optional- Configure Gift Message
17. Configure Items
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 Download Counts on npm

Description:Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).

Version:0.1.0

Key:npm-download-counts

View on GitHub

Trigger Code#

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

export default {
  key: "npm-download-counts",
  name: "New Download Counts",
  description: "Emit new event with the latest count of downloads for an npm package. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md).",
  version: "0.1.0",
  type: "source",
  props: {
    app,
    db: "$.service.db",
    timer: {
      type: "$.interface.timer",
      description: "One day interval time is recommended because NPM only update metrics once a day. [See the documentation](https://github.com/npm/registry/blob/main/docs/download-counts.md#data-source).",
      default: {
        intervalSeconds: 60 * 60 * 24,
      },
    },
    period: {
      type: "string",
      label: "Period",
      description: "Select last-day, last-week or last-month.",
      optional: false,
      default: "last-day",
      options: [
        "last-day",
        "last-week",
        "last-month",
      ],
    },
    packageName: {
      type: "string",
      label: "Package",
      description: "Enter an npm package name. Leave blank for all",
      optional: true,
    },
  },
  methods: {
    getDownloadCounts({
      period, packageName, ...args
    } = {}) {
      const basePath = `/downloads/point/${encodeURIComponent(period)}`;
      return this.app.makeRequest({
        path: packageName
          ? `${basePath}/${encodeURIComponent(packageName)}`
          : basePath,
        ...args,
      });
    },
  },
  async run({ timestamp: ts }) {
    const {
      getDownloadCounts,
      period,
      packageName,
    } = this;

    const response = await getDownloadCounts({
      period,
      packageName,
    });

    this.$emit(response, {
      id: ts,
      summary: `New Download Count ${response.downloads}`,
      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
npm	`app`	`app`	This component uses the npm app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`	One day interval time is recommended because NPM only update metrics once a day. See the documentation.
Period	`period`	`string`	Select a value from the drop down menu:`last-daylast-weeklast-month`
Package	`packageName`	`string`	Enter an npm package name. Leave blank for all

Trigger Authentication#

The npm API does not require authentication.

About npm#

Node package manager

Action#

Create Order on Printful

Description:Creates a new order in your Printful account. [See the documentaion](https://developers.printful.com/docs/#operation/createOrder)

Version:0.0.1

Key:printful-create-order

View on GitHub

Printful Overview#

The Printful API unlocks the ability to automate custom print-on-demand operations within Pipedream's serverless platform. With this API, you can streamline the process of managing products, submitting orders, and syncing inventory. Building workflows around the Printful API on Pipedream can significantly reduce manual intervention, connect your e-commerce data with other services, and enhance customer experiences through timely fulfillment and updates.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import printful from "../../printful.app.mjs";

export default {
  name: "Create Order",
  version: "0.0.1",
  key: "printful-create-order",
  description: "Creates a new order in your Printful account. [See the documentaion](https://developers.printful.com/docs/#operation/createOrder)",
  type: "action",
  props: {
    printful,
    storeId: {
      propDefinition: [
        printful,
        "storeId",
      ],
    },
    externalId: {
      label: "External ID",
      description: "Order ID from the external system",
      type: "string",
      optional: true,
    },
    recipientName: {
      label: "Recipient Name",
      description: "The recipient full name",
      type: "string",
    },
    recipientCompanyName: {
      label: "Recipient Company Name",
      description: "The recipient company name",
      type: "string",
      optional: true,
    },
    address1: {
      label: "Address 1",
      description: "The address 1",
      type: "string",
    },
    address2: {
      label: "Address 2",
      description: "The address 2",
      type: "string",
      optional: true,
    },
    city: {
      label: "City",
      description: "The city",
      type: "string",
    },
    stateCode: {
      label: "State Code",
      description: "The state code. E.g. `SC`",
      type: "string",
    },
    countryCode: {
      label: "Country Code",
      description: "The country code. E.g. `BR`",
      type: "string",
      reloadProps: true,
    },
    taxNumber: {
      label: "Tax Number",
      description: "TAX number (`optional`, but in case of Brazil country this field becomes `required` and will be used as CPF/CNPJ number)",
      type: "string",
      optional: true,
    },
    zip: {
      label: "ZIP/Postal Code",
      description: "The ZIP/postal code. E.g. `89221525`",
      type: "string",
      reloadProps: true,
    },
    phone: {
      label: "Phone",
      description: "The phone number",
      type: "string",
      optional: true,
    },
    email: {
      label: "Email",
      description: "The email",
      type: "string",
      optional: true,
    },
    giftSubject: {
      label: "Gift Subject",
      description: "Gift message title",
      type: "string",
      optional: true,
    },
    giftMessage: {
      label: "Gift Message",
      description: "Gift message text",
      type: "string",
      optional: true,
    },
    items: {
      label: "Items",
      description: "Array of items in the order. E.g. `[ { \"id\": 1, \"variant_id\": 2, \"quantity\": 3, \"price\": \"13.60\", \"retail_price\": \"9.90\", \"name\": \"Beauty Poster\", \"product\": { \"product_id\": 301, \"variant_id\": 500, \"name\": \"Red T-Shirt\" }, \"files\": [{\"url\": \"https://file.com/060b204a37f.png\"}] } ]`",
      type: "string[]",
    },
  },
  additionalProps(props) {
    props.taxNumber.optional = this.countryCode != "BR";
    return {};
  },
  async run({ $ }) {
    const response = await this.printful.createOrder({
      $,
      headers: {
        "X-PF-Store-Id": this.storeId,
      },
      data: {
        external_id: this.externalId,
        shipping: "STANDARD",
        recipient: {
          name: this.recipientName,
          company: this.recipientCompanyName,
          address1: this.address1,
          address2: this.address2,
          city: this.city,
          state_code: this.stateCode,
          country_code: this.countryCode,
          zip: this.zip,
          phone: this.phone,
          email: this.email,
          tax_number: this.taxNumber,
        },
        gift: {
          subject: this.giftSubject,
          message: this.giftMessage,
        },
        items: parseObject(this.items),
      },
    });

    if (response) {
      $.export("$summary", `Successfully created order with id ${response.result.id}`);
    }

    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
Printful	`printful`	`app`	This component uses the Printful app.
Store ID	`storeId`	`string`	Select a value from the drop down menu.
External ID	`externalId`	`string`	Order ID from the external system
Recipient Name	`recipientName`	`string`	The recipient full name
Recipient Company Name	`recipientCompanyName`	`string`	The recipient company name
Address 1	`address1`	`string`	The address 1
Address 2	`address2`	`string`	The address 2
City	`city`	`string`	The city
State Code	`stateCode`	`string`	The state code. E.g. `SC`
Country Code	`countryCode`	`string`	The country code. E.g. `BR`
Tax Number	`taxNumber`	`string`	TAX number (`optional`, but in case of Brazil country this field becomes `required` and will be used as CPF/CNPJ number)
ZIP/Postal Code	`zip`	`string`	The ZIP/postal code. E.g. `89221525`
Phone	`phone`	`string`	The phone number
Email	`email`	`string`	The email
Gift Subject	`giftSubject`	`string`	Gift message title
Gift Message	`giftMessage`	`string`	Gift message text
Items	`items`	`string[]`	Array of items in the order. E.g. `[ { "id": 1, "variant_id": 2, "quantity": 3, "price": "13.60", "retail_price": "9.90", "name": "Beauty Poster", "product": { "product_id": 301, "variant_id": 500, "name": "Red T-Shirt" }, "files": [{"url": "https://file.com/060b204a37f.png"}] } ]`

Action Authentication#

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

Generate Printful API Token by on Printful Developer Page > Tokens > Add new Token.
Required scopes for the API Token: