Validate Shipment with FedEx API on New Download Counts from npm API

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

Trigger workflow on

New Download Counts from the npm API

Next, do this

Validate Shipment with the FedEx 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 FedEx 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 Validate Shipment action
1. Connect your FedEx account
2. Configure Account Number
3. Configure Shipper Street Lines
4. Configure Shipper City
5. Optional- Configure Shipper State Or Province Code
6. Optional- Configure Shipper Postal Code
7. Configure Shipper Country Code
8. Configure Shipper Contact Name
9. Configure Shipper Phone Number
10. Configure Recipient Street Lines
11. Configure Recipient City
12. Optional- Configure Recipient State Or Province Code
13. Optional- Configure Recipient Postal Code
14. Configure Recipient Country Code
15. Configure Recipient Contact Name
16. Configure Recipient Phone Number
17. Select a Pickup Type
18. Configure Service Type
19. Configure Packaging Type
20. Configure Total Weight
21. Select a Payment Type
22. Select a Label Format Type
23. Select a Label Stock Type
24. Select a Image Type
25. Select a Weight Unit
26. Configure Weights
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#

Validate Shipment on FedEx

Description:Validate a shipment. [See the documentation](https://developer.fedex.com/api/en-us/catalog/ship/docs.html#operation/ShipmentPackageValidate)

Version:0.0.1

Key:fedex-validate-shipment

View on GitHub

FedEx Overview#

The FedEx API provides a direct line to FedEx's shipping, tracking, and rate services, allowing you to automate the logistics within your business processes. Whether you're automating notifications based on shipment statuses, streamlining the creation of shipping labels, or integrating real-time shipping rates into your checkout process, this API offers a wealth of possibilities to enhance efficiency and customer satisfaction.

Action Code#

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

export default {
  key: "fedex-validate-shipment",
  name: "Validate Shipment",
  description: "Validate a shipment. [See the documentation](https://developer.fedex.com/api/en-us/catalog/ship/docs.html#operation/ShipmentPackageValidate)",
  version: "0.0.1",
  type: "action",
  props: {
    fedex,
    accountNumber: {
      propDefinition: [
        fedex,
        "accountNumber",
      ],
    },
    shipperStreetLines: {
      propDefinition: [
        fedex,
        "shipperStreetLines",
      ],
    },
    shipperCity: {
      propDefinition: [
        fedex,
        "shipperCity",
      ],
    },
    shipperStateOrProvinceCode: {
      propDefinition: [
        fedex,
        "shipperStateOrProvinceCode",
      ],
    },
    shipperPostalCode: {
      propDefinition: [
        fedex,
        "shipperPostalCode",
      ],
    },
    shipperCountryCode: {
      propDefinition: [
        fedex,
        "shipperCountryCode",
      ],
    },
    shipperContactName: {
      propDefinition: [
        fedex,
        "shipperContactName",
      ],
    },
    shipperPhoneNumber: {
      propDefinition: [
        fedex,
        "shipperPhoneNumber",
      ],
    },
    recipientStreetLines: {
      propDefinition: [
        fedex,
        "recipientStreetLines",
      ],
    },
    recipientCity: {
      propDefinition: [
        fedex,
        "recipientCity",
      ],
    },
    recipientStateOrProvinceCode: {
      propDefinition: [
        fedex,
        "recipientStateOrProvinceCode",
      ],
    },
    recipientPostalCode: {
      propDefinition: [
        fedex,
        "recipientPostalCode",
      ],
    },
    recipientCountryCode: {
      propDefinition: [
        fedex,
        "recipientCountryCode",
      ],
    },
    recipientContactName: {
      propDefinition: [
        fedex,
        "recipientContactName",
      ],
    },
    recipientPhoneNumber: {
      propDefinition: [
        fedex,
        "recipientPhoneNumber",
      ],
    },
    pickupType: {
      propDefinition: [
        fedex,
        "pickupType",
      ],
    },
    serviceType: {
      propDefinition: [
        fedex,
        "serviceType",
      ],
    },
    packagingType: {
      propDefinition: [
        fedex,
        "packagingType",
      ],
    },
    totalWeight: {
      propDefinition: [
        fedex,
        "totalWeight",
      ],
    },
    paymentType: {
      propDefinition: [
        fedex,
        "paymentType",
      ],
    },
    labelFormatType: {
      propDefinition: [
        fedex,
        "labelFormatType",
      ],
    },
    labelStockType: {
      propDefinition: [
        fedex,
        "labelStockType",
      ],
    },
    imageType: {
      propDefinition: [
        fedex,
        "imageType",
      ],
    },
    weightUnit: {
      propDefinition: [
        fedex,
        "weightUnit",
      ],
    },
    weights: {
      propDefinition: [
        fedex,
        "weights",
      ],
    },
  },
  async run({ $ }) {
    const response = await this.fedex.validateShipment({
      $,
      data: {
        requestedShipment: {
          shipper: {
            address: {
              streetLines: this.shipperStreetLines,
              city: this.shipperCity,
              stateOrProvinceCode: this.shipperStateOrProvinceCode,
              postalCode: this.shipperPostalCode,
              countryCode: this.shipperCountryCode,
            },
            contact: {
              personName: this.shipperContactName,
              phoneNumber: this.shipperPhoneNumber,
            },
          },
          recipients: [
            {
              address: {
                streetLines: this.recipientStreetLines,
                city: this.recipientCity,
                stateOrProvinceCode: this.recipientStateOrProvinceCode,
                postalCode: this.recipientPostalCode,
                countryCode: this.recipientCountryCode,
              },
              contact: {
                personName: this.recipientContactName,
                phoneNumber: this.recipientPhoneNumber,
              },
            },
          ],
          pickupType: this.pickupType,
          serviceType: this.serviceType,
          packagingType: this.packagingType,
          totalWeight: +this.totalWeight,
          shippingChargesPayment: {
            paymentType: this.paymentType,
          },
          labelSpecification: {
            labelFormatType: this.labelFormatType,
            labelStockType: this.labelStockType,
            imageType: this.imageType,
          },
          requestedPackageLineItems: this.weights.map((weight) => ({
            weight: {
              units: this.weightUnit,
              value: +weight,
            },
          })),
        },
      },
    });
    $.export("$summary", "Shipment validated successfully");
    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
FedEx	`fedex`	`app`	This component uses the FedEx app.
Account Number	`accountNumber`	`string`	The account number associated with the shipment
Shipper Street Lines	`shipperStreetLines`	`string[]`	Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35. Example: [1550 Union Blvd,Suite 302]
Shipper City	`shipperCity`	`string`	The name of city, town of the recipient.Max length is 35. Example: Beverly Hills
Shipper State Or Province Code	`shipperStateOrProvinceCode`	`string`	It is used to identify the principal subdivisions (e.g., provinces or states) of countries. The Format and presence of this field may vary depending on the country. Note: For specific countries, such as the United States and Canada, and Puerto Rico, there is a two-character state, province, codes limit . Example: TX
Shipper Postal Code	`shipperPostalCode`	`string`	This is the postal code. Note: This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247
Shipper Country Code	`shipperCountryCode`	`string`	Is a capitalized two-character alpha code representing the country of the address. Example: US
Shipper Contact Name	`shipperContactName`	`string`	Contact name, e.g. for customer support. Maximum length is 35. Example: John Doe
Shipper Phone Number	`shipperPhoneNumber`	`string`	Contact phone number, e.g. for customer support. Maximum length is 10. Example: 15014321111
Recipient Street Lines	`recipientStreetLines`	`string[]`	Combination of number, street name, etc. At least one line is required for a valid physical address. Empty lines should not be included. Max Length is 35. Example: [1550 Union Blvd,Suite 302]
Recipient City	`recipientCity`	`string`	The name of city, town of the recipient.Max length is 35. Example: Beverly Hills
Recipient State Or Province Code	`recipientStateOrProvinceCode`	`string`	It is used to identify the principal subdivisions (e.g., provinces or states) of countries. The Format and presence of this field may vary depending on the country. Note: For specific countries, such as the United States and Canada, and Puerto Rico, there is a two-character state, province, codes limit . Example: TX
Recipient Postal Code	`recipientPostalCode`	`string`	This is the postal code. Note: This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247
Recipient Country Code	`recipientCountryCode`	`string`	Is a capitalized two-character alpha code representing the country of the address. Example: US
Recipient Contact Name	`recipientContactName`	`string`	Contact name, e.g. for customer support. Maximum length is 35. Example: John Doe
Recipient Phone Number	`recipientPhoneNumber`	`string`	Contact phone number, e.g. for customer support. Maximum length is 10. Example: 15014321111
Pickup Type	`pickupType`	`string`	Select a value from the drop down menu:`CONTACT_FEDEX_TO_SCHEDULEDROPOFF_AT_FEDEX_LOCATIONUSE_SCHEDULED_PICKUP`
Service Type	`serviceType`	`string`	Indicate the FedEx service type used for this shipment
Packaging Type	`packagingType`	`string`	Specify the packaging type used
Total Weight	`totalWeight`	`string`	Indicate the shipment total weight in pounds
Payment Type	`paymentType`	`string`	Select a value from the drop down menu:`SENDERRECIPIENTTHIRD_PARTYCOLLECT`
Label Format Type	`labelFormatType`	`string`	Select a value from the drop down menu:`COMMON2DLABEL_DATA_ONLY`
Label Stock Type	`labelStockType`	`string`	Select a value from the drop down menu:`PAPER_4X6STOCK_4X675PAPER_4X675PAPER_4X8PAPER_4X9PAPER_7X475PAPER_85X11_BOTTOM_HALF_LABELPAPER_85X11_TOP_HALF_LABELPAPER_LETTERSTOCK_4X675_LEADING_DOC_TABSTOCK_4X8STOCK_4X9_LEADING_DOC_TABSTOCK_4X6STOCK_4X675_TRAILING_DOC_TABSTOCK_4X9_TRAILING_DOC_TABSTOCK_4X9STOCK_4X85_TRAILING_DOC_TABSTOCK_4X105_TRAILING_DOC_TAB`
Image Type	`imageType`	`string`	Select a value from the drop down menu:`ZPLIIEPL2PDFPNG`
Weight Unit	`weightUnit`	`string`	Select a value from the drop down menu:`LBKG`
Weights	`weights`	`string[]`	An array of weight values for each of the requested pieces of the shipment

Action Authentication#

FedEx uses OAuth authentication. When you connect your FedEx account, Pipedream will open a popup window where you can sign into FedEx and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any FedEx API.

Pipedream requests the following authorization scopes when you connect your account: