Validate Shipment with FedEx API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

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:

About FedEx#

Ship, manage, track, deliver

More Ways to Connect FedEx + Pipedream#

Other Popular Integrations#

Create Shipment with FedEx API on New Scheduled Tasks from Pipedream API

Pipedream + FedEx

Try it

Validate Shipment with FedEx API on Card Due Date Reminder from Pipedream API

Pipedream + FedEx

Try it

Create Shipment with FedEx API on Card Due Date Reminder from Pipedream API

Pipedream + FedEx

Try it

Popular Triggers#

New Scheduled Tasks from the Pipedream API

Exposes an HTTP API for scheduling messages to be emitted at a future time

Try it

New Upcoming Event Alert from the Pipedream API

Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. See the documentation for more information and instructions for connecting your Pipedream account.

Try it

Card Due Date Reminder from the Pipedream API

Emit new event at a specified time before a card is due.

Try it

New Upcoming Calendar Event from the Pipedream API

Emit new event when a Calendar event is upcoming, this source is using reminderMinutesBeforeStart property of the event to determine the time it should emit.

Try it