Shipment Notification Elements

Element Required Description
RequestedShipment/ SpecialServicesRequested/ SpecialServiceTypes Required Set type as EMAIL_NOTIFICATION.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail Required Descriptive data required for FedEx to provide email notification to the customer regarding the shipment. This element is required when SpecialServiceType. EMAIL_NOTIFICATION is present in the SpecialServiceTypes collection.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/PersonalMessage Optional Identifies the message text to be sent in the email notification.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients Required Up to six (6) email addresses to receive the specified shipment notification.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/ EmailNotificationRecipient Type Optional Identifies the set of valid email notification recipient types. For SHIPPER, RECIPIENT, and BROKER, any email address sent with the email notification for these three email notification recipient types will overwrite the email addresses associated with the SHIPPER, RECIPIENT, and BROKER definitions. Valid values are:
  • BROKER
  • OTHER
  • RECIPIENT
  • SHIPPER
  • THIRD_PARTY
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/ EmailAddress Required The email address of the notification recipient.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/Recipients/NotificationEventsRequested/ EmailNotificationEventType Required Identifies if an email notification should be sent to the recipient:
  • ON_DELIVERY
  • ON_EXCEPTION
  • ON_SHIPMENT
  • ON_TENDER
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/NotificationEventsRequested/ EmailNotificationEventType/ON_DELIVERY Optional Identifies if an email notification should be sent to the recipient when the package is delivered.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/NotificationEventsRequested/ EmailNotificationEventType/ON_EXCEPTION Optional Identifies if an email notification should be sent to the recipient when an exception occurs during package movement from origin to destination.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/NotificationEventsRequested/EmailNotificationEventType/ON_SHIPMENT Optional Identifies if an email notification should be sent to the recipient when the package is shipped.
Note: Shipment Notification emails are not sent for ship transactions in a Test environment, even if the request is configured correctly.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/ON_TENDER Optional Identifies if an email notification should be sent to the recipient when the shipment is tendered to FedEx.
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/Format Required This element is required to specify the type of notification you want to receive. Valid values are:
  • HTML
  • Text
  • Wireless
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/Localization/ Language Code Required You may include a language code to have the email message returned in that language. See "Tracking and Visibility Services" for a table of valid language codes. If no value is included with this element, the default is EN (English).
RequestedShipment/ SpecialServicesRequested/ EmailNotificationDetail/ Recipients/Localization/ LocaleCode Optional Some languages require a locale code to further identify the requested language. For example, if you request the notification emails in Spanish, you must include a locale code of US for North American Spanish. See Notification Service Details for a table of valid locale codes.