UPSTrack Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

DShippingSDK_UPSTrack

Procedural Interface

 dshippingsdk_upstrack_open();
 dshippingsdk_upstrack_close($res);
 dshippingsdk_upstrack_register_callback($res, $id, $function);
 dshippingsdk_upstrack_get_last_error($res);
 dshippingsdk_upstrack_get_last_error_code($res);
 dshippingsdk_upstrack_set($res, $id, $index, $value);
 dshippingsdk_upstrack_get($res, $id, $index);
 dshippingsdk_upstrack_do_config($res, $configurationstring);
 dshippingsdk_upstrack_do_reset($res);
 dshippingsdk_upstrack_do_trackshipment($res, $idvalue);

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

Method List

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

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.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

FirewallAutoDetect Property (DShippingSDK_UPSTrack Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 1 );


dshippingsdk_upstrack_set($res, 1, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (DShippingSDK_UPSTrack Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 2 );


dshippingsdk_upstrack_set($res, 2, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (DShippingSDK_UPSTrack Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 3 );


dshippingsdk_upstrack_set($res, 3, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (DShippingSDK_UPSTrack Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 4 );


dshippingsdk_upstrack_set($res, 4, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (DShippingSDK_UPSTrack Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 5 );


dshippingsdk_upstrack_set($res, 5, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (DShippingSDK_UPSTrack Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 6 );


dshippingsdk_upstrack_set($res, 6, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

MasterTrackingNumber Property (DShippingSDK_UPSTrack Class)

UPS-assigned tracking number assigned to the whole shipment .

Object Oriented Interface

public function getMasterTrackingNumber();

Procedural Interface

dshippingsdk_upstrack_get($res, 7 );

Default Value

''

Remarks

If the shipment contains only one package (PackageCount = 1), the MasterTrackingNumber is the same as the first PackageTrackingNumber (where PackageIndex = 1).

The MasterTrackingNumber uniquely identifies a shipment up to 18 months. However, it is possible that this number may be reused within a shorter time period. If this occurs, a query by Master Tracking Number returns all shipments (from the same ShipperAccountNumber) matching this number.

This is not available for freight shipments.

This property is read-only.

Data Type

String

PackageCount Property (DShippingSDK_UPSTrack Class)

The number of packages returned for a given shipment id or reference number .

Object Oriented Interface

public function getPackageCount();

Procedural Interface

dshippingsdk_upstrack_get($res, 8 );

Default Value

0

Remarks

When the idType is set to either 1 (Shipment Id) or 2 (Reference Number) when TrackShipment method is called, the PackageCount indicates the number of packages contained in the shipment being tracked.

When the idType is set to 0 (Package Tracking Number), then the PackageCount is set to 1 upon successful requests.

This property is read-only.

Data Type

Integer

PackageDeliveredOnDate Property (DShippingSDK_UPSTrack Class)

Date when package was delivered corresponding to the PackageIndex .

Object Oriented Interface

public function getPackageDeliveredOnDate();

Procedural Interface

dshippingsdk_upstrack_get($res, 9 );

Default Value

''

Remarks

When the TrackShipment method is called, PackageDeliveredOnDate will be returned in the response (if available).

It is returned in this format: YYYYMMDD.

This property is read-only.

Data Type

String

PackageDeliveryTime Property (DShippingSDK_UPSTrack Class)

Contains all delivery times associated with the package at PackageIndex .

Object Oriented Interface

public function getPackageDeliveryTime();

Procedural Interface

dshippingsdk_upstrack_get($res, 10 );

Default Value

''

Remarks

When the TrackShipment method is called, PackageDeliveryTime will be returned in the response (if available). For example: Estimated Delivery Window:13:45:00-15:45:00.

The time format is: HHMMSS (24 hr).

This property is read-only.

Data Type

String

PackageIndex Property (DShippingSDK_UPSTrack Class)

The package index in a shipment returned for a given shipment id or reference number .

Object Oriented Interface

public function getPackageIndex();


public function setPackageIndex($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 11 );


dshippingsdk_upstrack_set($res, 11, $value );

Default Value

0

Remarks

This property contains the index of a package returned from the UPS Server after calling TrackShipment method where the idType is set to either 1 (Shipment Id) or 2 (Reference Number).

The PackageCount will contain the number of packages included in a shipment and the PackageIndex will contain the package index in the list of packages.

To retrieve all attributes corresponding to a package, the PackageIndex should be set from 0 to PackageCount - 1.

Data Type

Integer

PackageMessage Property (DShippingSDK_UPSTrack Class)

Message describing the shipping status in more details corresponding to the PackageIndex .

Object Oriented Interface

public function getPackageMessage();

Procedural Interface

dshippingsdk_upstrack_get($res, 12 );

Default Value

''

Remarks

This property may be returned in server response when the TrackShipment method is called. If the shipment contains multiple packages, the PackageMessage corresponds to each package being shipped as part of this shipment.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Data Type

String

PackageReceivedBy Property (DShippingSDK_UPSTrack Class)

The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex .

Object Oriented Interface

public function getPackageReceivedBy();

Procedural Interface

dshippingsdk_upstrack_get($res, 13 );

Default Value

''

Remarks

This corresponds to the package at PackageIndex and is returned only if this package has already been delivered. To retrieve this property, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Data Type

String

PackageReferences Property (DShippingSDK_UPSTrack Class)

References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.

Object Oriented Interface

public function getPackageReferences();

Procedural Interface

dshippingsdk_upstrack_get($res, 14 );

Default Value

''

Remarks

This should be inspected after a call to the TrackShipment method. A package can have 0 to many reference numbers assigned to it by the shipper when the shipping label was generated.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Data Type

String

PackageRescheduledDeliveryDate Property (DShippingSDK_UPSTrack Class)

Date when the delivery is re-scheduled to (if applicable). This corresponds to the package at PackageIndex .

Object Oriented Interface

public function getPackageRescheduledDeliveryDate();

Procedural Interface

dshippingsdk_upstrack_get($res, 15 );

Default Value

''

Remarks

This is read-only and it might be returned in the server response only if package delivery re-scheduling has occurred.

It is returned in this format: YYYYMMDD.

This property is read-only.

Data Type

String

PackageScheduledDeliveryDate Property (DShippingSDK_UPSTrack Class)

Date when package is scheduled for delivery. This corresponds to the package at PackageIndex .

Object Oriented Interface

public function getPackageScheduledDeliveryDate();

Procedural Interface

dshippingsdk_upstrack_get($res, 16 );

Default Value

''

Remarks

When the TrackShipment method is called, PackageScheduledDeliveryDate will be returned in the response (if available).

It is returned in this format: YYYYMMDD.

This property is read-only.

Data Type

String

PackageSignedBy Property (DShippingSDK_UPSTrack Class)

Name of the person signing for package delivery (if applicable) corresponding to the PackageIndex .

Object Oriented Interface

public function getPackageSignedBy();

Procedural Interface

dshippingsdk_upstrack_get($res, 17 );

Default Value

''

Remarks

To retrieve this property corresponding to each tracking event per package, the index should be set from 0 to TrackCount - 1 for each package (i.e., for each PackageIndex from 0 to PackageCount - 1).

This property is read-only.

Data Type

String

PackageTrackingNumber Property (DShippingSDK_UPSTrack Class)

Package's tracking number corresponding to the PackageIndex .

Object Oriented Interface

public function getPackageTrackingNumber();

Procedural Interface

dshippingsdk_upstrack_get($res, 18 );

Default Value

''

Remarks

This is returned in the server's response when the TrackShipment method is called.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Data Type

String

PackageWeight Property (DShippingSDK_UPSTrack Class)

Package's weight corresponding to the PackageIndex .

Object Oriented Interface

public function getPackageWeight();

Procedural Interface

dshippingsdk_upstrack_get($res, 19 );

Default Value

''

Remarks

This property is returned by UPS Server when the TrackShipment method is called. If the shipment contains only one package (PackageCount=1), this is the same as PackageWeight. This is set to 0 for package type of letters.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Data Type

String

ProxyAuthScheme Property (DShippingSDK_UPSTrack Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 20 );


dshippingsdk_upstrack_set($res, 20, $value );

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (DShippingSDK_UPSTrack Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 21 );


dshippingsdk_upstrack_set($res, 21, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (DShippingSDK_UPSTrack Class)

This property contains a password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 22 );


dshippingsdk_upstrack_set($res, 22, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (DShippingSDK_UPSTrack Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 23 );


dshippingsdk_upstrack_set($res, 23, $value );

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (DShippingSDK_UPSTrack Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 24 );


dshippingsdk_upstrack_set($res, 24, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (DShippingSDK_UPSTrack Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 25 );


dshippingsdk_upstrack_set($res, 25, $value );

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (DShippingSDK_UPSTrack Class)

This property contains a username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 26 );


dshippingsdk_upstrack_set($res, 26, $value );

Default Value

''

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (DShippingSDK_UPSTrack Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 27 );


dshippingsdk_upstrack_set($res, 27, $value );

Default Value

''

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (DShippingSDK_UPSTrack Class)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Object Oriented Interface

public function getRecipientAddress2();


public function setRecipientAddress2($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 28 );


dshippingsdk_upstrack_set($res, 28, $value );

Default Value

''

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS RecipientAddress2 should not exceed 35 characters.

Data Type

String

RecipientCity Property (DShippingSDK_UPSTrack Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 30 );


dshippingsdk_upstrack_set($res, 30, $value );

Default Value

''

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

RecipientCountryCode Property (DShippingSDK_UPSTrack Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 31 );


dshippingsdk_upstrack_set($res, 31, $value );

Default Value

'US'

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

RecipientState Property (DShippingSDK_UPSTrack Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 32 );


dshippingsdk_upstrack_set($res, 32, $value );

Default Value

''

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

RecipientZipCode Property (DShippingSDK_UPSTrack Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 33 );


dshippingsdk_upstrack_set($res, 33, $value );

Default Value

''

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

Data Type

String

SenderAddress1 Property (DShippingSDK_UPSTrack Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();

Procedural Interface

dshippingsdk_upstrack_get($res, 34 );

Default Value

''

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS SenderAddress1 should not exceed 35 characters.

This property is read-only.

Data Type

String

SenderAddress2 Property (DShippingSDK_UPSTrack Class)

A specific detail on the address (such as building, suite, apartment, floor number etc.

Object Oriented Interface

public function getSenderAddress2();

Procedural Interface

dshippingsdk_upstrack_get($res, 35 );

Default Value

''

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS SenderAddress2 should not exceed 35 characters.

This property is read-only.

Data Type

String

SenderCity Property (DShippingSDK_UPSTrack Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();

Procedural Interface

dshippingsdk_upstrack_get($res, 37 );

Default Value

''

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

This property is read-only.

Data Type

String

SenderCountryCode Property (DShippingSDK_UPSTrack Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();

Procedural Interface

dshippingsdk_upstrack_get($res, 38 );

Default Value

'US'

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

This property is read-only.

Data Type

String

SenderState Property (DShippingSDK_UPSTrack Class)

State or province code.

Object Oriented Interface

public function getSenderState();

Procedural Interface

dshippingsdk_upstrack_get($res, 39 );

Default Value

''

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

This property is read-only.

Data Type

String

SenderZipCode Property (DShippingSDK_UPSTrack Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();

Procedural Interface

dshippingsdk_upstrack_get($res, 40 );

Default Value

''

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both SenderCity and SenderState are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 16.

This property is read-only.

Data Type

String

ServiceTypeDescription Property (DShippingSDK_UPSTrack Class)

Description of a UPS service used to ship the package or shipment being tracked.

Object Oriented Interface

public function getServiceTypeDescription();

Procedural Interface

dshippingsdk_upstrack_get($res, 41 );

Default Value

''

Remarks

This property is populated when the TrackShipment method is called regardless the idType.

Possible values are UPS available services:

This property is read-only.

Data Type

String

ShipDate Property (DShippingSDK_UPSTrack Class)

The date on which the package was tendered to UPS.

Object Oriented Interface

public function getShipDate();

Procedural Interface

dshippingsdk_upstrack_get($res, 42 );

Default Value

''

Remarks

This property is returned when the TrackShipment method is called.

This property is read-only and not available at design time.

Data Type

String

ShipmentReference Property (DShippingSDK_UPSTrack Class)

Customer-defined number (that may or may not be unique) used to identify the whole shipment.

Object Oriented Interface

public function getShipmentReference();

Procedural Interface

dshippingsdk_upstrack_get($res, 43 );

Default Value

''

Remarks

When the TrackShipment method is called, and if issued at the time of shipping, this reference number (if any) will be returned in server's response.

This property is read-only.

Data Type

String

ShipperAccountNumber Property (DShippingSDK_UPSTrack Class)

Account number associated with shipment.

Object Oriented Interface

public function getShipperAccountNumber();


public function setShipperAccountNumber($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 44 );


dshippingsdk_upstrack_set($res, 44, $value );

Default Value

''

Remarks

This indicates the account number associated with shipment (as opposed to the UPSAccountNumber, which is that of the party sending the request).

This can be provided in a track request to narrow down the search results. It can also be returned in the server response when the TrackShipment method is called.

Data Type

String

SSLAcceptServerCertEncoded Property (DShippingSDK_UPSTrack Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 46 );


dshippingsdk_upstrack_set($res, 46, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DShippingSDK_UPSTrack Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 74 );


dshippingsdk_upstrack_set($res, 74, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DShippingSDK_UPSTrack Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 90 );


dshippingsdk_upstrack_set($res, 90, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_UPSTrack Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 91 );


dshippingsdk_upstrack_set($res, 91, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (DShippingSDK_UPSTrack Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 92 );


dshippingsdk_upstrack_set($res, 92, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (DShippingSDK_UPSTrack Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 93 );


dshippingsdk_upstrack_set($res, 93, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (DShippingSDK_UPSTrack Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 101 );


dshippingsdk_upstrack_set($res, 101, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (DShippingSDK_UPSTrack Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_upstrack_get($res, 103 );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

Timeout Property (DShippingSDK_UPSTrack Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 130 );


dshippingsdk_upstrack_set($res, 130, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalWeight Property (DShippingSDK_UPSTrack Class)

Shipment's total weight.

Object Oriented Interface

public function getTotalWeight();

Procedural Interface

dshippingsdk_upstrack_get($res, 131 );

Default Value

''

Remarks

This property is returned by UPS Server only if the shipment being tracked is a multi-piece shipment (PackageCount > 1) and not a single piece.

TotalWeight is set to 0 for shipment with packages of package type of letters.

This property is read-only.

Data Type

String

TrackEventCount Property (DShippingSDK_UPSTrack Class)

The number of records in the TrackEvent arrays.

Object Oriented Interface

public function getTrackEventCount();

Procedural Interface

dshippingsdk_upstrack_get($res, 132 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrackEventAddress1
• TrackEventAddress2
• TrackEventCity
• TrackEventCountryCode
• TrackEventDate
• TrackEventLocation
• TrackEventState
• TrackEventStatus
• TrackEventTime
• TrackEventZipCode

The array indices start at 0 and end at TrackEventCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

TrackEventAddress1 Property (DShippingSDK_UPSTrack Class)

Line 1 in the location address where a tracking event occurred (by package).

Object Oriented Interface

public function getTrackEventAddress1($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 133 , $trackeventidx);

Default Value

''

Remarks

Line 1 in the location address where a tracking event occurred (by package). This contains street prefix, street name, street type.

This is not available for USPS tracking requests.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventAddress2 Property (DShippingSDK_UPSTrack Class)

Line 2 in the location address where a tracking event occurred (by package).

Object Oriented Interface

public function getTrackEventAddress2($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 134 , $trackeventidx);

Default Value

''

Remarks

Line 2 in the location address where a tracking event occurred (by package). This contains building, floor, room, suite and PO Box Number.

This is not available for USPS tracking requests.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventCity Property (DShippingSDK_UPSTrack Class)

Name of the city where the tracking event occurred.

Object Oriented Interface

public function getTrackEventCity($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 135 , $trackeventidx);

Default Value

''

Remarks

Name of the city where the tracking event occurred. This is returned in the server reply for each tracking event.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventCountryCode Property (DShippingSDK_UPSTrack Class)

Country code where the tracking event happened.

Object Oriented Interface

public function getTrackEventCountryCode($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 137 , $trackeventidx);

Default Value

''

Remarks

Country code where the tracking event happened.

For FedEx, this is returned if the country, where the scanning activity happened, is US or CA (for Canada).

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventDate Property (DShippingSDK_UPSTrack Class)

Date the tracking event happened.

Object Oriented Interface

public function getTrackEventDate($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 138 , $trackeventidx);

Default Value

''

Remarks

Date the tracking event happened.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventLocation Property (DShippingSDK_UPSTrack Class)

Location description where a tracking event occurred.

Object Oriented Interface

public function getTrackEventLocation($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 140 , $trackeventidx);

Default Value

''

Remarks

Location description where a tracking event occurred.

This is only applicable to UPS.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventState Property (DShippingSDK_UPSTrack Class)

State or province code where the tracking event occurred.

Object Oriented Interface

public function getTrackEventState($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 142 , $trackeventidx);

Default Value

''

Remarks

State or province code where the tracking event occurred. This is a two-letter standard abbreviation.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventStatus Property (DShippingSDK_UPSTrack Class)

Literal description of the tracking event.

Object Oriented Interface

public function getTrackEventStatus($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 143 , $trackeventidx);

Default Value

''

Remarks

Literal description of the tracking event.

For UPS, possible values are:

For USPS, if RequestType is set to rtSummary, this will contain a description of the current status of the package being tracked. In this case, TrackEventStatus will contain the entire summary and none of the other properties will be populated. For example, this property might contain: "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."

If there is a problem with a specific TrackingNumber within the request, the response will raise an error which will be returned in the TrackEventStatus property that pertains to the specific TrackingNumber.

When RequestType is set to rtDetail however, this property will contain a description of the event type for the current tracking event. For example, "ENROUTE", "DELIVERED", "ACCEPTANCE", etc. The rest of the fields will be populated with more details of the event.

When using Endicia as your postage provider, Status will be the only field populated and may contain the status, the timestamp, and the location of the tracking event.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventTime Property (DShippingSDK_UPSTrack Class)

Time the tracking event occurred.

Object Oriented Interface

public function getTrackEventTime($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 144 , $trackeventidx);

Default Value

''

Remarks

Time the tracking event occurred.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

TrackEventZipCode Property (DShippingSDK_UPSTrack Class)

Postal code where the tracking event happened.

Object Oriented Interface

public function getTrackEventZipCode($trackeventidx);

Procedural Interface

dshippingsdk_upstrack_get($res, 145 , $trackeventidx);

Default Value

''

Remarks

Postal code where the tracking event happened. Returned if the country, where the scanning activity happened, supports postal-code system.

The $trackeventidx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

This property is read-only and not available at design time.

Data Type

String

UPSAccountNumber Property (DShippingSDK_UPSTrack Class)

The shipper's UPS account number.

Object Oriented Interface

public function getUPSAccountNumber();


public function setUPSAccountNumber($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 146 );


dshippingsdk_upstrack_set($res, 146, $value );

Default Value

''

Remarks

The shipper's UPS account number.

This property describes the shipper's 6- or 10- digit UPS account number.

Data Type

String

UPSAuthorizationToken Property (DShippingSDK_UPSTrack Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getUPSAuthorizationToken();


public function setUPSAuthorizationToken($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 147 );


dshippingsdk_upstrack_set($res, 147, $value );

Default Value

''

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

Data Type

String

UPSServer Property (DShippingSDK_UPSTrack Class)

URL for the UPS server where the requests are sent.

Object Oriented Interface

public function getUPSServer();


public function setUPSServer($value);

Procedural Interface

dshippingsdk_upstrack_get($res, 148 );


dshippingsdk_upstrack_set($res, 148, $value );

Default Value

''

Remarks

URL for the UPS server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

The following URLs may be used for testing:

Data Type

String

Config Method (DShippingSDK_UPSTrack Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_upstrack_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Reset Method (DShippingSDK_UPSTrack Class)

Resets the internal state of the class and all properties to their default values.

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_upstrack_do_reset($res);

Remarks

The Reset method does not have any parameters and does not return any value.

TrackShipment Method (DShippingSDK_UPSTrack Class)

Returns tracking data for requested idValue (inquiry / tracking number).

Object Oriented Interface

public function doTrackShipment($idvalue);

Procedural Interface

dshippingsdk_upstrack_do_trackshipment($res, $idvalue);

Remarks

The idValue parameter identifies the shipment/package. The idValue must be alphanumeric.

UPS uses tracking numbers to identify and track every package as it moves through the UPS system to its destination. You can use this tracking number to track, locate, and verify arrival of a package.

If UPS system does not locate any data for the requested idValue, an error message will be returned. The full server reply will be saved to RawResponse.

Upon successful response, the server will return tracking events for each package included in the shipment, and other values tied to that package. For example, if a shipment contained four packages, the query response would show all four packages.

The following properties may be populated upon method return:

• MasterTrackingNumber
• Package(s) detailed information (PackageReferences, PackageTrackingNumber, PackageMessage, PackageSignedBy, PackageWeight, PackageDeliveryTime, PackageDeliveredOnDate, PackageScheduledDeliveryDate, PackageRescheduledDeliveryDate, PackageSignature, PackageReturnAddress1, PackageReturnAddress2, PackageReturnCity, PackageReturnState, PackageReturnCountryCode, PackageReturnZipCode)
• Tracking details for each tracking event, which can be inspected via TrackEvents collection. This information consists of: TrackEventLocation, TrackEventAddress1, TrackEventAddress2, TrackEventCity, TrackEventState, TrackEventCountryCode, TrackEventZipCode, TrackEventDate, TrackEventTime, and TrackEventStatus. These are tied to each package included in the shipment for each PackageIndex from 0 to PackageCount - 1.

If there is a problem with a specific idValue within the request, the response will raise an error that pertains to the specific idValue.

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

Error Event (DShippingSDK_UPSTrack Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_upstrack_register_callback($res, 1, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (DShippingSDK_UPSTrack Class)

Notification returned by the server upon successful request (if applicable).

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_upstrack_register_callback($res, 2, array($this, 'fireNotification'));

Parameter List

 'message'

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (DShippingSDK_UPSTrack Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dshippingsdk_upstrack_register_callback($res, 3, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (DShippingSDK_UPSTrack Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dshippingsdk_upstrack_register_callback($res, 4, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (UPSTrack Class)

UPSTrack Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (UPSTrack Class)

UPSTrack Errors

The class may also return one of the following error codes, which are inherited from other classes.