FedExTrack Control

Properties   Methods   Events   Config Settings   Errors  

Provides tracking information, SPOD, and notification for a given tracking number or other shipment identifier.

Syntax

FedExTrack

Remarks

This control provides Tracking, Signature Proof of Delivery (SPOD), and Notification services:

• Tracking Service: to obtain real-time tracking information for FedEx Express, FedEx Ground, FedEx Home Delivery, FedEx Express Freight, and FedEx Custom Critical shipments.
• Signature Proof of Delivery (SPOD): to request a proof of delivery letter that includes a graphic image of your recipient's signature after your shipment has been delivered.
• Notification to have FedEx automatically notify you and/or your customer and/or another third party by e-mail, fax, or wireless of significant shipment events, such as clearance delays, delivery attempts, releases, consolidated proofs of delivery, and pre-alerts.

The available options for Tracking service are:

Track by Tracking Number

On Single Piece Shipments, the tracking number represents the package's tracking number. This option applies to Express, Ground, Freight and Custom Critical shipments. You can track any package shipped by FedEx using TrackShipment method by providing this number as the value of idValue parameter. No extra qualifiers (date range, etc.) are required in such case, but are recommended. It is also recommended that you provide the Carrier Code to ensure the desired results for your request. This control handles tracking numbers individually, not in batch.

On Multiple Package Shipments (MPS), the tracking number represents either the master tracking number or one of the associated sequential tracking numbers for child packages. This option is available for: Express and Ground (Domestic and International) multiple-package shipments, Express and Ground (Domestic and International) C.O.D. multiple-package shipments.

Tracking by the master tracking number returns tracking data for all child tracking numbers associated with the master.

Tracking by the child tracking number returns tracking data on the specific shipment associated with that tracking number.

Track by other identifier

This identifier can be a:

• Reference Number This option applies to Express, Ground, Freight, and Custom Critical shipments. You can track packages by a reference number entered during the shipping transaction. Track by Reference Number can use any of the following sources: Shipper/Customer Reference, Invoice Number, Purchase Order (PO), Department, Part Number, Returns Material Authorization (RMA), Transportation Control Number (TCN), Bill of Lading (BOL).
• Door Tag Number This option is available for Express and Ground U.S. and Canadian shipments. This option allows you to track by a FedEx Door Tag number. A Door Tag is left at the recipient's shipping address if the recipient is not there to receive the package. A Door Tag number is linked at FedEx with the package's original tracking number. This tracking functionality allows you to track using only the Door Tag number without requiring the associated tracking number. No additional search elements are required to track by Door Tag. You may request tracking scan information for any packages shipped by FedEx by providing a valid Door Tag Number.

To track by identifiers other than tracking number, the TrackShipment method should be called by providing an idValue and the IdentifierType, as well as other required values described in detail in this method description depending on the identifier type.

When the track request has been made for an identifier of type other than Tracking Number, either the ShipperAccountNumber or the RecipientCountryCode and RecipientZipCode (where applicable) are required to be provided in the request.

Upon successful request, the user will receive the current shipment status with a detailed tracking activity.

To confirm a shipment has been received and signed for, you can call the GetProofOfDelivery or SaveProofOfDelivery methods. With this feature, you can request a letter that includes a graphic of the recipient's signature for FedEx Express and FedEx Ground shipments. The SPOD is returned in PDF format and may be printed, browsed, or e-mailed. There is no charge for Signature Proof of Delivery.

You can use Tracking service to check the status of your shipment at any time during delivery and up to 18 months after delivery. You can use SPOD service to obtain an image of the recipient's signature (if the signature is available) once the shipment has been delivered.

SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.

If the ShipperAccountNumber is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.

If the ShipperAccountNumber is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).

In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.

Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).

SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.

To use this control, you must have a FedEx FedExAccountNumber. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.

Property List

The following is the full list of the properties of the control with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the control with short descriptions. Click on the links for further details.

CarrierCodeDescription Property (FedExTrack Control)

FedEx carrier code description used for shipment.

Syntax

fedextrackcontrol.CarrierCodeDescription

Default Value

""

Remarks

Specifies the particular carrier used to ship the packages being tracked.

Upon successful request, this is always returned when the TrackShipment and RequestEmailNotification methods are called.

This property is read-only.

Data Type

String

EstimatedPickupDate Property (FedExTrack Control)

Estimated package pickup date for shipments that haven't been picked up yet.

Syntax

fedextrackcontrol.EstimatedPickupDate

Default Value

""

Remarks

This property is returned in the server response only if applicable.

Format: YYYY-MM-DD.

This property is read-only.

Data Type

String

FedExAccountNumber Property (FedExTrack Control)

The account number associated with the shipment.

Syntax

fedextrackcontrol.FedExAccountNumber[=string]

Default Value

""

Remarks

The account number associated with the shipment.

The FedExAccountNumber is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

Data Type

String

FedExAuthorizationToken Property (FedExTrack Control)

Authorization Token used to authenticate the request.

Syntax

fedextrackcontrol.FedExAuthorizationToken[=string]

Default Value

""

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

Data Type

String

FedExLanguageCode Property (FedExTrack Control)

Two-letter code for the language (e.

Syntax

fedextrackcontrol.FedExLanguageCode[=string]

Default Value

"en"

Remarks

Two-letter code for the language (e.g. en, fr, etc.).

This field allows you to assign the language code. Default value is en.

Data Type

String

FedExLocaleCode Property (FedExTrack Control)

Two-letter code for the region (e.

Syntax

fedextrackcontrol.FedExLocaleCode[=string]

Default Value

"US"

Remarks

Two-letter code for the region (e.g. US, CA, etc.).

Some languages require a locale code to further identify the language. Default value is US.

Data Type

String

FedExServer Property (FedExTrack Control)

URL for the FedEx Server where the requests are sent.

Syntax

fedextrackcontrol.FedExServer[=string]

Default Value

""

Remarks

URL for the FedEx Server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

Data Type

String

FirewallAutoDetect Property (FedExTrack Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

fedextrackcontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (FedExTrack Control)

This property determines the type of firewall to connect through.

Syntax

fedextrackcontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (FedExTrack Control)

This property contains the name or IP address of firewall (optional).

Syntax

fedextrackcontrol.FirewallHost[=string]

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (FedExTrack Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

fedextrackcontrol.FirewallPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (FedExTrack Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

fedextrackcontrol.FirewallPort[=integer]

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (FedExTrack Control)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

fedextrackcontrol.FirewallUser[=string]

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

IdentifierType Property (FedExTrack Control)

Type of shipment identifier by which the shipment is to be tracked.

Syntax

fedextrackcontrol.IdentifierType[=integer]

Possible Values

fitTrackingNumberOrDoorTag(0), 
fitBillOfLading(1), 
fitCODReturnTrackingNumber(2), 
fitCustomerAuthorizationNumber(3), 
fitCustomerReference(4), 
fitDepartment(5), 
fitFreeFormReference(6), 
fitGroundShipmentId(7), 
fitGroundMPS(8), 
fitInvoiceNumber(9), 
fitPartnerCarrierNumber(10), 
fitPartNumber(11), 
fitPONumber(12), 
fitRMANumber(13), 
fitTrackingControlNumber(14), 
fitShipperReference(15), 
fitStandardMPS(16)

Default Value

0

Remarks

This is required if the track request will be made for an identifier other than Tracking Number.

Possible values are as follows:

To limit the number of tracking replies for a specific reference, you can enter a date range (ShipDateStart and ShipDateEnd) for this search.

When the track request has been made for an identifier of type other than Tracking Number, either the ShipperAccountNumber or the RecipientCountryCode and RecipientZipCode (where applicable) are required to be provided in the request.

Data Type

Integer

NotifyCount Property (FedExTrack Control)

The number of records in the Notify arrays.

Syntax

fedextrackcontrol.NotifyCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• NotifyAggregate
• NotifyEmail
• NotifyFlags
• NotifyMessage
• NotifyName
• NotifyType

The array indices start at 0 and end at NotifyCount - 1.

This property is not available at design time.

Data Type

Integer

NotifyAggregate Property (FedExTrack Control)

This can be used to set the entire aggregate xml for the recipient to be notified.

Syntax

fedextrackcontrol.NotifyAggregate(NotifyIdx)[=string]

Default Value

""

Remarks

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 NotifyAggregate is not set it will be automatically created by the control.

UPS

For UPS, the following JSON format is valid: { "NotificationCode": "6", "EMail": { "EMailAddress": [ "recipient1_email", (up to five recipient emails) "recipient2_email" ], "UndeliverableEMailAddress": "undeliverable_email", "FromEMailAddress": "sender_email", "FromName": "sender_name", "Memo": "message" } }

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.

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

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyEmail Property (FedExTrack Control)

Email address of the recipient to be notified.

Syntax

fedextrackcontrol.NotifyEmail(NotifyIdx)[=string]

Default Value

""

Remarks

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

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyMessage Property (FedExTrack Control)

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

Syntax

fedextrackcontrol.NotifyMessage(NotifyIdx)[=string]

Default Value

""

Remarks

User defined text that will be included in the email to be sent to NotifyEmail. 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 property is not used by USPS or Canada Post.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyName Property (FedExTrack Control)

The name associated with the notification.

Syntax

fedextrackcontrol.NotifyName(NotifyIdx)[=string]

Default Value

""

Remarks

The name associated with the notification.

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

This property is not applicable to FedEx, UPS, or Canada Post.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyFlags Property (FedExTrack Control)

Identifies the type of notification requested.

Syntax

fedextrackcontrol.NotifyFlags(NotifyIdx)[=integer]

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Tender
• On Estimated Delivery
• HTML
• Text

For UPS notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Return
• In Transit
• ADL
• UAP

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

This field is not used by USPS.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

Integer

NotifyType Property (FedExTrack Control)

Identifies the set of valid email notification recipient types.

Syntax

fedextrackcontrol.NotifyType(NotifyIdx)[=integer]

Possible Values

rtUnspecified(0), 
rtRecipient(1), 
rtShipper(2), 
rtBroker(3), 
rtOther(4), 
rtThirdParty(5)

Default Value

0

Remarks

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 NotifyEmail specified for these types will be ignored.

For USPS, only the rtShipper and rtRecipient are valid.

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

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

Integer

PackageCount Property (FedExTrack Control)

The number of packages returned for a given tracking number or any other shipment identifier.

Syntax

fedextrackcontrol.PackageCount

Default Value

1

Remarks

This property contains the number of packages returned from the FedEx Server after calling the TrackShipment.

This property is read-only.

Data Type

Integer

PackageDeliveryAncAction Property (FedExTrack Control)

Delivery ancillary action recommended for customer to resolve the delivery issue for the package at PackageIndex .

Syntax

fedextrackcontrol.PackageDeliveryAncAction

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called.

This property is read-only.

Data Type

String

PackageDeliveryAncActionDesc Property (FedExTrack Control)

Delivery ancillary action description. Field which holds recommended action description to resolve delivery issue for the package at PackageIndex .

Syntax

fedextrackcontrol.PackageDeliveryAncActionDesc

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called.

Example: "Customer not Available or Business Closed"

This property is read-only.

Data Type

String

PackageDeliveryAncReasonDesc Property (FedExTrack Control)

Delivery ancillary reason description. Field which holds reason description associated to the status of the package at PackageIndex .

Syntax

fedextrackcontrol.PackageDeliveryAncReasonDesc

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called.

Example: "Customer not Available or Business Closed"

This property is read-only.

Data Type

String

PackageDeliveryDate Property (FedExTrack Control)

Actual date when the package at PackageIndex was delivered at destination (if applicable).

Syntax

fedextrackcontrol.PackageDeliveryDate

Default Value

""

Remarks

When the TrackShipment method is called, PackageDeliveryDate is returned in the response only if the package has been delivered.

Format: YYYY-MM-DD.

This property is read-only.

Data Type

String

PackageDeliveryEstimate Property (FedExTrack Control)

Projected delivery date for the package at PackageIndex based on the ship date, service and destination address.

Syntax

fedextrackcontrol.PackageDeliveryEstimate

Default Value

""

Remarks

When the TrackShipment method is called, the PackageDeliveryEstimate is populated only if delivery has not already occurred.

Format: YYYY-MM-DD.

This property is read-only.

Data Type

String

PackageDeliveryLocation Property (FedExTrack Control)

Relative location at which package at PackageIndex was left (if package delivered).

Syntax

fedextrackcontrol.PackageDeliveryLocation

Default Value

""

Remarks

When the TrackShipment method is called, PackageDeliveryLocation is returned in the response only if this package has been delivered.

This might be such as Front Desk, Back Door, etc. It is applicable for Express services only.

This property is read-only.

Data Type

String

PackageDeliveryStatus Property (FedExTrack Control)

Delivery status description of the package at PackageIndex .

Syntax

fedextrackcontrol.PackageDeliveryStatus

Default Value

""

Remarks

This is applicable for Express services only. Maximum length: 25.

This property is read-only.

Data Type

String

PackageErrorMessage Property (FedExTrack Control)

The error message corresponding to the PackageIndex .

Syntax

fedextrackcontrol.PackageErrorMessage

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called.

This property is read-only.

Data Type

String

PackageIndex Property (FedExTrack Control)

The package index in a shipment being tracked.

Syntax

fedextrackcontrol.PackageIndex[=integer]

Default Value

0

Remarks

This property contains the index of a package contained in the shipment.

The PackageCount will contain the number of packages included in a shipment and the PackageIndex will contain the package index in the list of packages.

To retrieve all attributes corresponding to a package, the PackageIndex should be set from 0 to PackageCount - 1.

Data Type

Integer

PackagePackagingType Property (FedExTrack Control)

Description of packaging type of the package at PackageIndex .

Syntax

fedextrackcontrol.PackagePackagingType

Default Value

""

Remarks

This is returned for Express services only. Possible values are: 'FedEx Envelope', 'FedEx Box', etc.

This property is read-only.

Data Type

String

PackageReceivedBy Property (FedExTrack Control)

The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex .

Syntax

fedextrackcontrol.PackageReceivedBy

Default Value

""

Remarks

This corresponds to the package at PackageIndex and is returned only if this package has already been delivered. To retrieve this property, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Data Type

String

PackageReferences Property (FedExTrack Control)

References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.

Syntax

fedextrackcontrol.PackageReferences

Default Value

""

Remarks

This should be inspected after a call to the TrackShipment method. When populated, it is a string in this format: "Reference Type: Reference Value" pairs (separated by ';' if more than one reference is found).

Reference Type can be any of the following values:

This property is read-only.

Data Type

String

PackageServiceTypeDescription Property (FedExTrack Control)

String describing the service type used to ship the package at PackageIndex being tracked.

Syntax

fedextrackcontrol.PackageServiceTypeDescription

Default Value

""

Remarks

This might be one of FedEx available services, such as 'Priority Pack', 'Standard Overnight', etc.

This property is read-only.

Data Type

String

PackageSignedBy Property (FedExTrack Control)

Signature of person who signed for package at PackageIndex .

Syntax

fedextrackcontrol.PackageSignedBy

Default Value

""

Remarks

This corresponds to the package at PackageIndex and is returned only if this package has already been delivered. If the signature confirmation is not selected when the shipping label was generated, the PackageSignedBy might also be a relative location at which package was left, such as Front Desk or Back Door.

This property is read-only.

Data Type

String

PackageTrackingNumber Property (FedExTrack Control)

Tracking number for the package at PackageIndex .

Syntax

fedextrackcontrol.PackageTrackingNumber

Default Value

""

Remarks

This indicates tracking number assigned by FedEx when the shipping label was generated. Maximum length: 20.

Note: Door Tag will never be returned in the response.

This property is read-only.

Data Type

String

PackageWeight Property (FedExTrack Control)

Weight of the package at PackageIndex .

Syntax

fedextrackcontrol.PackageWeight

Default Value

""

Remarks

This corresponds to the package at PackageIndex position in the list of packages contained in the shipment.

This property is read-only.

Data Type

String

ProxyAuthScheme Property (FedExTrack Control)

This property is used to tell the control which type of authorization to perform when connecting to the proxy.

Syntax

fedextrackcontrol.ProxyAuthScheme[=integer]

Possible Values

authBasic(0), 
authDigest(1), 
authProprietary(2), 
authNone(3), 
authNtlm(4), 
authNegotiate(5)

Default Value

0

Remarks

This property is used to tell the control which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the control. Look at the configuration file for the control being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (FedExTrack Control)

This property tells the control whether or not to automatically detect and use proxy system settings, if available.

Syntax

fedextrackcontrol.ProxyAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use proxy system settings, if available. The default value is .

Data Type

Boolean

ProxyPassword Property (FedExTrack Control)

This property contains a password if authentication is to be used for the proxy.

Syntax

fedextrackcontrol.ProxyPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (FedExTrack Control)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

fedextrackcontrol.ProxyPort[=integer]

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (FedExTrack Control)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

fedextrackcontrol.ProxyServer[=string]

Default Value

""

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (FedExTrack Control)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

fedextrackcontrol.ProxySSL[=integer]

Possible Values

psAutomatic(0), 
psAlways(1), 
psNever(2), 
psTunnel(3)

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (FedExTrack Control)

This property contains a username if authentication is to be used for the proxy.

Syntax

fedextrackcontrol.ProxyUser[=string]

Default Value

""

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (FedExTrack Control)

Street name.

Syntax

fedextrackcontrol.RecipientAddress1[=string]

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (FedExTrack Control)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

fedextrackcontrol.RecipientAddress2[=string]

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS RecipientAddress2 should not exceed 35 characters.

Data Type

String

RecipientAddressFlags Property (FedExTrack Control)

Various flags that denote information about the address.

Syntax

fedextrackcontrol.RecipientAddressFlags[=integer]

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (FedExTrack Control)

Name of city, town, etc.

Syntax

fedextrackcontrol.RecipientCity[=string]

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

RecipientCountryCode Property (FedExTrack Control)

Country code.

Syntax

fedextrackcontrol.RecipientCountryCode[=string]

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

RecipientState Property (FedExTrack Control)

State or province code.

Syntax

fedextrackcontrol.RecipientState[=string]

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

RecipientZipCode Property (FedExTrack Control)

Postal code.

Syntax

fedextrackcontrol.RecipientZipCode[=string]

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

SenderAddress1 Property (FedExTrack Control)

Street name.

Syntax

fedextrackcontrol.SenderAddress1

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS SenderAddress1 should not exceed 35 characters.

This property is read-only.

Data Type

String

SenderAddress2 Property (FedExTrack Control)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Syntax

fedextrackcontrol.SenderAddress2

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS SenderAddress2 should not exceed 35 characters.

This property is read-only.

Data Type

String

SenderAddressFlags Property (FedExTrack Control)

Various flags that denote information about the address.

Syntax

fedextrackcontrol.SenderAddressFlags

Default Value

0

Remarks

Various flags that denote information about the address.

This property is read-only.

Data Type

Integer

SenderCity Property (FedExTrack Control)

Name of city, town, etc.

Syntax

fedextrackcontrol.SenderCity

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

This property is read-only.

Data Type

String

SenderCountryCode Property (FedExTrack Control)

Country code.

Syntax

fedextrackcontrol.SenderCountryCode

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

This property is read-only.

Data Type

String

SenderState Property (FedExTrack Control)

State or province code.

Syntax

fedextrackcontrol.SenderState

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

This property is read-only.

Data Type

String

SenderZipCode Property (FedExTrack Control)

Postal code.

Syntax

fedextrackcontrol.SenderZipCode

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both SenderCity and SenderState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

This property is read-only.

Data Type

String

SenderCompany Property (FedExTrack Control)

Identifies the contact person's company name.

Syntax

fedextrackcontrol.SenderCompany[=string]

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either SenderFirstName and SenderLastName or SenderCompany are required to be provided.

Data Type

String

SenderEmail Property (FedExTrack Control)

Identifies the contact person's email address.

Syntax

fedextrackcontrol.SenderEmail[=string]

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

SenderFax Property (FedExTrack Control)

Recipient's fax number.

Syntax

fedextrackcontrol.SenderFax[=string]

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

SenderFirstName Property (FedExTrack Control)

Sender's first name.

Syntax

fedextrackcontrol.SenderFirstName[=string]

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent.

Data Type

String

SenderLastName Property (FedExTrack Control)

Person's last name.

Syntax

fedextrackcontrol.SenderLastName[=string]

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

SenderMiddleInitial Property (FedExTrack Control)

Middle initial.

Syntax

fedextrackcontrol.SenderMiddleInitial[=string]

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (FedExTrack Control)

Identifies the contact person's phone number.

Syntax

fedextrackcontrol.SenderPhone[=string]

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

ShipDate Property (FedExTrack Control)

The date on which the package was tendered to FedEx.

Syntax

fedextrackcontrol.ShipDate[=string]

Default Value

""

Remarks

Upon successful request, this is always returned when the TrackShipment and RequestEmailNotification methods are called.

Format: YYYY-MM-DD.

Data Type

String

ShipDateEnd Property (FedExTrack Control)

End of ship date range used to narrow search.

Syntax

fedextrackcontrol.ShipDateEnd[=string]

Default Value

""

Remarks

This property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateStart is required.

This is required though to be provided in an email notification request (when the RequestEmailNotification method is called).

Format: YYYY-MM-DD.

Data Type

String

ShipDateStart Property (FedExTrack Control)

Start of ship date range used to narrow search.

Syntax

fedextrackcontrol.ShipDateStart[=string]

Default Value

""

Remarks

This property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateEnd is required.

This is required though to be provided in a email notification request (when the RequestEmailNotification method is called).

Format: YYYY-MM-DD.

Data Type

String

ShipperAccountNumber Property (FedExTrack Control)

Account number associated with shipment.

Syntax

fedextrackcontrol.ShipperAccountNumber[=string]

Default Value

""

Remarks

This indicates the account number associated with shipment (as opposed to the FedExAccountNumber, which is that of the party sending the request).

This property is optional and applicable in 2 types of track services:

• Tracking request made for an identifier of IdentifierType other than Tracking Number; or
• Signature Proof of Delivery (SPOD) request;

In tracking request: When providing the ShipperAccountNumber, the server will return all packages matching the search criteria and associated with this account. If account is not specified, then the RecipientCountryCode and RecipientZipCode (applicable countries) are required. The Reply data may be restricted if ShipperAccountNumber is not provided.

In the SPOD request transaction: To view detailed SPOD information, include the 9-digit ShipperAccountNumber when the GetProofOfDelivery or SaveProofOfDelivery methods are called. If this is not provided, or if it does not match the shipper's or payor's FedEx account number, then summary SPOD information will be provided. Otherwise, the detailed SPOD (sender's and recipient's address details) will be included in the SPOD.

Data Type

String

SSLAcceptServerCertEncoded Property (FedExTrack Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fedextrackcontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FedExTrack Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fedextrackcontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FedExTrack Control)

This is the name of the certificate store for the client certificate.

Syntax

fedextrackcontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (FedExTrack Control)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

fedextrackcontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (FedExTrack Control)

This is the type of certificate store for this certificate.

Syntax

fedextrackcontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The control supports both public and private keys in a variety of formats. When the cstAuto value is used, the control will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (FedExTrack Control)

This is the subject of the certificate used for client authentication.

Syntax

fedextrackcontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (FedExTrack Control)

This specifies the SSL/TLS implementation to use.

Syntax

fedextrackcontrol.SSLProvider[=integer]

Possible Values

sslpAutomatic(0), 
sslpPlatform(1), 
sslpInternal(2)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the control will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The control will select a provider depending on the current platform.

When Automatic is selected the platform implementation is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

Data Type

Integer

SSLServerCertEncoded Property (FedExTrack Control)

This is the certificate (PEM/Base64 encoded).

Syntax

fedextrackcontrol.SSLServerCertEncoded

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLServerCertEncodedB.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (FedExTrack Control)

A timeout for the control.

Syntax

fedextrackcontrol.Timeout[=integer]

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the control will wait for the operation to complete before returning control.

The control will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the control fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalWeight Property (FedExTrack Control)

Total shipment weight.

Syntax

fedextrackcontrol.TotalWeight

Default Value

""

Remarks

This property is returned when the TrackShipment method is called.

This property is read-only.

Data Type

String

TrackEventCount Property (FedExTrack Control)

The number of records in the TrackEvent arrays.

Syntax

fedextrackcontrol.TrackEventCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrackEventAddress1
• TrackEventAddress2
• TrackEventCity
• TrackEventCountryCode
• TrackEventDate
• TrackEventException
• TrackEventState
• TrackEventStatus
• TrackEventTime
• TrackEventZipCode

The array indices start at 0 and end at TrackEventCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

TrackEventAddress1 Property (FedExTrack Control)

Line 1 in the location address where a tracking event occurred (by package).

Syntax

fedextrackcontrol.TrackEventAddress1(TrackEventIdx)

Default Value

""

Remarks

Line 1 in the location address where a tracking event occurred (by package). This contains street prefix, street name, street type.

This is not available for USPS tracking requests.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventAddress2 Property (FedExTrack Control)

Line 2 in the location address where a tracking event occurred (by package).

Syntax

fedextrackcontrol.TrackEventAddress2(TrackEventIdx)

Default Value

""

Remarks

Line 2 in the location address where a tracking event occurred (by package). This contains building, floor, room, suite and PO Box Number.

This is not available for USPS tracking requests.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventCity Property (FedExTrack Control)

Name of the city where the tracking event occurred.

Syntax

fedextrackcontrol.TrackEventCity(TrackEventIdx)

Default Value

""

Remarks

Name of the city where the tracking event occurred. This is returned in the server reply for each tracking event.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventCountryCode Property (FedExTrack Control)

Country code where the tracking event happened.

Syntax

fedextrackcontrol.TrackEventCountryCode(TrackEventIdx)

Default Value

""

Remarks

Country code where the tracking event happened.

For FedEx, this is returned if the country, where the scanning activity happened, is US or CA (for Canada).

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventDate Property (FedExTrack Control)

Date the tracking event happened.

Syntax

fedextrackcontrol.TrackEventDate(TrackEventIdx)

Default Value

""

Remarks

Date the tracking event happened.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventException Property (FedExTrack Control)

The most recent status exception for the tracking event.

Syntax

fedextrackcontrol.TrackEventException(TrackEventIdx)

Default Value

""

Remarks

The most recent status exception for the tracking event. This is only available for FedEx, and is applicable for Express services only.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventState Property (FedExTrack Control)

State or province code where the tracking event occurred.

Syntax

fedextrackcontrol.TrackEventState(TrackEventIdx)

Default Value

""

Remarks

State or province code where the tracking event occurred. This is a two-letter standard abbreviation.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventStatus Property (FedExTrack Control)

Literal description of the tracking event.

Syntax

fedextrackcontrol.TrackEventStatus(TrackEventIdx)

Default Value

""

Remarks

Literal description of the tracking event.

For UPS, possible values are:

For USPS, if RequestType is set to rtSummary, this will contain a description of the current status of the package being tracked. In this case, TrackEventStatus will contain the entire summary and none of the other properties will be populated. For example, this property might contain: "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."

If there is a problem with a specific TrackingNumber within the request, the response will raise an error which will be returned in the TrackEventStatus property that pertains to the specific TrackingNumber.

When RequestType is set to rtDetail however, this property will contain a description of the event type for the current tracking event. For example, "ENROUTE", "DELIVERED", "ACCEPTANCE", etc. The rest of the fields will be populated with more details of the event.

When using Endicia as your postage provider, Status will be the only field populated and may contain the status, the timestamp, and the location of the tracking event.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventTime Property (FedExTrack Control)

Time the tracking event occurred.

Syntax

fedextrackcontrol.TrackEventTime(TrackEventIdx)

Default Value

""

Remarks

Time the tracking event occurred.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventZipCode Property (FedExTrack Control)

Postal code where the tracking event happened.

Syntax

fedextrackcontrol.TrackEventZipCode(TrackEventIdx)

Default Value

""

Remarks

Postal code where the tracking event happened. Returned if the country, where the scanning activity happened, supports postal-code system.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

Config Method (FedExTrack Control)

Sets or retrieves a configuration setting.

Syntax

fedextrackcontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetProofOfDelivery Method (FedExTrack Control)

Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .

Syntax

fedextrackcontrol.GetProofOfDelivery trackingNumber

Remarks

The trackingNumber parameter identifies the shipment the SPOD will be requested for. Via this method, you can receive the SPOD (when applicable) in .pdf format.

The following properties can be set when this method is called:

• FedExAuthorizationToken (required)
• FedExServer (optional)
• FedExAccountNumber (required)
• ShipDate (required)
• ShipperAccountNumber (optional)

This method will return the image of the SPOD. This is the decoded binary image file of the Signature Proof of Delivery (SPOD), stored in memory.

SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.

If the ShipperAccountNumber is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.

If the ShipperAccountNumber is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).

In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.

Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).

SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.

RequestEmailNotification Method (FedExTrack Control)

Request email notification for a specified trackingNumber to a specified Recipients list.

Syntax

fedextrackcontrol.RequestEmailNotification 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:

• FedExAuthorizationToken (required)
• FedExServer (optional)
• FedExAccountNumber (required)
• ShipDateStart (required)
• ShipDateEnd (required)
• SenderContact (by specifying SenderFirstName, SenderLastName, and SenderEmail - 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 NotifyFlags property 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 NotifyFlags property for that recipient; or
• Delivery notification. In this case, the ntOnDelivery flag should be set in the NotifyFlags property 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 NotifyFlags 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 Codes section.

Reset Method (FedExTrack Control)

Resets the internal state of the control and all properties to their default values.

Syntax

fedextrackcontrol.Reset 

Remarks

The Reset method does not have any parameters and does not return any value.

SaveProofOfDelivery Method (FedExTrack Control)

Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .

Syntax

fedextrackcontrol.SaveProofOfDelivery trackingNumber, filename

Remarks

The trackingNumber parameter identifies the shipment the SPOD will be requested for. Via this method, you can receive the SPOD (when applicable) in .pdf format.

The following properties can be set when this method is called:

• FedExAuthorizationToken (required)
• FedExServer (optional)
• FedExAccountNumber (required)
• ShipDate (required)
• ShipperAccountNumber (optional)

The filename parameter describes the location on disk to write the returned image of the SPOD to. This filename should have the .pdf extension.

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting. The default value of this config is True.

SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.

If the ShipperAccountNumber is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.

If the ShipperAccountNumber is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).

In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.

Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).

SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.

TrackShipment Method (FedExTrack Control)

Returns tracking data for requested idValue of IdentifierType type.

Syntax

fedextrackcontrol.TrackShipment idValue

Remarks

The idValue parameter identifies the shipment. This identifier can be of IdentifierType type. Some identifiers apply to a single package (such as Package Tracking Number), while others apply to multiple packages or shipments of which they are part of. The idValue must be alphanumeric.

FedEx uses shipment identification numbers and types to identify and trace every shipment as it goes through the FedEx system to its destination. You can use this shipment identification number and type to track, locate, and verify arrival of a shipment.

When sending a tracking request to the FedEx Server, there is information that the server requires before it will process the request. The following properties can be sent in the request in order to track by tracking number or by any other identifier:

• FedExAuthorizationToken (required)
• FedExServer (optional)
• FedExAccountNumber (required)
• ShipDateStart (optional)
• ShipDateEnd (optional)
• ShipperAccountNumber (optional)
• RecipientCountryCode (optional)
• RecipientZipCode (optional)

A successful query returns all of the packages within a shipment. For example, if a shipment contained four packages, the query response would show all four packages.

If FedEx system doesn't locate any data for the requested identifier, the transaction will be considered successful and the Warning will contain the 'No data...' message. The full server reply will be saved to RawResponse.

The following properties may be populated upon method return:

• CarrierCodeDescription
• ShipDate
• PackageTrackingNumber
• PackageServiceTypeDescription
• PackagePackagingType
• PackageDeliveryStatus
• PackageDeliveryEstimate
• PackageDeliveryDate
• PackageDeliveryLocation
• PackageErrorMessage
• PackageSignedBy
• SenderAddress
• RecipientAddress
• TotalWeight and WeightUnit;
• Tracking details for each tracking event, which can be inspected via TrackEvents collection. This information consists of: TrackEventAddress1, TrackEventAddress2, TrackEventCity, TrackEventState, TrackEventCountryCode, TrackEventZipCode, TrackEventDate, TrackEventTime, TrackEventStatus and TrackEventException.

If there is a problem with a specific identifier within the request, the response will raise an error that pertains to the specific idValue of a IdentifierType type.

For more details on errors codes and descriptions, please refer to the Error Codes section.

Error Event (FedExTrack Control)

Information about errors during data delivery.

Syntax

Sub fedextrackcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (FedExTrack Control)

Notification returned by the server upon successful request (if applicable).

Syntax

Sub fedextrackcontrol_Notification(Message As String)

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (FedExTrack Control)

Fired after the server presents its certificate to the client.

Syntax

Sub fedextrackcontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FedExTrack Control)

Fired when secure connection progress messages are available.

Syntax

Sub fedextrackcontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (FedExTrack Control)

FedExTrack Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (FedExTrack Control)

FedExTrack Errors

The control may also return one of the following error codes, which are inherited from other controls.