UPSTrack Component
Properties Methods Events Configuration Settings Errors
Provides up-to-the-minute status reports of shipments, domestic and international, from origin to delivery.
Syntax
DPayments.DShippingSDK.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 component supports tracking by tracking number, shipment identification number, or reference number. Using this component, 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 component provides several levels of information depending on the request:
- When tracking a package using a UPS tracking number as the request parameter, this component 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 component 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 component 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.
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 component 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 component 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 Codes section.
This component limits the data requested to ten (10) packages per transaction.
Property List
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. |
| IdentifierType | Type of shipment identifier by which the shipment is to be tracked. |
| MasterTrackingNumber | UPS-assigned tracking number assigned to the whole shipment . |
| PackageCount | The number of packages returned for a given shipment id or reference number . |
| PackageIndex | The package index in a shipment returned for a given shipment id or reference number . |
| PackageMessage | Message describing the shipping status in more details corresponding to the PackageIndex . |
| PackageReferences | References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer. |
| PackageSignedBy | Name of the person signing for package delivery (if applicable) corresponding to the PackageIndex . |
| PackageTrackingNumber | Package's tracking number corresponding to the PackageIndex . |
| PackageWeight | Package's weight corresponding to the PackageIndex . |
| Proxy | A set of properties related to proxy access. |
| RecipientAddress | Identifies the recipient's address. |
| ScheduledDeliveryDate | Date shipment was originally scheduled for delivery. |
| ScheduledDeliveryTime | Time shipment was originally scheduled for delivery. |
| SenderAddress | Identifies the sender's address from which the shipment is originating. |
| ServiceTypeDescription | Description of a UPS service used to ship the package or shipment being tracked. |
| ShipDate | The date on which the package was tendered to UPS. |
| ShipDateEnd | End of pickup date range used to narrow down the search. |
| ShipDateStart | Start of pickup date range used to narrow down the search. |
| ShipmentReference | Customer-defined number (that may or may not be unique) used to identify the whole shipment. |
| 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 | Shipment's total weight. |
| TrackEvents | Collection of tracking details for all scanning events that occur during the shipping process (corresponding to the PackageIndex ). |
| UPSAccount | Login information for UPS. |
Method List
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 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.
| 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. |
Configuration Settings
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
| AlternateDeliveryAddress | Used to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points. |
| EventStatusCode[i] | Gets the status code for the specified event. |
| HasXPath | Determines whether a specific element exists in the document. |
| IncludeNegotiatedRates | Whether to include the NegotiatedRatesIndicator in the request. |
| ItemizedChargesCode[i] | The Accesorial/Surcharge code of the itemized charge. |
| ItemizedChargesCount | The count of itemized charges. |
| ItemizedChargesCurrencyCode[i] | The currency used for the charge. |
| ItemizedChargesMonetaryValue[i] | The amount being charged. |
| ItemizedChargesSubType[i] | The subtype of the itemized charge. |
| NotificationDialect | Used to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications. |
| NotificationLanguage | Used to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications. |
| PackagePOD | Proof of Delivery image for the package being tracked (if applicable). |
| PackagePODFile | Filename of this package POD image (if applicable). |
| PackageRescheduledDeliveryDate | Date when the delivery is re-scheduled to (if applicable). |
| PackageRescheduledDeliveryTime | Time when the delivery is re-scheduled to (if applicable). |
| PackageReturnAddress1 | Line 1 in return to sender's address (if applicable). |
| PackageReturnAddress2 | Line 2 in return to sender's address (if applicable). |
| PackageReturnCity | City in return to sender's address (if applicable). |
| PackageReturnCountryCode | Country code in return to sender's address (if applicable). |
| PackageReturnState | State or province code in return to sender's address (if applicable). |
| PackageReturnZipCode | Zip or postal code in return to sender's address (if applicable). |
| PackageSignature | Signature image for the package being tracked (if applicable). |
| PackageSignatureFile | File name of the signature image for this package (if applicable). |
| RawRequest | Contains the complete request sent to the Server. |
| RawResponse | Contains the complete response returned by the Server. |
| RequestOption | Specifies the type of information the server will return about the shipment. |
| ShipmentBookmark | Bookmark for a particular shipment in the list of shipment candidates (if duplicates are found). |
| ShipmentBookmarkIndex | Specifies a shipment and updates the component properties. |
| ShipmentCount | Number of shipments in the list of shipment candidates (if duplicates are found). |
| ShipmentIndex | Specifies a shipment and updates the component properties. |
| ShipmentIndicationType | Whether shipment is Hold For Pickup or Delivery at UPS Access Points. |
| SignatureRequired[i] | Identifies the type of signature required. |
| SubVersion | UPS SubVersion. |
| TaxInformationIndicator | Controls whether to send a TaxInformationIndicator. |
| UseSOAP | Whether or not to use UPS' webservices. |
| Warning | Warning message returned by the server. |
| WeightUnit | Weight unit. |
| 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. |
| SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
| SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
| SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
| SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
| SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
| SSLNegotiatedVersion | Returns the negotiated protocol version. |
| 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. |