Provides tracking information, SPOD, and notification for a given tracking number or other shipment identifier.
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.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|CarrierCodeDescription||FedEx carrier code description used for shipment.|
|EstimatedPickupDate||Estimated package pickup date for shipments that haven't been picked up yet.|
|FedExAccount||Login information for FedEx.|
|Firewall||A set of properties related to firewall access.|
|IdentifierType||Type of shipment identifier by which the shipment is to be tracked.|
|Notify||Collection of recipients to get notified.|
|PackageCount||The number of packages returned for a given tracking number or any other shipment identifier.|
|PackageDeliveryDate||Actual date when the package at PackageIndex was delivered at destination (if applicable).|
|PackageDeliveryEstimate||Projected delivery date for the package at PackageIndex based on the ship date, service and destination address.|
|PackageDeliveryLocation||Relative location at which package at PackageIndex was left (if package delivered).|
|PackageDeliveryStatus||Delivery status description of the package at PackageIndex .|
|PackageIndex||The package index in a shipment being tracked.|
|PackagePackagingType||Description of packaging type of the package at PackageIndex .|
|PackageReferences||References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.|
|PackageServiceTypeDescription||String describing the service type used to ship the package at PackageIndex being tracked.|
|PackageSignedBy||Signature of person who signed for package at PackageIndex .|
|PackageTrackingNumber||Tracking number for the package at PackageIndex .|
|PackageWeight||Weight of the package at PackageIndex .|
|Proxy||A set of properties related to proxy access.|
|RecipientAddress||Identifies the recipient's address to which the shipment is destined.|
|SenderAddress||Identifies the sender's address.|
|SenderContact||Identifies the sender that requests an email notification or SPOD (via fax).|
|ShipDate||The date on which the package was tendered to FedEx.|
|ShipDateEnd||End of ship date range used to narrow search.|
|ShipDateStart||Start of ship date range used to narrow search.|
|ShipperAccountNumber||Account number associated with shipment.|
|SSLAcceptServerCert||Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.|
|SSLCert||The certificate to be used during SSL negotiation.|
|SSLServerCert||The server certificate for the last established connection.|
|Timeout||A timeout for the component.|
|TotalWeight||Total shipment weight.|
|TrackEvents||Collection of tracking details for all scanning events that occur during the shipping process of the package at PackageIndex .|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|Config||Sets or retrieves a configuration setting.|
|FaxProofOfDelivery||Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .|
|GetProofOfDelivery||Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .|
|RequestEmailNotification||Request email notification for a specified trackingNumber to a specified Recipients list.|
|Reset||Resets the internal state of the component and all properties to their default values.|
|SaveProofOfDelivery||Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .|
|TrackShipment||Returns tracking data for requested idValue of IdentifierType type.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|Error||Information about errors during data delivery.|
|Notification||Notification returned by the server upon successful request (if applicable).|
|SSLServerAuthentication||Fired after the server presents its certificate to the client.|
|SSLStatus||Shows the progress of the secure connection.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|CSPProductId||Identifies the CSP product.|
|CSPProductVersion||Identifies the CSP product version.|
|CSPUserKey||CSP end user key.|
|CSPUserPassword||CSP end user password.|
|CustomContent||Defines any custom content to print on the label.|
|CustomerTransactionId||Customer transaction id.|
|EstimateDelivery||Determines if component will attempt to estimate the Transit Time, Delivery Date, and Delivery Day.|
|HasXPath||Determines whether a specific element exists in the document.|
|RawRequest||Contains the complete request sent to the Server.|
|RawResponse||Contains the complete response returned by the Server.|
|SPODLetterImageType||The format of the SPOD letter.|
|UseSOAP||Determines if the FedEx SOAP web services are used instead of the FedEx XML web services.|
|Warning||Warning message returned by the server.|
|XAttrCount||The number of records in the XAttr arrays.|
|XAttrName[i]||The name of the indexed attribute.|
|XAttrValue[i]||The value of the indexed attribute.|
|XChildCount||The 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.|
|XElement||The name of the current element.|
|XParent||The parent of the current element.|
|XPath||Used to set the XPath within the response from the server.|
|XText||The text of the current element.|
|AcceptEncoding||Used to tell the server which types of content encodings the client supports.|
|AllowHTTPCompression||This property enables HTTP compression for receiving data.|
|AllowHTTPFallback||Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.|
|AllowNTLMFallback||Whether to allow fallback from Negotiate to NTLM when authenticating.|
|Append||Whether to append data to LocalFile.|
|Authorization||The Authorization string to be sent to the server.|
|BytesTransferred||Contains the number of bytes transferred in the response data.|
|ChunkSize||Specifies the chunk size in bytes when using chunked encoding.|
|CompressHTTPRequest||Set to true to compress the body of a PUT or POST request.|
|EncodeURL||If set to true the URL will be encoded by the component.|
|FollowRedirects||Determines what happens when the server issues a redirect.|
|GetOn302Redirect||If set to true the component will perform a GET on the new location.|
|HTTP2HeadersWithoutIndexing||HTTP2 headers that should not update the dynamic header table with incremental indexing.|
|HTTPVersion||The version of HTTP used by the component.|
|IfModifiedSince||A date determining the maximum age of the desired document.|
|KeepAlive||Determines whether the HTTP connection is closed after completion of the request.|
|KerberosSPN||The Service Principal Name for the Kerberos Domain Controller.|
|LogLevel||The level of detail that is logged.|
|MaxHeaders||Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.|
|MaxHTTPCookies||Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.|
|MaxRedirectAttempts||Limits the number of redirects that are followed in a request.|
|NegotiatedHTTPVersion||The negotiated HTTP version.|
|OtherHeaders||Other headers as determined by the user (optional).|
|ProxyAuthorization||The authorization string to be sent to the proxy server.|
|ProxyAuthScheme||The authorization scheme to be used for the proxy.|
|ProxyPassword||A password if authentication is to be used for the proxy.|
|ProxyPort||Port for the proxy server (default 80).|
|ProxyServer||Name or IP address of a proxy server (optional).|
|ProxyUser||A user name if authentication is to be used for the proxy.|
|SentHeaders||The full set of headers as sent by the client.|
|StatusLine||The first line of the last response from the server.|
|TransferredData||The contents of the last response from the server.|
|TransferredDataLimit||The maximum number of incoming bytes to be stored by the component.|
|TransferredHeaders||The full set of headers as received from the server.|
|TransferredRequest||The full request as sent by the client.|
|UseChunkedEncoding||Enables or Disables HTTP chunked encoding for transfers.|
|UseIDNs||Whether to encode hostnames to internationalized domain names.|
|UsePlatformDeflate||Whether to use the platform implementation to decompress compressed responses.|
|UsePlatformHTTPClient||Whether or not to use the platform HTTP client.|
|UserAgent||Information about the user agent (browser).|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|ConnectionTimeout||Sets a separate timeout value for establishing a connection.|
|FirewallAutoDetect||Tells the component whether or not to automatically detect and use firewall system settings, if available.|
|FirewallHost||Name or IP address of firewall (optional).|
|FirewallListener||If true, the component binds to a SOCKS firewall as a server (IPPort only).|
|FirewallPassword||Password to be used if authentication is to be used when connecting through the firewall.|
|FirewallPort||The TCP port for the FirewallHost;.|
|FirewallType||Determines the type of firewall to connect through.|
|FirewallUser||A user name if authentication is to be used connecting through a firewall.|
|KeepAliveInterval||The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.|
|KeepAliveTime||The inactivity time in milliseconds before a TCP keep-alive packet is sent.|
|Linger||When set to True, connections are terminated gracefully.|
|LingerTime||Time in seconds to have the connection linger.|
|LocalHost||The name of the local host through which connections are initiated or accepted.|
|LocalPort||The port in the local host where the component binds.|
|MaxLineLength||The maximum amount of data to accumulate when no EOL is found.|
|MaxTransferRate||The transfer rate limit in bytes per second.|
|ProxyExceptionsList||A semicolon separated list of hosts and IPs to bypass when using a proxy.|
|TCPKeepAlive||Determines whether or not the keep alive socket option is enabled.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|CACertFilePaths||The paths to CA certificate files when using Mono on Unix/Linux.|
|LogSSLPackets||Controls whether SSL packets are logged when using the internal security API.|
|ReuseSSLSession||Determines if the SSL session is reused.|
|SSLCACerts||A newline separated list of CA certificate to use during SSL client authentication.|
|SSLCheckCRL||Whether to check the Certificate Revocation List for the server certificate.|
|SSLCipherStrength||The minimum cipher strength used for bulk encryption.|
|SSLEnabledCipherSuites||The cipher suite to be used in an SSL negotiation.|
|SSLEnabledProtocols||Used to enable/disable the supported security protocols.|
|SSLEnableRenegotiation||Whether the renegotiation_info SSL extension is supported.|
|SSLIncludeCertChain||Whether the entire certificate chain is included in the SSLServerAuthentication event.|
|SSLProvider||The name of the security provider to use.|
|SSLSecurityFlags||Flags that control certificate verification.|
|SSLServerCACerts||A newline separated list of CA certificate to use during SSL server certificate validation.|
|TLS12SignatureAlgorithms||Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.|
|TLS12SupportedGroups||The supported groups for ECC.|
|TLS13KeyShareGroups||The groups for which to pregenerate key shares.|
|TLS13SignatureAlgorithms||The allowed certificate signature algorithms.|
|TLS13SupportedGroups||The supported groups for (EC)DHE key exchange.|
|AbsoluteTimeout||Determines whether timeouts are inactivity timeouts or absolute timeouts.|
|FirewallData||Used to send extra data to the firewall.|
|InBufferSize||The size in bytes of the incoming queue of the socket.|
|OutBufferSize||The size in bytes of the outgoing queue of the socket.|
|BuildInfo||Information about the product's build.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|LicenseInfo||Information about the current license.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|