NotifyDetail Type

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows:

<EMailNotificationDetail>
  <PersonalMessage>personal_message</PersonalMessage>
  <Recipients> (this aggregate can be entered up to six times)
    <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType>
    <EMailAddress>recipient_email</EMailAddress>
    <NotifyOnShipment>true_or_false</NotifyOnShipment>
    <NotifyOnException>true_or_false</NotifyOnException>
    <NotifyOnDelivery>true_or_false</NotifyOnDelivery>
    <Format>format_type</Format>
    <Localization>
      <LanguageCode>language_code</LanguageCode>
    </Localization>
  </Recipients>
</EMailNotificationDetail>

In this aggregate, you can specify:

• a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
• the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
• the recipient's email address (via the EMailAddress element). This is required.
• whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
• the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
• the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).

This setting is optional. If Aggregate is not set it will be automatically created by the component.

UPS

For UPS, the following format is valid:

<Notification> (this aggregate can be entered up to three times)
  <NotificationCode>notification_code</NotificationCode>
  <EMailMessage>
    <EMailAddress>recipient_email</EMailAddress>  (this aggregate can be entered up to five times)
    <UndeliverableEMailAddress>undeliverable_email</UndeliverableEMailAddress>
    <FromEMailAddress>sender_email</FromEMailAddress>
    <FromName>sender_name</FromName>
    <Memo>message</Memo>
    <Subject>subject</Subject>
    <SubjectCode>subject_code</SubjectCode>
  </EMailMessage>
</Notification>

In this aggregate, you can specify:

• a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
• the recipient's email address (via the EMailAddress element). This is required.
• the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
• the email address for the reply-to address. The From field of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
• an optional from name.
• a message text to be sent in the email notification (via the Memo element). This is optional.
• the email's subject. This is optional
• an optional subject code which specifies one of the following notification codes that will appear in the subject: "01" (Shipment Reference Number 1), "02" (Shipment Reference Number 2), "03" (package Reference Number 1), "04" (package Reference Number 2), and "08" (Subject Text) for Return Notification only.

Note that this field does not apply for USPS and CanadaPost.

Email address of the recipient to be notified. This is required to be provided for each recipient.

Fax number of the recipient that is going to receive the Signature Proof of Delivery via fax. When the FaxProofOfDelivery method is called, the Fax is required. In this case, the Name should be provided as well.

Note this is only used by FedEx.

User defined text that will be included in the email to be sent to Email. This is optional.

For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

This field is not used by USPS or Canada Post.

The name associated with the notification.

For FedEx, this is the name of the recipient that is going to receive the Signature Proof of Delivery via fax. When the FaxProofOfDelivery method is called, the Name is required. In this case, the Fax should be provided as well.

For USPS, this name will appear in the text of the Signature Confirmation e-mail message.

This field is not applicable to UPS or Canada Post.

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the On Return flag does not apply.

For UPS notifications, the formats (HTML, Text, and Wireless) do not apply.

For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.

This field is not used by USPS.

Identifies the set of valid email notification recipient types. Valid values are:

For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the Email specified for these types will be ignored.

For USPS, only the rtShipper and rtRecipient are valid.

This field does not apply to UPS or Canada Post notifications.