FedEx Module Reference

Applies to

Bridge by Smartsheet

Triggers

There are no triggers available in the FedEx integration, instead some other trigger is needed, such as an event in another system or a workflow schedule.

Modules

Track A Package

Use this module to retrieve the latest shipping status of a FedEx shipment. The module can be used to obtain tracking information for FedEx Express, FedEx Ground, FedEx Home Delivery, FedEx Freight , FedEx Custom Critical, and FedEx SmartPost shipments.

Track a Package

The following field is available in the module.

  • Tracking ID: Enter or reference a tracking number.

The following data is available in the Run Log when the module has run.

  • Data
    • Actual Delivery Address - The City, state, and country to which the package was actually delivered.
      • City - The city the shipment was actually delivered to
      • Country Code - The code of the country the shipment was actually delivered to
      • Country Name - The country the shipment was actually delivered to
      • Residential - True or False to indicate if actual delivery address is residential or not
      • State Or Province Code - The code of the state or province the shipment was actually delivered to
    • Available Images
      • Type - A description of images related to the shipment, such as a photo as proof of delivery
        Example: “SIGNATURE_PROOF_OF_DELIVERY” 
    • Carrier Code - The code of the carrier - The software id of who created the shipment
    • Create Software ID - The software id of who created the shipment
    • Dates Or Times - This is an array of data meaning the data points below are repeated for each object in the array. In this case each object is a time, a date, and time recorded for a shipment event. If you want to run a child workflow for each object in the array use this data reference in the 'Number of Runs' field in the Run Child Workflow module.
      • Date or Timestamp - Timestamp of a shipment event in ISO 8601 format
      • Type - A description of the event e.g. 'SHIP', 'ACTUAL DELIVERY' etc.
        Examples: “ACTUAL_DELIVERY”, “ATTEMPTED_DELIVERY”
    • Delivery Attempts - The number of delivery attempts made
    • Delivery Location Description - A description of the delivery location
      Example: 'Receptionist/Front Desk'
    • Delivery Location Type - The type of delivery location
      Examples: “FEDEX_LOCATION”, “MAILROOM” or “RECEPTIONIST_OR_FRONT_DESK”
    • Delivery option Eligibility Details - This is an array of data meaning the data points below are repeated for each object in the array. In this case each object is a type of eligibility option and the shipment’s eligibility status. If you want to run a child workflow for each object in the array use this data reference in the 'Number of Runs' field in the Run Child Workflow module.
      • Eligibility - The shipment's eligibility status for the specific option.
        Possible Values: “ELIGIBLE”, “INELIGIBLE” or “POSSIBLY_ELIGIBLE”
      • Option - The delivery option description.
        Examples: “REROUTE” or “RESCHEDULE”
    • Delivery Signature Name - The name of the individual who signed for the shipment at delivery
    • Destination Address - The address of the shipments destination as specified when creating the shipment (this may be different from the Actual Delivery Address)
      • City - The city the shipment should be delivered to
      • Country Code - The code of the country the shipment should be delivered to
      • Country Name - The country the shipment should be delivered to
      • Residential - True or False to indicate if actual delivery address is residential or not
      • State Or Province Code - The code of the state or province the shipment should be delivered to
    • Events - Information about the shipments events
      • Address - Address information where the event took place, if applicable
      • City - The city where the event took place
      • Country Code - The country code for the country where the event took place
      • Country Name - The country where the event took place
      • Postal Code - The postal code where the event took place
      • Residential - True of False to indicate if address is residential
      • State Or Province Code - The code of the state or province where the event took place
      • Arrival Location - The type of location for the shipment
        Examples: “SORT_FACILITY”, “CUSTOMER” or “VEHICLE”
      • Event Description - A literal description of the event that took place, matching the Event Type
      • Event Type - A scan code for the event type e.g. 'DL' for Delivered
      • Timestamp - Timestamp of a shipment event in ISO 8601 format
    • Notification - Information about the request/reply to Bridge from FedEx, such as if the transaction was successful or not, and any additional information relevant to the request and/or reply.
      • Code - A code that represents this notification. Combined with the Source it uniquely identifies this notification.
      • Localized Message - The notification message in a localized format
      • Message - The notification message in English
      • Severity - The severity type. To ensure the Bridge workflow runs smoothly it could be useful to use the Match junction after the Track A Package module. If the value is SUCCESS the workflow can go down the left path and e.g. update a system with the latest status. If the value is any other value the workflow can handle the problem e.g. by letting someone know there was a problem as described in the message (see above data label). If a tracking ID is invalid the Severity value returned would be 'ERROR' with a message explaining the problem
        Examples: “FAILURE”, “WARNING” or “SUCCESS”
      • Source - Indicates the FedEx service source of this notification. Combined with the Code it uniquely identifies this notification
        • Locations Service - 'locs'
        • OpenShip Service - 'ship'
        • Pickup Service - 'disp'
        • RateService - 'crs'
        • Ship Service - 'ship'
        • Track Service - 'trck'
        • Validation Availability And Commitment Service - 'vacs'
    • Notification Events Available - The types of email notifications that are available for the package.
      Examples: “ON_DELIVERY”, “ON_EXCEPTION” or “ON_SHIPMENT”
    • Operating Company Or Carrier Description - Identification of a FedEx operating company.
      Examples: “FEDEX_CARGO”, “FEDEX_EXPRESS” or “FEDEX_OFFICE”
    • Package Content Piece Count - The number of pieces in the package.
    • Package Count - Total number of packages
    • Package Dimensions - Physical dimensions of the package.
      • Height - The height of the package
      • Length - The length of the package
      • Units - The unit of measurement used
      • Width - The width of the package
    • Package Sequence Number - Returned for all multiple piece shipment (MPS) requests. Indicates the sequence number of the package within the MPS.
    • Package Weight - Information about the package weight
      • Units - The unit of measurement used
      • Value - The weight of the package.
    • Packaging - Information about the shipments packaging
      • Description - A human friendly description about the packaging type used
      • Type - The type of packaging used
        Examples: “FEDEX_BOX” or “YOUR_PACKAGING”
    • Payments - This is an array of data meaning the data points below are repeated for each object in the array. In this case each object is a payment that has occurred for the shipment. If you want to run a child workflow for each object in the array use this data reference in the 'Number of Runs' field in the Run Child Workflow module.
      • Classification - A description of what the payment was for
        Examples: “DUTIES_AND_TAXES” or “TRANSPORTATION”
      • Description - A description of the payment
      • Type - The type of payment
        Examples: “CASH_OR_CHECK_AT_DESTINATION” or “SHIPPER_ACCOUNT”
    • Service - Information about the service purchased for the shipment
      • Description - A description of the service
      • Short Description - A short description of the service
      • Type - The type of service used
        Examples: “FEDEX_2_DAY” or “SAME_DAY”
    • Shipment Content Piece Count - The number of pieces in the shipment.
    • Shipment Weight - Information about the shipment weight
      • Units - The unit of measurement used
      • Value - The weight of the package.
    • Shipper Address - The address of the shipper
      • City - The city of the shipper
      • Country Code - The code of the country the shipper is in
      • Country Name - The country of the shipper
      • Residential - True or False to indicate if the shipper's address is residential or not
      • State Or Province Code - The code of the state or province of the shipper
    • Special Handlings - This is an array of data meaning the data points below are repeated for each object in the array. In this case each object is any special handling requirements of the shipment. If you want to run a child workflow for each object in the array use this data reference in the 'Number of Runs' field in the Run Child Workflow module.
      • Description - A description of the special handling
      • Payment Type - The payment type for the special handling
      • Type - The special handling type value
        Examples: “COLLECT” or “REROUTE_LOCAL”
    • Status Detail - Information about the latest status
      • Code - The code for the latest status
      • Creation Time - The timestamp for when the latest status occurred
      • Description - A human friendly description of the latest status
      • Location - Information about the location where the latest status took place
      • City - The city where the latest status was set
      • Country Code - The country code of the country where the latest status was set
      • Country Name - The country where the latest status was set
      • Residential - True or False to indicate if latest location is a residential address
      • State Or Province Code - The state or province code where the latest status was set
    • Total Unique Address Count in Consolidation
    • Tracking Number - The FedEx package identifier.
    • Tracking Number Unique Identifier - When duplicate tracking numbers exist, this data is returned with summary information for each of the duplicates. The summary information is used to determine which of the duplicates the intended tracking number is. This identifier is used on a subsequent track request to retrieve the tracking data for the desired tracking number.
  • State - The status of the request to FedEx, note that an invalid tracking ID wouldn't cause the request to fail. (See Notifications previously listed)
    • Code - The request’s code. E.g. ‘0’ if successful
    • Message - A message to describe what happened if not successful
    • Status - A status e.g. SUCCEEDED