UPSTrack Class
Properties Methods Events Configuration Settings Errors
Provides up-to-the-minute status reports of shipments, domestic and international, from origin to delivery.
Syntax
inship.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 class supports tracking by tracking number, shipment identification number, or reference number. Using this class, 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 class provides several levels of information depending on the request:
- When tracking a package using a UPS tracking number as the request parameter, this class 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 class 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 class 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 class 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 class 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 class limits the data requested to ten (10) packages per transaction.
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
| FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
| FirewallType | This property determines the type of firewall to connect through. |
| FirewallHost | This property contains the name or IP address of firewall (optional). |
| FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
| FirewallPort | This property contains the TCP port for the firewall Host . |
| FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
| 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 . |
| ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
| ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
| ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
| ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
| ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
| ProxySSL | This property determines when to use SSL for the connection to the proxy. |
| ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
| RecipientAddress1 | Street name. |
| RecipientAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| RecipientCity | Name of city, town, etc. |
| RecipientCountryCode | Country code. |
| RecipientState | State or province code. |
| RecipientZipCode | Postal code. |
| ScheduledDeliveryDate | Date shipment was originally scheduled for delivery. |
| ScheduledDeliveryTime | Time shipment was originally scheduled for delivery. |
| SenderAddress1 | Street name. |
| SenderAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
| SenderCity | Name of city, town, etc. |
| SenderCountryCode | Country code. |
| SenderState | State or province code. |
| SenderZipCode | Postal code. |
| 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. |
| SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertEncoded | The certificate (PEM/base64 encoded). |
| SSLCertStore | The name of the certificate store for the client certificate. |
| SSLCertStorePassword | If 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. |
| SSLCertStoreType | The type of certificate store for this certificate. |
| SSLCertSubject | The subject of the certificate used for client authentication. |
| SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
| Timeout | A timeout for the component. |
| TotalWeight | Shipment's total weight. |
| TrackEventCount | The number of records in the TrackEvent arrays. |
| TrackEventAddress1 | Line 1 in the location address where a tracking event occurred (by package). |
| TrackEventAddress2 | Line 2 in the location address where a tracking event occurred (by package). |
| TrackEventCity | Name of the city where the tracking event occurred. |
| TrackEventCountryCode | Country code where the tracking event happened. |
| TrackEventDate | Date the tracking event happened. |
| TrackEventLocation | Location description where a tracking event occurred. |
| TrackEventState | State or province code where the tracking event occurred. |
| TrackEventStatus | Literal description of the tracking event. |
| TrackEventTime | Time the tracking event occurred. |
| TrackEventZipCode | Postal code where the tracking event happened. |
| UPSAccessKey | An identifier required to connect to a UPS server. |
| UPSAccountNumber | The shipper's UPS account number. |
| UPSPassword | Password to use for logging in to a UPS Server . |
| UPSServer | URL for the UPS server where the requests are sent. |
| UPSUserId | User Id for logging in to UPS. |
Method List
The following is the full list of the methods of the class 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 class 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 class 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 retrieve data at any place within the response. |
| Warning | Warning message returned by the server. |
| UseSOAP | Whether or not to use UPS' webservices. |
| EventStatusCode[i] | Gets the status code for the specified event. |
| 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). |
| PackagePOD | Proof of Delivery image for the package being tracked (if applicable). |
| PackagePODFile | Filename of this package POD image (if applicable). |
| 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). |
| ShipmentCount | Number of shipments in the list of shipment candidates (if duplicates are found). |
| ShipmentIndex | Specifies a shipment and updates the component properties. |
| ShipmentBookmarkIndex | Specifies a shipment and updates the component properties. |
| SignatureRequired[i] | Identifies the type of signature required. |
| WeightUnit | Weight unit. |
| AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
| AllowHTTPCompression | This property enables HTTP compression for receiving data. |
| AllowIdenticalRedirectURL | Allow redirects to the same URL. |
| 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. |
| IfModifiedSince | A date determining the maximum age of the desired document. |
| KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
| MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
| 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. |
| 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. |
| 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). |
| 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 TCP 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. |
| RecordLength | The length of received data records. |
| TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
| UseIPv6 | Whether to use IPv6. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
| 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. |
| SSLProvider | The name of the security provider to use. |
| SSLSecurityFlags | Flags that control certificate verification. |
| OpenSSLCADir | The path to a directory containing CA certificates. |
| OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
| OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
| OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
| 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. |
| CodePage | The system code page used for Unicode to Multibyte translations. |