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

USPSTrack Component

Properties   Methods   Events   Configuration Settings   Errors  

Retrieves tracking data for any package shipped with Delivery or Signature confirmation.

Syntax

DPayments.DShipping.Uspstrack

Remarks

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.

DetailReturns a detailed account of the package status at every step along the way.
SummaryReturns 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:

DateThe date this tracking event occurred.
TimeThe time at which this tracking event occurred.
CityThe city where the tracking event occurred.
StateThe state (or province) where the tracking event occurred.
ZipCodeThe zip code where the tracking event occurred.
CountryCodeThe country where the tracking event occurred.
StatusDescription of the tracking event (enroute, delivered, etc)
CompanyName of the firm the package was delivered to.
PackageSignedByName 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 Notes

ppNone

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.
ppEndicia

When using Endicia as the PostageProvider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

Testing

The components come with a built in sandbox account for your use. To use that account with the components...

In all cases the component will send requests to the correct server without setting Server.

ppStamps

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.

Property List


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

FirewallA set of properties related to firewall access.
PackageSignedBySignature of person who signed for package.
PostageProviderThe postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.
ProxyA set of properties related to proxy access.
RequestTypeThe type of tracking request.
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.
TrackEventsThe tracking events returned for a given TrackingNumber .
USPSAccountLogin information for USPS.

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 .
ResetResets the internal state of the component and all properties to their default values.
TrackShipmentReturns tracking data for requested TrackingNumber .

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.
RegisteredMailValueThe value of registered mail sent in the request.
StampsTestModeControls whether requests are test requests or live requests.
StampsAPIVersionControls the API version used for requests.
EndiciaInsuranceTypeThe Insurance type when using Endicia.
EscapeEndiciaXMLWhether to escape XML special characters when using Endicia.
EndiciaHazMatDescriptionHazMat Description.
EndiciaHazMatPhoneHazMat phone number.
EndiciaTestModeControls whether requests are test requests or live requests.
EntryFacilityPostal facility where mail is entered.
IncludePostageUsed to determine if the postage will be printed on the label.
POZipCodeZIP Code of Post Office.
RequestIdThe ID used to identify a particular request/response pair when tracking Endicia packages.
RubberStamp1Customer defined data to be printed on label.
RubberStamp2Customer defined data to be printed on label.
RubberStamp3Customer defined data to be printed on label.
SortTypeSort level for applicable mail classes.
UseStealthUsed to determine if the postage price is printed on the label.
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]