4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

FedExTrack Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DShipping.Fedextrack

Remarks

This component 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 component 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 CountryCode and ZipCode (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 FaxProofOfDelivery, 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. You may also request a FAX format of the SPOD (by calling the FaxProofOfDelivery method) to be sent to a specific FAX number (by specifying Recipients). 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 component, you must have a FedEx AccountNumber. You should also have already obtained a DeveloperKey, Password and a MeterNumber uniquely assigned to your account by FedEx after registration for Web Services.

Property List


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

CarrierCodeDescriptionFedEx carrier code description used for shipment.
EstimatedPickupDateEstimated package pickup date for shipments that haven't been picked up yet.
FedExAccountLogin information for FedEx.
FirewallA set of properties related to firewall access.
IdentifierTypeType of shipment identifier by which the shipment is to be tracked.
NotifyCollection of recipients to get notified.
PackageCountThe number of packages returned for a given tracking number or any other shipment identifier.
PackageDeliveryDateActual date when the package at PackageIndex was delivered at destination (if applicable).
PackageDeliveryEstimateProjected delivery date for the package at PackageIndex based on the ship date, service and destination address.
PackageDeliveryLocationRelative location at which package at PackageIndex was left (if package delivered).
PackageDeliveryStatusDelivery status description of the package at PackageIndex .
PackageIndexThe package index in a shipment being tracked.
PackagePackagingTypeDescription of packaging type of the package at PackageIndex .
PackageReferencesReferences (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.
PackageServiceTypeDescriptionString describing the service type used to ship the package at PackageIndex being tracked.
PackageSignedBySignature of person who signed for package at PackageIndex .
PackageTrackingNumberTracking number for the package at PackageIndex .
PackageWeightWeight of the package at PackageIndex .
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address to which the shipment is destined.
SenderAddressIdentifies the sender's address.
SenderContactIdentifies the sender that requests an email notification or SPOD (via fax).
ShipDateThe date on which the package was tendered to FedEx.
ShipDateEndEnd of ship date range used to narrow search.
ShipDateStartStart of ship date range used to narrow search.
ShipperAccountNumberAccount number associated with shipment.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TimeoutA timeout for the component.
TotalWeightTotal shipment weight.
TrackEventsCollection of tracking details for all scanning events that occur during the shipping process of the package at PackageIndex .

Method List


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

ConfigSets or retrieves a configuration setting .
FaxProofOfDeliveryRequest Signature Proof of Delivery (SPOD) for a specified trackingNumber .
GetProofOfDeliveryRequest Signature Proof of Delivery (SPOD) for a specified trackingNumber .
RequestEmailNotificationRequest email notification for a specified trackingNumber to a specified Recipients list.
ResetResets the internal state of the component and all properties to their default values.
SaveProofOfDeliveryRequest Signature Proof of Delivery (SPOD) for a specified trackingNumber .
TrackShipmentReturns tracking data for requested idValue of IdentifierType type.

Event List


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

ErrorInformation about errors during data delivery.
NotificationNotification returned by the server upon successful request (if applicable).
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


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

RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
XPathUsed to set the XPath within the response from the server.
HasXPathDetermines whether a specific element exists in the document.
XParentThe parent of the current element.
XElementThe name of the current element.
XTextThe text of the current element.
XChildCountThe number of records in the XChild arrays.
XChildElement[i]The name of the indexed child element.
XChildText[i]The text of the indexed child element.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
WarningWarning message returned by the server.
CSPUserKeyCSP end user key.
CSPUserPasswordCSP end user password.
CSPProductIdIdentifies the CSP product.
CSPProductVersionIdentifies the CSP product version.
UseSOAPDetermines if the FedEx SOAP web services are used instead of the FedEx XML web services.
CustomContentDefines any custom content to print on the label.
EstimateDeliveryDetermines if component will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.
SPODLetterImageTypeThe format of the SPOD letter.
WeightUnitWeight unit.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]