Update Stock with Billbee API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Update Stock with the Billbee 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 Billbee 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 Update Stock action
1. Connect your Billbee account
2. Select a SKU
3. Optional- Select a Stock ID
4. Optional- Select a Product ID
5. Optional- Configure Reason
6. Optional- Configure Old Quantity
7. Optional- Configure New Quantity
8. Optional- Configure Force Send Stock To Shops
9. Optional- Configure Autosubtract Reserved Amount
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#

Update Stock on Billbee

Description:Update the stock level for a single product. [See the documentation](https://app.billbee.io//swagger/ui/index#/Products/Article_UpdateStock)

Version:0.0.2

Key:billbee-update-stock

View on GitHub

Action Code#

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

export default {
  key: "billbee-update-stock",
  name: "Update Stock",
  description: "Update the stock level for a single product. [See the documentation](https://app.billbee.io//swagger/ui/index#/Products/Article_UpdateStock)",
  type: "action",
  version: "0.0.2",
  annotations: {
    destructiveHint: true,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    sku: {
      type: "string",
      label: "SKU",
      description: "The SKU of the product to update",
      propDefinition: [
        app,
        "product",
        () => ({
          filter: ({ SKU: sku }) => !!sku,
          mapper: ({
            SKU: value, Title: title,
          }) => ({
            value,
            label: title?.[0]?.Text || "Untitled",
          }),
        }),
      ],
    },
    stockId: {
      propDefinition: [
        app,
        "stockId",
      ],
    },
    billbeeId: {
      description: "The Billbee ID of the product to update",
      optional: true,
      propDefinition: [
        app,
        "product",
      ],
    },
    reason: {
      type: "string",
      label: "Reason",
      description: "Reason for the stock update",
      optional: true,
    },
    oldQuantity: {
      type: "string",
      label: "Old Quantity",
      description: "The old stock quantity to set",
      optional: true,
    },
    newQuantity: {
      type: "string",
      label: "New Quantity",
      description: "The new stock quantity to set",
      optional: true,
    },
    forceSendStockToShops: {
      type: "boolean",
      label: "Force Send Stock To Shops",
      description: "If true, every sent stockchange is stored and transmitted to the connected shop, even if the value has not changed",
      optional: true,
    },
    autosubtractReservedAmount: {
      type: "boolean",
      label: "Autosubtract Reserved Amount",
      description: "Automatically reduce the NewQuantity by the currently not fulfilled amount",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      app,
      stockId,
      billbeeId,
      sku,
      reason,
      oldQuantity,
      newQuantity,
      forceSendStockToShops,
      autosubtractReservedAmount,
    } = this;

    const response = await app.updateStock({
      $,
      data: {
        StockId: stockId,
        BillbeeId: billbeeId,
        Sku: sku,
        Reason: reason,
        OldQuantity: oldQuantity,
        NewQuantity: newQuantity,
        ForceSendStockToShops: forceSendStockToShops,
        AutosubtractReservedAmount: autosubtractReservedAmount,
      },
    });

    $.export("$summary", "Successfully updated stock");

    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
Billbee	`app`	`app`	This component uses the Billbee app.
SKU	`sku`	`string`	Select a value from the drop down menu.
Stock ID	`stockId`	`string`	Select a value from the drop down menu.
Product ID	`billbeeId`	`string`	Select a value from the drop down menu.
Reason	`reason`	`string`	Reason for the stock update
Old Quantity	`oldQuantity`	`string`	The old stock quantity to set
New Quantity	`newQuantity`	`string`	The new stock quantity to set
Force Send Stock To Shops	`forceSendStockToShops`	`boolean`	If true, every sent stockchange is stored and transmitted to the connected shop, even if the value has not changed
Autosubtract Reserved Amount	`autosubtractReservedAmount`	`boolean`	Automatically reduce the NewQuantity by the currently not fulfilled amount