Validate Shipment with FedEx API

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

Trigger workflow on

HTTP requests, schedules and app events

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

Chase Roberts
@chsrbrts
@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨
@heyellieday
Evaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley
@MBraedley
Update: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting
@mrthomascutting
Want quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts
@mattdotroberts
day 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭
@auchenberg
Yahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑
@raymondcamden
Awesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero
@nachocaballero
I couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow
@jyksnw
Developed a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana
@steven_terrana
@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD
@DotDotJames
Want to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin
@Atinux
GitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul
@raul_predescu
If you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc
@bitfalls
So @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich
@ZachLanich
Um, wow 🤯 @pipedream
Steven Bell
@bellontech
I just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸
@_jayhack_
Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴‍♂️🌳
@philsturgeon
For context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.

Getting Started#

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

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
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

Integrations#

Validate Shipment with FedEx API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + FedEx

Try it

Validate Shipment with FedEx API on New Submission from Typeform API

Typeform + FedEx

Try it

Validate Shipment with FedEx API on New Submission (Instant) from Jotform API

Jotform + FedEx

Try it

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

Pipedream + FedEx

Try it

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

npm + FedEx

Try it

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.

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

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;
  },
};

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.
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

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: