View as Markdown
FedEx icon

FedEx ACTION

Validate Shipment

Validate a shipment. See the documentation
  • Action
  • Read only
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's FedEx account once, then configure and run Validate Shipment from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "fedex-validate-shipment",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    fedex: { authProvisionId: "apn_xxxxxxx" },
    accountNumber: "Account Number",
    shipperStreetLines: ["Shipper Street Lines"],
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Validate Shipment inputs
Property Type Description
accountNumber Account Number string
The account number associated with the shipment
Required
shipperStreetLines Shipper Street Lines 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]
Required
shipperCity Shipper City string
The name of city, town of the recipient.Max length is 35. Example: Beverly Hills
Required
shipperStateOrProvinceCode Shipper State Or Province Code 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
Optional
shipperPostalCode Shipper Postal Code string
This is the postal code. Note: This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247
Optional
shipperCountryCode Shipper Country Code string
Is a capitalized two-character alpha code representing the country of the address. Example: US
Required
shipperContactName Shipper Contact Name string
Contact name, e.g. for customer support. Maximum length is 35. Example: John Doe
Required
shipperPhoneNumber Shipper Phone Number string
Contact phone number, e.g. for customer support. Maximum length is 10. Example: 15014321111
Required
recipientStreetLines Recipient Street Lines 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]
Required
recipientCity Recipient City string
The name of city, town of the recipient.Max length is 35. Example: Beverly Hills
Required
recipientStateOrProvinceCode Recipient State Or Province Code 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
Optional
recipientPostalCode Recipient Postal Code string
This is the postal code. Note: This is Optional for non postal-aware countries. Maximum length is 10. Example: 65247
Optional
recipientCountryCode Recipient Country Code string
Is a capitalized two-character alpha code representing the country of the address. Example: US
Required
recipientContactName Recipient Contact Name string
Contact name, e.g. for customer support. Maximum length is 35. Example: John Doe
Required
recipientPhoneNumber Recipient Phone Number string
Contact phone number, e.g. for customer support. Maximum length is 10. Example: 15014321111
Required
pickupType Pickup Type string
Indicates if shipment is being dropped off at a FedEx location or being picked up by FedEx or if it's a regularly scheduled pickup for this shipment.
Required
serviceType Service Type string
Indicate the FedEx service type used for this shipment
Required
packagingType Packaging Type string
Specify the packaging type used
Required
totalWeight Total Weight string
Indicate the shipment total weight in pounds
Required
paymentType Payment Type string
Indicates who and how the shipment will be paid for
Required
labelFormatType Label Format Type string
Specifies the label Format Type
Required
labelStockType Label Stock Type string
Label stock type used to create labels
Required
imageType Image Type string
Specifies the image type of this shipping document
Required
weightUnit Weight Unit string
Specifies the package weight unit type
Required
weights Weights string[]
An array of weight values for each of the requested pieces of the shipment
Required

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
fedex-validate-shipment
Version
0.0.3
App
FedEx
Authentication
OAuth
Read-only
Yes
Destructive
No
Open world
Yes