UPSRates Class

Properties   Methods   Events   Config Settings   Errors  

Provides domestic or international rates based on weight, service, and origin/destination information.

Class Name

DShippingSDK_UPSRates

Procedural Interface

 dshippingsdk_upsrates_open();
 dshippingsdk_upsrates_close($res);
 dshippingsdk_upsrates_register_callback($res, $id, $function);
 dshippingsdk_upsrates_get_last_error($res);
 dshippingsdk_upsrates_get_last_error_code($res);
 dshippingsdk_upsrates_set($res, $id, $index, $value);
 dshippingsdk_upsrates_get($res, $id, $index);
 dshippingsdk_upsrates_do_config($res, $configurationstring);
 dshippingsdk_upsrates_do_getrates($res);
 dshippingsdk_upsrates_do_getshippingtime($res);
 dshippingsdk_upsrates_do_reset($res);

Remarks

Rates class provides automated online access to domestic and international rate information and is capable also of rating shipments containing multiple packages. Based on the shipment's input characteristics (origin, destination, shipment weight, special services, etc.), the class provides a list of all applicable UPS services and their respective published rates.

For all shipments inside or between the U.S. and Puerto Rico:

The request that is sent to UPS Server must provide details at the package level. For shipments consisting of only one package, the class identifies all the available UPS domestic and international services and returns shipping rates based on the package's specifications. If the shipment consists of two or more packages, the class will return a separate rate for each package and the rate for the total shipment. The total shipment rate will be a sum of the rates for all packages.

For all shipments outside the U.S. and Puerto Rico:

The request must provide details at the shipment level. For shipments consisting of one or more packages, the class will return one rate for all packages at the shipment level (not at the package level).

To retrieve a list of rates for all services applicable to your shipment, the RequestedService must be set to 0 (stUnspecified) when calling GetRates method. To get a rate for a specified service, the RequestedService must be set to the corresponding value of the UPS service to be rated (other than 0: stUnspecified).

In either scenario, UPS server response will contain negotiated rate(s) only for the qualified UPSAccountNumbers. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

Please note that shipping rates retrieved by this class are estimates based on the information supplied. Other shipping charges may apply and the final shipping charge may differ depending upon your UPS Account Number and how the package is tendered to UPS.

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.

AccountAddress1 Property (DShippingSDK_UPSRates Class)

Street name.

Object Oriented Interface

public function getAccountAddress1();


public function setAccountAddress1($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 1 );


dshippingsdk_upsrates_set($res, 1, $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 AccountAddress1 should not exceed 35 characters.

Data Type

String

AccountAddress2 Property (DShippingSDK_UPSRates Class)

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

Object Oriented Interface

public function getAccountAddress2();


public function setAccountAddress2($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 2 );


dshippingsdk_upsrates_set($res, 2, $value );

Default Value

''

Remarks

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

Data Type

String

AccountCity Property (DShippingSDK_UPSRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getAccountCity();


public function setAccountCity($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 4 );


dshippingsdk_upsrates_set($res, 4, $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

AccountCountryCode Property (DShippingSDK_UPSRates Class)

Country code.

Object Oriented Interface

public function getAccountCountryCode();


public function setAccountCountryCode($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 5 );


dshippingsdk_upsrates_set($res, 5, $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

AccountState Property (DShippingSDK_UPSRates Class)

State or province code.

Object Oriented Interface

public function getAccountState();


public function setAccountState($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 6 );


dshippingsdk_upsrates_set($res, 6, $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

AccountZipCode Property (DShippingSDK_UPSRates Class)

Postal code.

Object Oriented Interface

public function getAccountZipCode();


public function setAccountZipCode($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 7 );


dshippingsdk_upsrates_set($res, 7, $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 AccountCity and AccountState are not present.

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

Data Type

String

CODTotalAmount Property (DShippingSDK_UPSRates Class)

The total amount to be collected on shipment level.

Object Oriented Interface

public function getCODTotalAmount();


public function setCODTotalAmount($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 8 );


dshippingsdk_upsrates_set($res, 8, $value );

Default Value

''

Remarks

This indicates customer's input COD amount (prior to any accumulations: total collection amount minus transportation charges).

For MPS COD shipments (when Packages is greater than 1), the COD amount must be included on each package that uses COD service by setting the PackageCODAmount.

Format: Two explicit decimals (e.g.5.00).

Data Type

String

CODType Property (DShippingSDK_UPSRates Class)

The code that indicates the type of funds that will be used for the COD payment.

Object Oriented Interface

public function getCODType();


public function setCODType($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 9 );


dshippingsdk_upsrates_set($res, 9, $value );

Default Value

0

Remarks

This property identifies the type of funds UPS should collect upon shipment delivery. It is required to be provided in the request only if COD is requested (i.e., CODTotalAmount is set to a value other than "0.00").

Valid values are:

Note: COD special service is not valid for return service movements.

Data Type

Integer

CustomerType Property (DShippingSDK_UPSRates Class)

Customer classification code.

Object Oriented Interface

public function getCustomerType();


public function setCustomerType($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 10 );


dshippingsdk_upsrates_set($res, 10, $value );

Default Value

4

Remarks

The CustomerType is applicable only if SenderCountryCode is US. The rates depend on the combination of PickupType and CustomerType.

Valid values are:

Data Type

Integer

Disclaimer Property (DShippingSDK_UPSRates Class)

Disclaimer text.

Object Oriented Interface

public function getDisclaimer();

Procedural Interface

dshippingsdk_upsrates_get($res, 11 );

Default Value

''

Remarks

The Disclaimer is a conditional statement about the validity of the service being guaranteed, based on the SenderCountryCode and RecipientCountryCode. If applicable, this property is filled after a call to the GetShippingTime.

Service Guaranteed Disclaimers

This property is read-only.

Data Type

String

DutyType Property (DShippingSDK_UPSRates Class)

Auto duty type applicable for requests outside the US.

Object Oriented Interface

public function getDutyType();

Procedural Interface

dshippingsdk_upsrates_get($res, 12 );

Default Value

'Dutiable'

Remarks

The duty is automatically calculated in such requests if the Documents is set to False. This is returned in the server response only for requests outside the US.

The possible values to be returned:

All US domestic letters and documents are Non-Dutiable.

For non-documents the following logic applies:

• a. When export and import countries are the same, duty type is Non-Dutiable;
• b. All European transborder shipments (country pair must be found on DGTM TBL #462) are Non-Dutiable;
• c. If not found in step b, the duty type is assigned from the first value larger or equal to the converted customs declared value (order by declared value ascending) for that import country;
• If not found, default the duty type to Dutiable;

Note: When processing auto duty logic and for any reason the program experiences problems getting the duty type, the duty type will be defaulted to Dutiable. If the CurrencyCode is the same as the import currency code, there will be no currency conversion and the entered value will be used in the determination of the auto duty logic.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (DShippingSDK_UPSRates 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_upsrates_get($res, 13 );


dshippingsdk_upsrates_set($res, 13, $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_UPSRates Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 14 );


dshippingsdk_upsrates_set($res, 14, $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_UPSRates 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_upsrates_get($res, 15 );


dshippingsdk_upsrates_set($res, 15, $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_UPSRates 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_upsrates_get($res, 16 );


dshippingsdk_upsrates_set($res, 16, $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_UPSRates 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_upsrates_get($res, 17 );


dshippingsdk_upsrates_set($res, 17, $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_UPSRates 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_upsrates_get($res, 18 );


dshippingsdk_upsrates_set($res, 18, $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

PackageCount Property (DShippingSDK_UPSRates Class)

The number of records in the Package arrays.

Object Oriented Interface

public function getPackageCount();


public function setPackageCount($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 19 );


dshippingsdk_upsrates_set($res, 19, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageBaseCharge
• PackageCODAmount
• PackageCODType
• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageNetCharge
• PackageRatingAggregate
• PackageSignatureType
• PackageSpecialServices
• PackageTotalSurcharges
• PackageType
• PackageWeight
• PackageWidth

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

This property is not available at design time.

Data Type

Integer

PackageBaseCharge Property (DShippingSDK_UPSRates Class)

Actual Base Charge applicable to this package.

Object Oriented Interface

public function getPackageBaseCharge($packageidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 20 , $packageidx);

Default Value

''

Remarks

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the properties that store the rating information: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

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

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

Data Type

String

PackageCODAmount Property (DShippingSDK_UPSRates Class)

The COD monetary value for the package.

Object Oriented Interface

public function getPackageCODAmount($packageidx);


public function setPackageCODAmount($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 21 , $packageidx);


dshippingsdk_upsrates_set($res, 21, $value , $packageidx);

Default Value

''

Remarks

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in PackageCODLabel).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the PackageCODAmount is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the PackageCODType. COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackageType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by PackageSignatureType) and COD cannot coexist on a single package.

This property is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

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

This property is not available at design time.

Data Type

String

PackageCODType Property (DShippingSDK_UPSRates Class)

The code that indicates the type of funds that will be used for the COD payment for this package.

Object Oriented Interface

public function getPackageCODType($packageidx);


public function setPackageCODType($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 24 , $packageidx);


dshippingsdk_upsrates_set($res, 24, $value , $packageidx);

Default Value

0

Remarks

The code that indicates the type of funds that will be used for the COD payment for this package.

This property is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., PackageCODAmount is set to a value other than "0.00").

Valid values are:

Note: COD special service is not valid for return service movements.

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

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

This property is not available at design time.

Data Type

Integer

PackageHeight Property (DShippingSDK_UPSRates Class)

The height of the package to be shipped.

Object Oriented Interface

public function getPackageHeight($packageidx);


public function setPackageHeight($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 29 , $packageidx);


dshippingsdk_upsrates_set($res, 29, $value , $packageidx);

Default Value

0

Remarks

The height of the package to be shipped.

For FedEx, the PackageHeight is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageWidth are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set). For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

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

This property is not available at design time.

Data Type

Integer

PackageInsuredValue Property (DShippingSDK_UPSRates Class)

Amount of insurance requested for this package.

Object Oriented Interface

public function getPackageInsuredValue($packageidx);


public function setPackageInsuredValue($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 31 , $packageidx);


dshippingsdk_upsrates_set($res, 31, $value , $packageidx);

Default Value

''

Remarks

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

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

This property is not available at design time.

Data Type

String

PackageLength Property (DShippingSDK_UPSRates Class)

The length of the package to be shipped.

Object Oriented Interface

public function getPackageLength($packageidx);


public function setPackageLength($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 32 , $packageidx);


dshippingsdk_upsrates_set($res, 32, $value , $packageidx);

Default Value

0

Remarks

The length of the package to be shipped.

For FedEx, the PackageLength is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageWidth and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

Valid values are 0 to 108 IN and 0 to 270 CM.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, the PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern).

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

This property is not available at design time.

Data Type

Integer

PackageNetCharge Property (DShippingSDK_UPSRates Class)

Actual Net Charge applicable to this package.

Object Oriented Interface

public function getPackageNetCharge($packageidx);


public function setPackageNetCharge($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 33 , $packageidx);


dshippingsdk_upsrates_set($res, 33, $value , $packageidx);

Default Value

''

Remarks

Actual Net Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment.

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

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

This property is not available at design time.

Data Type

String

PackageType Property (DShippingSDK_UPSRates Class)

The packaging type of the package being rated and/or shipped.

Object Oriented Interface

public function getPackageType($packageidx);


public function setPackageType($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 34 , $packageidx);


dshippingsdk_upsrates_set($res, 34, $value , $packageidx);

Default Value

0

Remarks

The packaging type of the package being rated and/or shipped.

Possible values are:

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the PackagePackagingType for the first package is used in label requests.

If the PackagePackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: PackageLength, PackageWidth, and PackageHeight.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagePackagingType will be automatically set to 31 (Your Packaging).

Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States.

For UPS, please note that when selecting PackagePackagingType make sure this is valid for all the following: SenderCountryCode, RecipientCountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

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

This property is not available at design time.

Data Type

Integer

PackageRatingAggregate Property (DShippingSDK_UPSRates Class)

Rating aggregate applicable to this package.

Object Oriented Interface

public function getPackageRatingAggregate($packageidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 35 , $packageidx);

Default Value

''

Remarks

Rating aggregate applicable to this package.

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

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

Data Type

String

PackageSignatureType Property (DShippingSDK_UPSRates Class)

Specifies one of the Delivery Signature Options requested for this package.

Object Oriented Interface

public function getPackageSignatureType($packageidx);


public function setPackageSignatureType($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 42 , $packageidx);


dshippingsdk_upsrates_set($res, 42, $value , $packageidx);

Default Value

0

Remarks

Specifies one of the Delivery Signature Options requested for this package. Possible values are:

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

• Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
• Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
• Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
• Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the PackageSignatureType should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

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

This property is not available at design time.

Data Type

Integer

PackageSpecialServices Property (DShippingSDK_UPSRates Class)

Contains the collection of special services offered on the package level.

Object Oriented Interface

public function getPackageSpecialServices($packageidx);


public function setPackageSpecialServices($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 44 , $packageidx);


dshippingsdk_upsrates_set($res, 44, $value , $packageidx);

Default Value

0

Remarks

Contains the collection of special services offered on the package level. Valid values are:

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the PackageSpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below for FedEx:

• Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
• Dangerous Goods: Indicates that this package contains dangerous goods. When the PackageSpecialServices contains this flag, then the PackageDangerousGoodsAccessible is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
• Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
• Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
• Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
• COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the PackageCODAmount and PackageCODType must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the PackageSpecialServices of that package to a set of valid flags.

The meaning and limitations for each special service option are listed below:

• Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
• Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the PackageCODAmount and PackageCODType, PackageSignatureType, and PackageInsuredValue.

This property is not applicable to USPS or Canada Post.

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

This property is not available at design time.

Data Type

Long64

PackageTotalSurcharges Property (DShippingSDK_UPSRates Class)

Total Actual Surcharges applicable to this package.

Object Oriented Interface

public function getPackageTotalSurcharges($packageidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 46 , $packageidx);

Default Value

''

Remarks

Total Actual Surcharges applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

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

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

Data Type

String

PackageWeight Property (DShippingSDK_UPSRates Class)

Weight of this package.

Object Oriented Interface

public function getPackageWeight($packageidx);


public function setPackageWeight($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 48 , $packageidx);


dshippingsdk_upsrates_set($res, 48, $value , $packageidx);

Default Value

'0.0'

Remarks

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if PackagePackagingType is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the PackagePackagingType ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

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

This property is not available at design time.

Data Type

String

PackageWidth Property (DShippingSDK_UPSRates Class)

The width of the package to be shipped.

Object Oriented Interface

public function getPackageWidth($packageidx);


public function setPackageWidth($packageidx, $value);

Procedural Interface

dshippingsdk_upsrates_get($res, 49 , $packageidx);


dshippingsdk_upsrates_set($res, 49, $value , $packageidx);

Default Value

0

Remarks

The width of the package to be shipped.

For FedEx, the PackageWidth is optional, but recommended, if "Your Packaging" is used as PackagePackagingType. This is required if PackageLength and PackageHeight are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When PackageWidth is provided in the request, then all other dimensions (PackageLength and PackageHeight) are to be set as well.

For USPS, this is only required if the package is irregular and the PackagePackagingType property is set to ptNonRectangular. (In this case PackageWidth and PackageHeight must still be set).

Note: For parcels, PackageLength is the measurement of the longest dimension and PackageWidth and PackageHeight make up the other two dimensions. PackageGirth is the measurement around the thickest part of the package, perpendicular to the length.

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the PackageLength, PackageWidth, and PackageHeight are required for Priority Mail packages when the PackageSize is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

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

This property is not available at design time.

Data Type

Integer

PackageServiceIndex Property (DShippingSDK_UPSRates Class)

The service index in the list of available services returned.

Object Oriented Interface

public function getPackageServiceIndex();


public function setPackageServiceIndex($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 50 );


dshippingsdk_upsrates_set($res, 50, $value );

Default Value

0

Remarks

To retrieve all rating attributes on package level (PackageBaseCharge, PackageTotalSurcharges, PackageNetCharge, and PackageRatingAggregate) you must set the PackageServiceIndex from 0 to ServiceCount - 1 for each PackageIndex from 0 to PackageCount - 1.

Data Type

Integer

PickupType Property (DShippingSDK_UPSRates Class)

Pickup type used for the shipment that rate is requested for.

Object Oriented Interface

public function getPickupType();


public function setPickupType($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 51 );


dshippingsdk_upsrates_set($res, 51, $value );

Default Value

0

Remarks

The rates depend on the combination of PickupType and CustomerType.

Valid values are:

Data Type

Integer

ProxyAuthScheme Property (DShippingSDK_UPSRates 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_upsrates_get($res, 52 );


dshippingsdk_upsrates_set($res, 52, $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_UPSRates 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_upsrates_get($res, 53 );


dshippingsdk_upsrates_set($res, 53, $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_UPSRates 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_upsrates_get($res, 54 );


dshippingsdk_upsrates_set($res, 54, $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_UPSRates 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_upsrates_get($res, 55 );


dshippingsdk_upsrates_set($res, 55, $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_UPSRates 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_upsrates_get($res, 56 );


dshippingsdk_upsrates_set($res, 56, $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_UPSRates 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_upsrates_get($res, 57 );


dshippingsdk_upsrates_set($res, 57, $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_UPSRates Class)

This property contains a user name, if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 58 );


dshippingsdk_upsrates_set($res, 58, $value );

Default Value

''

Remarks

This property contains a user name, 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

RecipientAddress1 Property (DShippingSDK_UPSRates Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 59 );


dshippingsdk_upsrates_set($res, 59, $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_UPSRates 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_upsrates_get($res, 60 );


dshippingsdk_upsrates_set($res, 60, $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

RecipientAddressFlags Property (DShippingSDK_UPSRates Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getRecipientAddressFlags();


public function setRecipientAddressFlags($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 61 );


dshippingsdk_upsrates_set($res, 61, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (DShippingSDK_UPSRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 62 );


dshippingsdk_upsrates_set($res, 62, $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_UPSRates Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 63 );


dshippingsdk_upsrates_set($res, 63, $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_UPSRates Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 64 );


dshippingsdk_upsrates_set($res, 64, $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_UPSRates Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 65 );


dshippingsdk_upsrates_set($res, 65, $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

RecipientCandidateAggregate Property (DShippingSDK_UPSRates Class)

String representing the list of destination address candidates (if any).

Object Oriented Interface

public function getRecipientCandidateAggregate();

Procedural Interface

dshippingsdk_upsrates_get($res, 66 );

Default Value

''

Remarks

If the destination address provided in the time-in-transit request (when the GetShippingTime method is called) is an invalid address, a list of potential candidates for the destination address will be returned in the server response. This is applicable for US only.

This destination address candidate list will be stored as a string in RecipientCandidateAggregate, formatted as JSON.

To get the detailed information for each destination address candidate (city, state, zip code range), the UPSAddress class can be used. To read an address, set the Aggregate property of an UPSAddress class to this value, and read the values of the desired fields for each candidate from 0 to UPSAddress's MatchCount - 1 .

The returned candidate list will be ordered according to a level of confidence. The first candidate returned has the highest level of confidence based on the information provided in the request. You can choose the correct address and resubmit the Time-in-Transit request (by calling the GetShippingTime method again) using any of these candidates as the origin and/or destination addresses to get service specific values.

This property is read-only.

Data Type

String

RequestedService Property (DShippingSDK_UPSRates Class)

Service type for which the shipping rate is requested.

Object Oriented Interface

public function getRequestedService();


public function setRequestedService($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 67 );


dshippingsdk_upsrates_set($res, 67, $value );

Default Value

0

Remarks

This property is required to be entered in the request only if the rate request is made for a specific UPS service type. In this case, the RequestedService should be set to a value different from 'stUnspecified'.

Otherwise, the rate request will be considered by the UPS server as it has been made for all available services and respective rates to ship a package from the SenderAddress to RecipientAddress. The availability and the description of UPS services depend on the country of origin.

Valid values for UPS are:

Note: stUPSSaver (50) is a valid option for US domestic shipment, but only when sending to remote parts of Alaska or Hawaii Note: stUPSFirstClass (35), stUPSPriorityMail (36), stUPSExpeditedMailInnovations (37), stUPSPriorityMailInnovations (38), and stUPSEconomyMailInnovations (39) will not return any rates.

Data Type

Integer

SenderAddress1 Property (DShippingSDK_UPSRates Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 68 );


dshippingsdk_upsrates_set($res, 68, $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 SenderAddress1 should not exceed 35 characters.

Data Type

String

SenderAddress2 Property (DShippingSDK_UPSRates Class)

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

Object Oriented Interface

public function getSenderAddress2();


public function setSenderAddress2($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 69 );


dshippingsdk_upsrates_set($res, 69, $value );

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.

Data Type

String

SenderCity Property (DShippingSDK_UPSRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 71 );


dshippingsdk_upsrates_set($res, 71, $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

SenderCountryCode Property (DShippingSDK_UPSRates Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();


public function setSenderCountryCode($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 72 );


dshippingsdk_upsrates_set($res, 72, $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

SenderState Property (DShippingSDK_UPSRates Class)

State or province code.

Object Oriented Interface

public function getSenderState();


public function setSenderState($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 73 );


dshippingsdk_upsrates_set($res, 73, $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

SenderZipCode Property (DShippingSDK_UPSRates Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 74 );


dshippingsdk_upsrates_set($res, 74, $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 SenderCity and SenderState are not present.

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

Data Type

String

SenderCandidateAggregate Property (DShippingSDK_UPSRates Class)

String representing the list of origin address candidates (if any).

Object Oriented Interface

public function getSenderCandidateAggregate();

Procedural Interface

dshippingsdk_upsrates_get($res, 75 );

Default Value

''

Remarks

If the origin address provided in the time-in-transit request (when the GetShippingTime method is called) is an invalid address, a list of potential candidates for the origin address will be returned in the server response. This is applicable for US only.

This origin address candidate list will be stored as a string in SenderCandidateAggregate, formatted as JSON.

To get the detailed information for each origin address candidate (city, state, zip code range), the UPSAddress class can be used. To read an address, set the Aggregate property of an UPSAddress class to this value, and read the values of the desired fields for each candidate from 0 to UPSAddress's MatchCount - 1 .

The returned candidate list will be ordered according to a level of confidence. The first candidate returned has the highest level of confidence based on the information provided in the request. You can choose the correct address and resubmit the Time-in-Transit request (by calling the GetShippingTime method again) using any of these candidates as the origin and/or destination addresses to get service specific values.

This property is read-only.

Data Type

String

ServiceCount Property (DShippingSDK_UPSRates Class)

The number of records in the Service arrays.

Object Oriented Interface

public function getServiceCount();

Procedural Interface

dshippingsdk_upsrates_get($res, 76 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServiceAccountNetCharge
• ServiceAggregate
• ServiceBusinessDays
• ServiceCustomerCenterCutoff
• ServiceDelayDays
• ServiceDeliveryDate
• ServiceDeliveryDay
• ServiceDeliveryTime
• ServiceGuaranteedDescription
• ServiceHolidays
• ServiceListBaseCharge
• ServiceListNetCharge
• ServiceListTotalSurcharge
• ServiceRestDays
• ServiceShipDate
• ServiceShipTime
• ServiceTransitTime
• ServiceType
• ServiceTypeDescription

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

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

Data Type

Integer

ServiceAccountNetCharge Property (DShippingSDK_UPSRates Class)

Net charge amount applied to a ServiceType .

Object Oriented Interface

public function getServiceAccountNetCharge($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 78 , $serviceidx);

Default Value

''

Remarks

Net charge amount applied to a ServiceType.

For FedEx, this is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountNetCharge will be filled with the value of discounted net charge amount specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For UPS, this is the value of grand total charges for account based rating applied to a shipment when using the returned ServiceType

The UPS server response will contain negotiated rate(s) only for the qualified UPSAccountNumbers. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

This property is not used by the USPS class.

For Canada Post, this field will contain the total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.

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

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

Data Type

String

ServiceAggregate Property (DShippingSDK_UPSRates Class)

Aggregate of details and rates for the ServiceType in the list of available services.

Object Oriented Interface

public function getServiceAggregate($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 81 , $serviceidx);

Default Value

''

Remarks

Aggregate of details and rates for the ServiceType in the list of available services.

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

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

Data Type

String

ServiceBusinessDays Property (DShippingSDK_UPSRates Class)

Number of business days from origin to destination location.

Object Oriented Interface

public function getServiceBusinessDays($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 82 , $serviceidx);

Default Value

0

Remarks

Number of business days from origin to destination location. This is valid only for UPS and is returned for the number of UPS business days (Monday, Tuesday, Wednesday, Thursday, Friday and Saturday) the shipment will take to travel from one location to another.

If applicable, this property is filled after a call to the GetShippingTime.

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

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

Data Type

Integer

ServiceCustomerCenterCutoff Property (DShippingSDK_UPSRates Class)

Time the UPS Customer Service Center closes.

Object Oriented Interface

public function getServiceCustomerCenterCutoff($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 84 , $serviceidx);

Default Value

''

Remarks

Time the UPS Customer Service Center closes.

This value is only relevant for UPS and it provides the user with the time the Customer Service Center closes. This is applicable for shipments outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

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

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

Data Type

String

ServiceDelayDays Property (DShippingSDK_UPSRates Class)

Number of days the shipment is delayed in customs.

Object Oriented Interface

public function getServiceDelayDays($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 85 , $serviceidx);

Default Value

0

Remarks

Number of days the shipment is delayed in customs. This is only valid for UPS requests, and is returned for requests outside the US only and when the request indicates the query is in reference to a Non-Document type of shipment.

If applicable, this property is filled after a call to the GetShippingTime.

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

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

Data Type

Integer

ServiceDeliveryDate Property (DShippingSDK_UPSRates Class)

This indicates the shipment delivery date for the ServiceType .

Object Oriented Interface

public function getServiceDeliveryDate($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 86 , $serviceidx);

Default Value

''

Remarks

This indicates the shipment delivery date for the ServiceType.

In regards to International services, the delivery date availability is limited to some postal-code supported countries. The delivery date will be returned if available. Format: YYYY-MM-DD.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

For Canada Post, this field will be populated after a GetRates call and will contain the estimated date of delivery, starting from the expected mailing-date.

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

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

Data Type

String

ServiceDeliveryDay Property (DShippingSDK_UPSRates Class)

Indicates the day of the week the shipment can be delivered when using the ServiceType .

Object Oriented Interface

public function getServiceDeliveryDay($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 87 , $serviceidx);

Default Value

''

Remarks

Indicates the day of the week the shipment can be delivered when using the ServiceType. Possible values are: SUN, MON, TUE, WED, THU, FRI, SAT. In regards to International services, the delivery date availability is limited to some postal-code supported countries and it will be returned if available.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

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

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

Data Type

String

ServiceDeliveryTime Property (DShippingSDK_UPSRates Class)

Scheduled local delivery time.

Object Oriented Interface

public function getServiceDeliveryTime($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 88 , $serviceidx);

Default Value

''

Remarks

Scheduled local delivery time. This is available only for UPS, and indicates the latest time of day the shipment will be delivered as guaranteed by UPS. Format: HH:MM:SS.

If applicable, this property is filled after a call to the GetShippingTime.

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

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

Data Type

String

ServiceGuaranteedDescription Property (DShippingSDK_UPSRates Class)

Textual description of a guaranteed delivery for a UPS service type in the list of available services returned.

Object Oriented Interface

public function getServiceGuaranteedDescription($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 90 , $serviceidx);

Default Value

''

Remarks

Textual description of a guaranteed delivery for a UPS service type in the list of available services returned. This is populated when the GetShippingTime method is called for UPS only.

This method is also populated for Canada Post after the GetRates method is called. The returned value will either be "true" or "false" to indicate whether the delivery date is guaranteed.

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

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

Data Type

String

ServiceHolidays Property (DShippingSDK_UPSRates Class)

Number of national holidays during transit.

Object Oriented Interface

public function getServiceHolidays($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 91 , $serviceidx);

Default Value

0

Remarks

Number of national holidays during transit. This is returned only for UPS when the shipment would be in transit during a national holiday. Holidays outside the US are taken into account. Returned for requests outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

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

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

Data Type

Integer

ServiceListBaseCharge Property (DShippingSDK_UPSRates Class)

Transportation charges before surcharges and discounts applied to a ServiceType .

Object Oriented Interface

public function getServiceListBaseCharge($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 95 , $serviceidx);

Default Value

''

Remarks

Transportation charges before surcharges and discounts applied to a ServiceType. After calling the GetRates method, the ServiceListBaseCharge will be filled with the value of base charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This does not apply to USPS.

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

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

Data Type

String

ServiceListNetCharge Property (DShippingSDK_UPSRates Class)

Net charge amount applied to a ServiceType .

Object Oriented Interface

public function getServiceListNetCharge($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 96 , $serviceidx);

Default Value

''

Remarks

Net charge amount applied to a ServiceType.

After calling the GetRates method, the ServiceListNetCharge will be filled with the value of list net charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

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

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

Data Type

String

ServiceListTotalSurcharge Property (DShippingSDK_UPSRates Class)

Total surcharge amount for all additional services applied to a ServiceType .

Object Oriented Interface

public function getServiceListTotalSurcharge($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 98 , $serviceidx);

Default Value

''

Remarks

Total surcharge amount for all additional services applied to a ServiceType.

After calling the GetRates method, the ServiceListTotalSurcharge will be filled with the value of total surcharges applied.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This value does not apply to USPS.

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

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

Data Type

String

ServiceRestDays Property (DShippingSDK_UPSRates Class)

Number of days the shipment is in rest due to non-business days.

Object Oriented Interface

public function getServiceRestDays($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 104 , $serviceidx);

Default Value

0

Remarks

Number of days the shipment is in rest due to non-business days. Returned for UPS requests outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

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

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

Data Type

Integer

ServiceType Property (DShippingSDK_UPSRates Class)

Indicates the service type in the list of available services returned.

Object Oriented Interface

public function getServiceType($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 105 , $serviceidx);

Default Value

0

Remarks

Indicates the service type in the list of available services returned.

This is populated when the GetShippingTime or GetRates methods are called.

Valid values for FedEx are:

Valid values for UPS are:

Note: stUPSSaver (50) is a valid option for US domestic shipment, but only when sending to remote parts of Alaska or Hawaii Note: stUPSFirstClass (35), stUPSPriorityMail (36), stUPSExpeditedMailInnovations (37), stUPSPriorityMailInnovations (38), and stUPSEconomyMailInnovations (39) will not return any rates.

Valid values for USPS are:

Please note that the RequestedService stUSPSBPM (74) is no longer supported by Endicia.

Valid values for Canada Post are:

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

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

Data Type

Integer

ServiceTypeDescription Property (DShippingSDK_UPSRates Class)

Indicates the textual description of a service type in the list of available services returned.

Object Oriented Interface

public function getServiceTypeDescription($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 106 , $serviceidx);

Default Value

''

Remarks

Indicates the textual description of a service type in the list of available services returned.

Possible returned values for FedEx are:

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

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

Data Type

String

ServiceShipDate Property (DShippingSDK_UPSRates Class)

Date UPS picks up the package from the origin.

Object Oriented Interface

public function getServiceShipDate($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 107 , $serviceidx);

Default Value

''

Remarks

Date UPS picks up the package from the origin. In the event the ServiceShipDate differs from the ShipDate provided in the request, a warning message will be returned.

This is only applicable to UPS GetShippingTime.

Format: YYYY-MM-DD.

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

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

Data Type

String

ServiceShipTime Property (DShippingSDK_UPSRates Class)

Time UPS picks up the package from the origin.

Object Oriented Interface

public function getServiceShipTime($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 108 , $serviceidx);

Default Value

''

Remarks

Time UPS picks up the package from the origin. It is returned for requests outside the US. If applicable, this property is filled after a call to the GetShippingTime.

This is only applicable to UPS GetShippingTime.

Format: HH:MM:SS

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

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

Data Type

String

ServiceTransitTime Property (DShippingSDK_UPSRates Class)

Expected number of days in transit from pickup to delivery for the ServiceType .

Object Oriented Interface

public function getServiceTransitTime($serviceidx);

Procedural Interface

dshippingsdk_upsrates_get($res, 110 , $serviceidx);

Default Value

''

Remarks

Expected number of days in transit from pickup to delivery for the ServiceType. This is an estimate only and depends on the customs clearance times. It is optional to be returned in the server reply.

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

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

Data Type

String

ShipDate Property (DShippingSDK_UPSRates Class)

The date the user requests UPS to pickup the package from the origin.

Object Oriented Interface

public function getShipDate();


public function setShipDate($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 111 );


dshippingsdk_upsrates_set($res, 111, $value );

Default Value

''

Remarks

This is required to be provided when GetShippingTime method is called. Query cannot exceed 60 days into the future.

This should be entered in this format: YYYYMMDD.

Data Type

String

ShipmentSpecialServices Property (DShippingSDK_UPSRates Class)

Contains the collection of special services offered by UPS on shipment level.

Object Oriented Interface

public function getShipmentSpecialServices();


public function setShipmentSpecialServices($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 112 );


dshippingsdk_upsrates_set($res, 112, $value );

Default Value

0

Remarks

To request any of the special services offered by UPS in a request, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

The meaning and limitations for each special service option are listed below:

• Hold for Pickup: This indicates that UPS should deliver your package to the UPS Customer Center you choose and then call the recipient when the package is ready.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Liftgate Dropoff: This requests that UPs provide their liftgate services unload a shipment when unloading docks are not available.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Liftgate Pickup: This requests that UPs provide their liftgate services load a shipment when loading docks are not available.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Return Shipment: This is applicable to return shipments only. Indicates that the ship request is made for Print Return Label (PRL). With this option you can print a return label to include in an outbound shipment, or provide a label to your customer separately.

  If you want to arrange for UPS to mail a return label to your customer, you can use the ReturnPrintAndMail config setting.

  If you want to arrange for UPS to email a return label to your customer, you can use the ElectronicReturnLabel config setting.

  If you want to arrange for UPS to make one attempt to pick up the package to be returned, you can use the ReturnServiceFirstAttempt config setting.

  If you want to arrange for UPS to make three attempts to pick up the package to be returned, you can use the ReturnServiceThirdAttempt config setting.

  Using the last 4 options: in the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.

  For return shipments, one of the following conditions must be met on AccountCountryCode, SenderCountryCode and RecipientCountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The PackageDescription is required to be provided in the request for each package contained in the shipment. The PackageType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only.

  Also please note that when you set this option that only the return label is being printed, you must submit a separate request to print the shipping label.

• Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is not available for return shipments.
• Saturday Pickup: The presence indicates Saturdary pickup is requested. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair.
• Return of Document: This may also be referred to as the Return of Invoice service and is unique to Poland. If set UPS will use their Return of Document service to return the signed invoice to the shipper.
• Commercial Invoice Removal: When set this will indicate that the commercial invoice should be removed before delivery, thus not revealing the value of the contents to the recipient.
• Carbon Neutral: This is required to make a shipment that is carbon neutral.
• Exchange Forward: This is required in order to make exchange forward shipments.
• Dropoff at UPS Facility: When set this indicates that the package will be dropped off at a UPS Facility.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Deliver To Addressee Only: When set this requires that the addressee be the one who takes final delivery of the package being held at a UPS Access Point

  This accessorial is only valid when ShipmentIndicationType is set to 1.

• Direct Delivery Only: When set this will ensure that the package is delivered to the ShipTo address on the shipping label.

  This accessorial is not valid when ShipmentIndicationType is set.

Data Type

Long64

SSLAcceptServerCertEncoded Property (DShippingSDK_UPSRates Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 114 );


dshippingsdk_upsrates_set($res, 114, $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_UPSRates Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 142 );


dshippingsdk_upsrates_set($res, 142, $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_UPSRates 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_upsrates_get($res, 158 );


dshippingsdk_upsrates_set($res, 158, $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 are designations of 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. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_UPSRates 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_upsrates_get($res, 159 );


dshippingsdk_upsrates_set($res, 159, $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_UPSRates Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 160 );


dshippingsdk_upsrates_set($res, 160, $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_UPSRates 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_upsrates_get($res, 161 );


dshippingsdk_upsrates_set($res, 161, $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 displayed below.

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

Data Type

String

SSLProvider Property (DShippingSDK_UPSRates Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 169 );


dshippingsdk_upsrates_set($res, 169, $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:

Additional Notes

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_UPSRates Class)

This is the certificate (PEM/base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_upsrates_get($res, 171 );

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_UPSRates Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 198 );


dshippingsdk_upsrates_set($res, 198, $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

TotalValue Property (DShippingSDK_UPSRates Class)

Monetary value of shipment contents.

Object Oriented Interface

public function getTotalValue();


public function setTotalValue($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 199 );


dshippingsdk_upsrates_set($res, 199, $value );

Default Value

'0.00'

Remarks

Required for all non-document shipments outside the US. Required for Document shipments (when Documents is set to True) only when either the SenderCountryCode or RecipientCountryCode is CA (Canada).

This is returned in the server response only if provided in the request.

Cannot exceed more than 9 whole numbers and 2 decimal places. Maximum value is: 999999999.99.

Data Type

String

TotalWeight Property (DShippingSDK_UPSRates Class)

Total shipment's weight.

Object Oriented Interface

public function getTotalWeight();


public function setTotalWeight($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 200 );


dshippingsdk_upsrates_set($res, 200, $value );

Default Value

'1.0'

Remarks

This indicates shipment's weight. Required for shipments outside the US and non-document shipments inside the US. It will be returned in the server response only if provided in the request.

Allows for only one decimal point and one decimal place. It cannot exceed: 150 LBS, 65 KGS for Canada, 70 KGS for the rest of the world.

Data Type

String

UPSAccountNumber Property (DShippingSDK_UPSRates Class)

The shipper's UPS account number.

Object Oriented Interface

public function getUPSAccountNumber();


public function setUPSAccountNumber($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 201 );


dshippingsdk_upsrates_set($res, 201, $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_UPSRates Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getUPSAuthorizationToken();


public function setUPSAuthorizationToken($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 202 );


dshippingsdk_upsrates_set($res, 202, $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_UPSRates Class)

URL for the UPS server where the requests are sent.

Object Oriented Interface

public function getUPSServer();


public function setUPSServer($value);

Procedural Interface

dshippingsdk_upsrates_get($res, 203 );


dshippingsdk_upsrates_set($res, 203, $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 componernt will send the requests to the preset production end-point. You can utilize the TestMode Config to switch from production to testing.

The following URLs may be used for testing:

Data Type

String

Config Method (DShippingSDK_UPSRates Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

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

GetRates Method (DShippingSDK_UPSRates Class)

Returns rate information for a specified or all available UPS RequestedService s.

Object Oriented Interface

public function doGetRates();

Procedural Interface

dshippingsdk_upsrates_do_getrates($res);

Remarks

To get the courtesy rate quotes for UPS services, you can call the GetRates method. If rates are needed for a specific service type, you will have to set the RequestedService to the value you need the rates for (other than 0 : stUnspecified). The RequestedService identifies the UPS service for which you want to retrieve rate information.

If the rates are wanted for all available UPS services, you should set the RequestedService to 0 (stUnspecified). Following validation, the UPSRates identifies and rates all available services. The server response will include a list of services, their associated rate, and guaranteed delivery time, if available.

In either case, the following properties or config settings are sent in the request (if any of these have not been set, their default values will be used instead):

• UPSServer (required)
• UPSAuthorizationToken (required)
• UPSAccountNumber (required only when requesting to receive negotiated rates; otherwise optional)
• RequestedService (required)
• PickupType (required)
• CustomerType (required)
• SenderAddress(required)
• RecipientAddress (required)
• Packages (required)
• WeightUnit (optional)
• CurrencyCode (optional)

Returned values upon a successful reply are:

• Services

If there is a problem with any of the input values within the request, the response will either raise an error (when it's an hard error) and transaction will fail, or give a warning (when it's a soft error), which can be accessed via Warning, and the transaction will go through.

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

GetShippingTime Method (DShippingSDK_UPSRates Class)

Provides the average estimated time to ship a package from an origin to a destination address.

Object Oriented Interface

public function doGetShippingTime();

Procedural Interface

dshippingsdk_upsrates_do_getshippingtime($res);

Remarks

This method call issues a Time in Transit request to the UPS Server and parses the response.

The following can be set when this method is called:

• SenderAddress (required: the SenderCity is required for requests outside the US if the SenderZipCode is not used in the origin country; the SenderState is optional; the SenderCountryCode is required; the SenderZipCode is required if the SenderCountryCode supports postal code system. If not provided, a candidate list will be returned for the user to enter a valid Postal Code for the specified SenderCity.
• RecipientAddress (required: the RecipientCity is required for requests outside the US if the RecipientZipCode is not used in the destination country; the RecipientState is optional; the RecipientCountryCode is required; the RecipientZipCode is required if the RecipientCountryCode supports postal code system. If not provided, a candidate list will be returned for the user to enter a valid Postal Code for the specified RecipientCity.
• SenderTown is optional, applicable to non-US addresses, and used to make the origin address more precise;
• RecipientTown is optional, applicable to non-US addresses, and used to make the destination address more precise;
• ShipDate (required)
• TotalWeight (conditional)
• WeightUnit (conditional - applicable when the TotalWeight is provided in the request)
• Documents (optional)
• TotalValue (conditional - required for Document shipments when the origin or destination is Canada or non-document shipments outside the US)
• CurrencyCode (conditional - applicable when the TotalValue is provided in the request)

The minimum information returned in the response include a summary of the user's input as well as:

• Disclaimer (when applicable)
• SenderCountryName
• RecipientCountryName

If the SenderAddress and RecipientAddress addresses provided in the request are found in UPS system exactly as entered, then the Services is filled upon server's response.

Otherwise, if those do not match any data located in UPS system, then the server returns a list of candidates for the origin and/or destination addresses, which will be stored as strings (formatted as JSON) in SenderCandidateAggregate (for origin) and RecipientCandidateAggregate (for destination).

To read an address, set the Aggregate property of an UPSAddress class to this value, and read the values of the desired fields for each candidate from 0 to UPSAddress's MatchCount - 1 .

The returned candidate list will be ordered according to a level of confidence. The first candidate returned has the highest level of confidence based on the information provided in the request. You can choose the correct address and resubmit the Time-in-Transit request (by calling the GetShippingTime method again) using any of these candidates as the origin and/or destination addresses to get service specific values. You can then resubmit the Time-in-Transit request using any of these candidates as the origin and/or destination addresses (when calling the GetShippingTime method).

So, after submitting the request, you will either receive a successful response containing time-in-transit information (as described above), or an error if error conditions were found.

Reset Method (DShippingSDK_UPSRates Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_upsrates_do_reset($res);

Remarks

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

Error Event (DShippingSDK_UPSRates Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_upsrates_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_UPSRates Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_upsrates_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_UPSRates Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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_UPSRates Class)

Shows the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

Config Settings (UPSRates Class)

The class accepts one or more of the following configuration settings. Configuration 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.

UPSRates Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (UPSRates Class)

UPSRates Errors

	301   Operation interrupted (or timeout).
	432   Invalid index.
	527   Server Error Response.
	528   Property set with invalid data.
	560   Missing data.

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