Retrieves tracking data for any package shipped with Delivery or Signature confirmation.
This component is used to check the delivery status of any package without having to go to the USPS web site to make any queries about the status of your shipment. This component can retrieve tracking information for any Express Mail package, any package sent to a US address utilizing the Delivery or Signature confirmation option, as well as all International shipments.
To retrieve tracking information, simply provide your tracking number as a parameter into the TrackShipment method. The RequestType property determines which of the two types of requests are sent. They are listed below.
|Detail||Returns a detailed account of the package status at every step along the way.|
|Summary||Returns an overview of the current package's status in the Status field.|
For the Detail request type, information will be provided for each time the barcode on the label was scanned. There may be many such tracking events as a package travels to its destination, and information on each hop is contained in the TrackEvents property. Information is returned in the following fields:
|Date||The date this tracking event occurred.|
|Time||The time at which this tracking event occurred.|
|City||The city where the tracking event occurred.|
|State||The state (or province) where the tracking event occurred.|
|ZipCode||The zip code where the tracking event occurred.|
|CountryCode||The country where the tracking event occurred.|
|Status||Description of the tracking event (enroute, delivered, etc)|
|Company||Name of the firm the package was delivered to.|
|PackageSignedBy||Name of the person who signed for the package.|
The following example will return sample data from a special USPS test server:
USPSTrack.USPSAccount.UserId = "YOURIDHERE" USPSTrack.USPSAccount.Server = "http://testing.shippingapis.com/ShippingAPITest.dll" USPSTrack.TrackShipment("EJ958083578US") ' Only works with above URL
Postage Provider NotesppNone
When using USPS as the PostageProvider (i.e. ppNone) you will need to...
- Set PostageProvider to ppNone (default).
- Set UserId to the UserId provided by USPS.
- Set Password to the password provided by USPS.
- Set Server to either the test or production server.
When using Endicia as the PostageProvider there are different instructions for Production and Testing.
Endicia will provide you with a production account number and password. To use your account with the components...
- Set PostageProvider to ppEndicia.
- Set AccountNumber to your production account number (provided by Endicia).
- Set Password to your production password (provided by Endicia).
The components come with a built in sandbox account for your use. To use that account with the components...Server.
When using Stamps.com as the PostageProvider you will need to...
- Set PostageProvider to ppStamps.
- Set UserId to the sandbox or production user provided by Stamps.com.
- Set AccountNumber to the sandbox or production account number provided by Stamps.com.
- Set Password to the sandbox or production password provided by Stamps.com.
- Set Server to either the test or production server.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|Firewall||A set of properties related to firewall access.|
|PackageSignedBy||Signature of person who signed for package.|
|PostageProvider||The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.|
|Proxy||A set of properties related to proxy access.|
|RequestType||The type of tracking request.|
|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.|
|TrackEvents||The tracking events returned for a given TrackingNumber .|
|USPSAccount||Login information for USPS.|
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 .|
|Reset||Resets the internal state of the component and all properties to their default values.|
|TrackShipment||Returns tracking data for requested TrackingNumber .|
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.
|RawRequest||Contains the complete request sent to the Server.|
|RawResponse||Contains the complete response returned by the Server.|
|XPath||Used to set the XPath within the response from the server.|
|HasXPath||Determines whether a specific element exists in the document.|
|XParent||The parent of the current element.|
|XElement||The name of the current element.|
|XText||The text of the current element.|
|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.|
|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.|
|RegisteredMailValue||The value of registered mail sent in the request.|
|StampsTestMode||Controls whether requests are test requests or live requests.|
|StampsAPIVersion||Controls the API version used for requests.|
|EndiciaInsuranceType||The Insurance type when using Endicia.|
|EscapeEndiciaXML||Whether to escape XML special characters when using Endicia.|
|EndiciaHazMatPhone||HazMat phone number.|
|EndiciaTestMode||Controls whether requests are test requests or live requests.|
|EntryFacility||Postal facility where mail is entered.|
|IncludePostage||Used to determine if the postage will be printed on the label.|
|POZipCode||ZIP Code of Post Office.|
|RequestId||The ID used to identify a particular request/response pair when tracking Endicia packages.|
|RubberStamp1||Customer defined data to be printed on label.|
|RubberStamp2||Customer defined data to be printed on label.|
|RubberStamp3||Customer defined data to be printed on label.|
|SortType||Sort level for applicable mail classes.|
|UseStealth||Used to determine if the postage price is printed on the label.|
|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.|
|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.|
|HTTPVersion||The version of HTTP used by the component.|
|HTTP2HeadersWithoutIndexing||HTTP2 headers that should not update the dynamic header table with incremental indexing.|
|IfModifiedSince||A date determining the maximum age of the desired document.|
|KeepAlive||Determines whether the HTTP connection is closed after completion of the request.|
|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.|
|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.|
|UseChunkedEncoding||Enables or Disables HTTP chunked encoding for transfers.|
|ChunkSize||Specifies the chunk size in bytes when using chunked encoding.|
|UsePlatformHTTPClient||Whether or not to use the platform HTTP client.|
|UserAgent||Information about the user agent (browser).|
|KerberosSPN||The Service Principal Name for the Kerberos Domain Controller.|
|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.|
|KeepAliveTime||The inactivity time in milliseconds before a TCP keep-alive packet is sent.|
|KeepAliveInterval||The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.|
|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.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|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.|
|SSLCipherStrength||The minimum cipher strength used for bulk encryption.|
|SSLEnabledProtocols||Used to enable/disable the supported security protocols.|
|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.|
|SSLCACerts||A newline separated list of CA certificate to use during SSL client authentication.|
|SSLEnabledCipherSuites||The cipher suite to be used in an SSL negotiation.|
|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.|
|TLS13SupportedGroups||The supported groups for (EC)DHE key exchange.|
|TLS13SignatureAlgorithms||The allowed certificate signature algorithms.|
|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.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|UseBackgroundThread||Whether threads created by the component are background threads.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|