Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

UPSTrack Control

Properties   Methods   Events   Configuration Settings   Errors  

Provides up-to-the-minute status reports of shipments, domestic and international, from origin to delivery.

Syntax

UPSTrack

Remarks

For a given UPS tracking or reference number, this tool identifies the package(s) and provides detailed information about each package, including the current shipping status and the time and location of each scan while in transit. Track control supports tracking by tracking number, shipment identification number, or reference number. Using this control, you can find out up-to-the-minute specific details on shipping status, including the time and location of each scan as the package moves toward its final destination. And, this tracking information can be displayed in a customized format.

This control provides several levels of information depending on the request:

  • When tracking a package using a UPS tracking number as the request parameter, this control returns information such as current delivery status, including the time and location of the latest transit scan.
  • When tracking a package using a reference number, this control returns information appropriate to the request. The request parameters are the reference number plus at least one of the following optional qualifiers: shipper number, pickup date range, destination postal code and/or destination country.

This control can return several kinds of initial responses:

  • Multi-Piece summary - When multiple packages from a single shipment match the request, the delivered response contains the UPS tracking number, pickup date, delivery date and time (for delivery packages only), location where each package was left if the consignee was not available, UPS shipping service and total shipment weight.
  • Package Detail - When a single package matches the request, the response contains the package weight, consignee city, state and country, the date, time and location of the latest scan while in transit, current delivery status and the name of the person who signed for the package.
  • Package Progress - Lists the date, time, location, and status of each scan of the package during transit, from the point of origin to the current location.
A combination of the multi-piece and package detail responses can be returned in the candidate list.

You can request the multi-piece or package detail response as well as package progress information after you receive the initial response.

Multi-piece summary and package progress requests use the information in a package detail response to retrieve additional information about the package. For example, the control returns information regarding the shipment from a multi-piece summary request. It would also return the date, time, and status of every scan for the package from a package progress request.

When the TrackShipment method call of this control returns a response, it will either return a successful response document or an error document. An error may be returned at the top (response) level if there is a problem with the syntax of the request, or if a system error occurs.

In any of the above scenarios, if there is a problem with a specific identifier within the request, the response will raise an error that pertains to the specific identifier.

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

This control limits the data requested to ten (10) packages per transaction.

Property List


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

FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
IdentifierTypeType of shipment identifier by which the shipment is to be tracked.
MasterTrackingNumberUPS-assigned tracking number assigned to the whole shipment .
PackageCountThe number of packages returned for a given shipment id or reference number .
PackageIndexThe package index in a shipment returned for a given shipment id or reference number .
PackageMessageMessage describing the shipping status in more details corresponding to the PackageIndex .
PackageReferencesReferences (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.
PackageSignedByName of the person signing for package delivery (if applicable) corresponding to the PackageIndex .
PackageTrackingNumberPackage's tracking number corresponding to the PackageIndex .
PackageWeightPackage's weight corresponding to the PackageIndex .
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RecipientAddress1Street name.
RecipientAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientCityName of city, town, etc.
RecipientCountryCodeCountry code.
RecipientStateState or province code.
RecipientZipCodePostal code.
ScheduledDeliveryDateDate shipment was originally scheduled for delivery.
ScheduledDeliveryTimeTime shipment was originally scheduled for delivery.
SenderAddress1Street name.
SenderAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderCityName of city, town, etc.
SenderCountryCodeCountry code.
SenderStateState or province code.
SenderZipCodePostal code.
ServiceTypeDescriptionDescription of a UPS service used to ship the package or shipment being tracked.
ShipDateThe date on which the package was tendered to UPS.
ShipDateEndEnd of pickup date range used to narrow down the search.
ShipDateStartStart of pickup date range used to narrow down the search.
ShipmentReferenceCustomer-defined number (that may or may not be unique) used to identify the whole shipment.
ShipperAccountNumberAccount number associated with shipment.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TotalWeightShipment's total weight.
TrackEventCountThe number of records in the TrackEvent arrays.
TrackEventAddress1Line 1 in the location address where a tracking event occurred (by package).
TrackEventAddress2Line 2 in the location address where a tracking event occurred (by package).
TrackEventCityName of the city where the tracking event occurred.
TrackEventCountryCodeCountry code where the tracking event happened.
TrackEventDateDate the tracking event happened.
TrackEventLocationLocation description where a tracking event occurred.
TrackEventStateState or province code where the tracking event occurred.
TrackEventStatusLiteral description of the tracking event.
TrackEventTimeTime the tracking event occurred.
TrackEventZipCodePostal code where the tracking event happened.
UPSAccessKeyAn identifier required to connect to a UPS server.
UPSAccountNumberThe shipper's UPS account number.
UPSPasswordPassword to use for logging in to a UPS Server .
UPSServerURL for the UPS server where the requests are sent.
UPSUserIdUser Id for logging in to UPS.

Method List


The following is the full list of the methods of the control 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 idValue of IdentifierType type.

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.

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 control 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 retrieve data at any place within the response.
WarningWarning message returned by the server.
UseSOAPWhether or not to use UPS' webservices.
EventStatusCode[i]Gets the status code for the specified event.
PackageRescheduledDeliveryDateDate when the delivery is re-scheduled to (if applicable).
PackageRescheduledDeliveryTimeTime when the delivery is re-scheduled to (if applicable).
PackageReturnAddress1Line 1 in return to sender's address (if applicable).
PackageReturnAddress2Line 2 in return to sender's address (if applicable).
PackageReturnCityCity in return to sender's address (if applicable).
PackageReturnCountryCodeCountry code in return to sender's address (if applicable).
PackageReturnStateState or province code in return to sender's address (if applicable).
PackageReturnZipCodeZip or postal code in return to sender's address (if applicable).
PackageSignatureSignature image for the package being tracked (if applicable).
PackageSignatureFileFile name of the signature image for this package (if applicable).
PackagePODProof of Delivery image for the package being tracked (if applicable).
PackagePODFileFilename of this package POD image (if applicable).
RequestOptionSpecifies the type of information the server will return about the shipment.
ShipmentBookmarkBookmark for a particular shipment in the list of shipment candidates (if duplicates are found).
ShipmentCountNumber of shipments in the list of shipment candidates (if duplicates are found).
ShipmentIndexSpecifies a shipment and updates the component properties.
ShipmentBookmarkIndexSpecifies a shipment and updates the component properties.
SignatureRequired[i]Identifies the type of signature required.
WeightUnitWeight unit.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
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.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
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.
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.
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).
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 TCP 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.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0