RequestEmailNotification Method
Request email notification for a specified trackingNumber to a specified Recipients list.
Syntax
[VB.NET] Public Sub RequestEmailNotification(ByVal trackingNumber As String)
[C#] public void RequestEmailNotification(string trackingNumber);
Remarks
The trackingNumber parameter identifies the shipment the notification will be requested for. Via this method, you send notification of package state to up to four e-mail addresses.
The following properties can be set when this method is called:
- Server (required)
- DeveloperKey (required)
- Password (required)
- AccountNumber (required)
- MeterNumber (required)
- ShipDateStart (required)
- ShipDateEnd (required)
- SenderContact (by specifying FirstName, LastName, and Email - required)
- Notify (required)
- Message (optional)
Notification allows you to request that e-mail exception and delivery notifications be sent to you, your recipient, and up to 2 other e-mail addresses (by specifying the Notify). A personal message can also be included via the Message property.
FedEx services offering this feature are FedEx Express (FDXE), FedEx Ground (FDXG), FedEx Cargo (FDXC), FedEx Custom Critical (FXCC), and FedEx Freight (FXFR). FedEx SmartPost shipments are not included in this feature.
There are three notification options:
- Shipment notification. In this case, the ntOnShipment flag should be set in the NotificationFlags field for that recipient;
- Exception notification (such as if an exception occurs during scanning and the package may be delayed, for example, or if an address correction is required. In this case, the ntOnException flag should be set in the NotificationFlags field for that recipient; or
- Delivery notification. In this case, the ntOnDelivery flag should be set in the NotificationFlags field for that recipient;
You must choose between these delivery types: wireless (to a cell phone), text only e-mail, and HTML e-mail by setting the NotificationFlags to any of the desired options.
A personal message, which can be included in the request via the Message, up to 120 characters) is allowed for e-mail notifications only. This is not applicable for wireless notifications.
If there is a problem with the trackingNumber, or recipients' information, the response will raise an error that pertains to that element. For more details on errors codes and descriptions, please refer to the Error Messages section.