Track by Reference with FedEx API

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

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Track by Reference 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#

Create a workflow to Track by Reference with the FedEx API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Track by Reference action
1. Connect your FedEx account
2. Configure Reference Value
3. Optional- Configure Account Number
4. Optional- Configure Destination Postal Code
5. Optional- Configure Destination Country Code
6. Configure Ship Date Begin
7. Configure Ship Date End
8. Optional- Configure Include Detailed Scans
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Track by Reference on FedEx

Description:Tracks a package by reference number. [See the documentation](https://developer.fedex.com/api/en-us/catalog/track/v1/docs.html#operation/Track%20by%20References)

Version:0.0.1

Key:fedex-track-by-reference

View on GitHub

Code#

import fedex from "../../fedex.app.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "fedex-track-by-reference",
  name: "Track by Reference",
  description: "Tracks a package by reference number. [See the documentation](https://developer.fedex.com/api/en-us/catalog/track/v1/docs.html#operation/Track%20by%20References)",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: true,
  },
  props: {
    fedex,
    value: {
      type: "string",
      label: "Reference Value",
      description: "The reference value to track",
    },
    accountNumber: {
      type: "string",
      label: "Account Number",
      description: "The shipper's account number. Either `accountNumber` or `destinationPostalCode` and `destinationCountryCode` must be provided.",
      optional: true,
    },
    destinationPostalCode: {
      type: "string",
      label: "Destination Postal Code",
      description: "The postal code of the destination. Either `accountNumber` or `destinationPostalCode` and `destinationCountryCode` must be provided.",
      optional: true,
    },
    destinationCountryCode: {
      type: "string",
      label: "Destination Country Code",
      description: "The country code of the destination. Either `accountNumber` or `destinationPostalCode` and `destinationCountryCode` must be provided.",
      optional: true,
    },
    shipDateBegin: {
      propDefinition: [
        fedex,
        "shipDateBegin",
      ],
    },
    shipDateEnd: {
      propDefinition: [
        fedex,
        "shipDateEnd",
      ],
    },
    includeDetailedScans: {
      propDefinition: [
        fedex,
        "includeDetailedScans",
      ],
    },
  },
  async run({ $ }) {
    if (!this.accountNumber && (!this.destinationPostalCode || !this.destinationCountryCode)) {
      throw new ConfigurationError("Either `accountNumber` or `destinationPostalCode` and `destinationCountryCode` must be provided.");
    }
    const response = await this.fedex.trackByReference({
      $,
      data: {
        referencesInformation: {
          value: this.value,
          accountNumber: this.accountNumber,
          destinationPostalCode: this.destinationPostalCode,
          destinationCountryCode: this.destinationCountryCode,
          shipDateBegin: this.shipDateBegin,
          shipDateEnd: this.shipDateEnd,
        },
        includeDetailedScans: this.includeDetailedScans,
      },
    });
    $.export("$summary", `Tracking information for ${this.value} retrieved successfully`);
    return response;
  },
};

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
FedEx	`fedex`	`app`	This component uses the FedEx app.
Reference Value	`value`	`string`	The reference value to track
Account Number	`accountNumber`	`string`	The shipper's account number. Either `accountNumber` or `destinationPostalCode` and `destinationCountryCode` must be provided.
Destination Postal Code	`destinationPostalCode`	`string`	The postal code of the destination. Either `accountNumber` or `destinationPostalCode` and `destinationCountryCode` must be provided.
Destination Country Code	`destinationCountryCode`	`string`	The country code of the destination. Either `accountNumber` or `destinationPostalCode` and `destinationCountryCode` must be provided.
Ship Date Begin	`shipDateBegin`	`string`	The beginning of the ship date range to track. Format: YYYY-MM-DD
Ship Date End	`shipDateEnd`	`string`	The end of the ship date range to track. Format: YYYY-MM-DD
Include Detailed Scans	`includeDetailedScans`	`boolean`	Indicates whether to include detailed scan information in the response

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: