EzRates Class

Properties   Methods   Events   Config Settings   Errors  

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

Class Name

DShippingSDK_EzRates

Procedural Interface

 dshippingsdk_ezrates_open();
 dshippingsdk_ezrates_close($res);
 dshippingsdk_ezrates_register_callback($res, $id, $function);
 dshippingsdk_ezrates_get_last_error($res);
 dshippingsdk_ezrates_get_last_error_code($res);
 dshippingsdk_ezrates_set($res, $id, $index, $value);
 dshippingsdk_ezrates_get($res, $id, $index);
 dshippingsdk_ezrates_do_config($res, $configurationstring);
 dshippingsdk_ezrates_do_getrates($res);
 dshippingsdk_ezrates_do_reset($res);

Remarks

The EzRates class provides a standardized interface to all 3 supported carriers. This allows you to reduce the code needed to create an application supporting multiple carriers. For more fine grained control over settings specific to individual carriers you may wish to use the class that is specific to the carrier.

When providing origin, destination information, weight, and service, this class allows a user to obtain a rate quote for a specific service, or a list of available services with the respective rate quotes.

You can send a rate request by calling the GetRates method for:

• a specific service (when RequestedService is specified). In this case, the class will return rates for packages based on a combination of origin, destination, service type, weight, and package type. This also checks if the requested service is available, checks your origin/destination pair and ship date to determine whether the service you requested is a valid service type.
• all available services (when RequestedService is set to UNSPECIFIED, which is the default value) and a specified destination.

When requesting a rate quote, include as much detail as possible about your shipment. This information is important for calculating the correct shipping costs with surcharges.

Rating for a Multiple Package Shipment (MPS) is available for FedEx and UPS, but not USPS.

Please note that all rate quotes are estimates only and may differ from the actual invoiced amount.

To use this class, you must set the appropriate Account settings for the specified Provider.

Canada Post Setup and Required Properties

When retrieving rates via Canada Post, the following fields are required:

You can optionally set the following fields when requesting rates:

Note: Rates will only be retrieved for the first package within Packages, as multiple package shipments are not supported.

After a successful GetRates call, the following fields will be populated:

Note: Contract based rate quotes are also supported by setting CanadaContractId to your Canada Post Contract ID prior to calling GetRates.

The Canada Post URLS are:

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.

AccountNumber Property (DShippingSDK_EzRates Class)

The shipper's account number.

Object Oriented Interface

public function getAccountNumber();


public function setAccountNumber($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 1 );


dshippingsdk_ezrates_set($res, 1, $value );

Default Value

''

Remarks

The shipper's account number.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

Data Type

String

AuthorizationToken Property (DShippingSDK_EzRates Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getAuthorizationToken();


public function setAuthorizationToken($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 2 );


dshippingsdk_ezrates_set($res, 2, $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

Password Property (DShippingSDK_EzRates Class)

Password for logging in to the Server .

Object Oriented Interface

public function getPassword();


public function setPassword($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 3 );


dshippingsdk_ezrates_set($res, 3, $value );

Default Value

''

Remarks

Password for logging in to the Server.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

For Canada Post, this field should be set to the login password for your Canada Post account.

Data Type

String

Server Property (DShippingSDK_EzRates Class)

URL for the server where the requests are sent.

Object Oriented Interface

public function getServer();


public function setServer($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 4 );


dshippingsdk_ezrates_set($res, 4, $value );

Default Value

''

Remarks

URL for the server where the requests are sent.

See FedExAccount, UPSAccount, and USPSAccount for a better description of the different protocol requirements.

Data Type

String

UserId Property (DShippingSDK_EzRates Class)

User Id for logging in to the Server .

Object Oriented Interface

public function getUserId();


public function setUserId($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 5 );


dshippingsdk_ezrates_set($res, 5, $value );

Default Value

''

Remarks

User Id for logging in to the Server.

This property is not used by FedEx.

For Canada Post, this field should be set to the login username for your Canada Post account

Data Type

String

FirewallAutoDetect Property (DShippingSDK_EzRates 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_ezrates_get($res, 6 );


dshippingsdk_ezrates_set($res, 6, $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_EzRates Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 7 );


dshippingsdk_ezrates_set($res, 7, $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_EzRates 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_ezrates_get($res, 8 );


dshippingsdk_ezrates_set($res, 8, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a Host 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_EzRates 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_ezrates_get($res, 9 );


dshippingsdk_ezrates_set($res, 9, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password 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_EzRates 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_ezrates_get($res, 10 );


dshippingsdk_ezrates_set($res, 10, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall Host. See the description of the Host 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_EzRates 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_ezrates_get($res, 11 );


dshippingsdk_ezrates_set($res, 11, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this property and Password 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_EzRates Class)

The number of records in the Package arrays.

Object Oriented Interface

public function getPackageCount();


public function setPackageCount($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 12 );


dshippingsdk_ezrates_set($res, 12, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageGirth
• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageSignatureType
• PackageSize
• 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

PackageGirth Property (DShippingSDK_EzRates Class)

Measurement around the widest part of the package, perpendicular to the Length .

Object Oriented Interface

public function getPackageGirth($packageidx);


public function setPackageGirth($packageidx, $value);

Procedural Interface

dshippingsdk_ezrates_get($res, 21 , $packageidx);


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

Default Value

0

Remarks

Measurement around the widest part of the package, perpendicular to the PackageLength.

This property is only applicable when requesting rates for USPS packages.

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. It 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).

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.

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

The height of the package to be shipped.

Object Oriented Interface

public function getPackageHeight($packageidx);


public function setPackageHeight($packageidx, $value);

Procedural Interface

dshippingsdk_ezrates_get($res, 22 , $packageidx);


dshippingsdk_ezrates_set($res, 22, $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_EzRates Class)

Amount of insurance requested for this package.

Object Oriented Interface

public function getPackageInsuredValue($packageidx);


public function setPackageInsuredValue($packageidx, $value);

Procedural Interface

dshippingsdk_ezrates_get($res, 24 , $packageidx);


dshippingsdk_ezrates_set($res, 24, $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_EzRates Class)

The length of the package to be shipped.

Object Oriented Interface

public function getPackageLength($packageidx);


public function setPackageLength($packageidx, $value);

Procedural Interface

dshippingsdk_ezrates_get($res, 25 , $packageidx);


dshippingsdk_ezrates_set($res, 25, $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

PackageType Property (DShippingSDK_EzRates 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_ezrates_get($res, 27 , $packageidx);


dshippingsdk_ezrates_set($res, 27, $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

PackageSignatureType Property (DShippingSDK_EzRates 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_ezrates_get($res, 35 , $packageidx);


dshippingsdk_ezrates_set($res, 35, $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

PackageSize Property (DShippingSDK_EzRates Class)

Size of the package being mailed.

Object Oriented Interface

public function getPackageSize($packageidx);


public function setPackageSize($packageidx, $value);

Procedural Interface

dshippingsdk_ezrates_get($res, 36 , $packageidx);


dshippingsdk_ezrates_set($res, 36, $value , $packageidx);

Default Value

0

Remarks

Size of the package being mailed.

This property is only used by USPS and is required for the GetRates method call.

See below for valid entries:

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (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: Use the PackageLength, PackageHeight, PackageWidth and optionally PackageGirth (irregular shaped packages only) properties to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

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

PackageWeight Property (DShippingSDK_EzRates Class)

Weight of this package.

Object Oriented Interface

public function getPackageWeight($packageidx);


public function setPackageWeight($packageidx, $value);

Procedural Interface

dshippingsdk_ezrates_get($res, 41 , $packageidx);


dshippingsdk_ezrates_set($res, 41, $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_EzRates Class)

The width of the package to be shipped.

Object Oriented Interface

public function getPackageWidth($packageidx);


public function setPackageWidth($packageidx, $value);

Procedural Interface

dshippingsdk_ezrates_get($res, 42 , $packageidx);


dshippingsdk_ezrates_set($res, 42, $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

Provider Property (DShippingSDK_EzRates Class)

Which provider to use.

Object Oriented Interface

public function getProvider();


public function setProvider($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 43 );


dshippingsdk_ezrates_set($res, 43, $value );

Default Value

0

Remarks

The "Ez" classs support FedEx, UPS, USPS, and Canada Post servers. This property tells the class which protocol to use.

NOTE: When this property is set, all properties of the class will be reset to their default values.

Data Type

Integer

ProxyAuthScheme Property (DShippingSDK_EzRates 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_ezrates_get($res, 44 );


dshippingsdk_ezrates_set($res, 44, $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 User and Password properties are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password properties are set, the component will attempt basic authentication.

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

If AuthScheme 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 AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of User and Password.

Data Type

Integer

ProxyAutoDetect Property (DShippingSDK_EzRates 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_ezrates_get($res, 45 );


dshippingsdk_ezrates_set($res, 45, $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_EzRates 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_ezrates_get($res, 46 );


dshippingsdk_ezrates_set($res, 46, $value );

Default Value

''

Remarks

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

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

If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (DShippingSDK_EzRates 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_ezrates_get($res, 47 );


dshippingsdk_ezrates_set($res, 47, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DShippingSDK_EzRates 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_ezrates_get($res, 48 );


dshippingsdk_ezrates_set($res, 48, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DShippingSDK_EzRates 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_ezrates_get($res, 49 );


dshippingsdk_ezrates_set($res, 49, $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_EzRates Class)

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

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 50 );


dshippingsdk_ezrates_set($res, 50, $value );

Default Value

''

Remarks

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

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

If AuthScheme is set to Digest Authentication, the User and Password properties are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password properties are used to authenticate through NTLM negotiation.

Data Type

String

RateType Property (DShippingSDK_EzRates Class)

Indicates the type of rates to be returned.

Object Oriented Interface

public function getRateType();


public function setRateType($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 51 );


dshippingsdk_ezrates_set($res, 51, $value );

Default Value

1

Remarks

Possible values are listed below (specified in hexadecimal notation). They can be or-ed together to include multiple options:

Note: b>This property is only applicable to FedEx.

Data Type

Integer

RecipientAddress1 Property (DShippingSDK_EzRates Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 52 );


dshippingsdk_ezrates_set($res, 52, $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_EzRates 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_ezrates_get($res, 53 );


dshippingsdk_ezrates_set($res, 53, $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_EzRates Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getRecipientAddressFlags();


public function setRecipientAddressFlags($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 54 );


dshippingsdk_ezrates_set($res, 54, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (DShippingSDK_EzRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 55 );


dshippingsdk_ezrates_set($res, 55, $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_EzRates Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 56 );


dshippingsdk_ezrates_set($res, 56, $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_EzRates Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 57 );


dshippingsdk_ezrates_set($res, 57, $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_EzRates Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 58 );


dshippingsdk_ezrates_set($res, 58, $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

RequestedService Property (DShippingSDK_EzRates Class)

Service type for which the shipping rate is requested.

Object Oriented Interface

public function getRequestedService();


public function setRequestedService($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 59 );


dshippingsdk_ezrates_set($res, 59, $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 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 server as it has been made for all available services and respective rates.

Valid values for FedEx are:

Valid values for UPS are:

Valid values for USPS are:

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

Data Type

Integer

SenderAddress1 Property (DShippingSDK_EzRates Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 60 );


dshippingsdk_ezrates_set($res, 60, $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_EzRates 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_ezrates_get($res, 61 );


dshippingsdk_ezrates_set($res, 61, $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

SenderAddressFlags Property (DShippingSDK_EzRates Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getSenderAddressFlags();


public function setSenderAddressFlags($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 62 );


dshippingsdk_ezrates_set($res, 62, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

SenderCity Property (DShippingSDK_EzRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 63 );


dshippingsdk_ezrates_set($res, 63, $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_EzRates Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();


public function setSenderCountryCode($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 64 );


dshippingsdk_ezrates_set($res, 64, $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_EzRates Class)

State or province code.

Object Oriented Interface

public function getSenderState();


public function setSenderState($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 65 );


dshippingsdk_ezrates_set($res, 65, $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_EzRates Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 66 );


dshippingsdk_ezrates_set($res, 66, $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

ServiceCount Property (DShippingSDK_EzRates Class)

The number of records in the Service arrays.

Object Oriented Interface

public function getServiceCount();

Procedural Interface

dshippingsdk_ezrates_get($res, 67 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServiceAccountBaseCharge
• ServiceAccountNetCharge
• ServiceAccountTotalDiscount
• ServiceAccountTotalSurcharge
• ServiceAggregate
• ServiceBusinessDays
• ServiceCommitments
• ServiceCustomerCenterCutoff
• ServiceDeliveryDate
• ServiceEffectiveNetDiscount
• ServiceListBaseCharge
• ServiceListNetCharge
• ServiceListTotalDiscount
• ServiceListTotalSurcharge
• ServiceMaxDimensions
• ServiceMaxWeight
• ServiceRateScale
• ServiceRateZone
• ServiceShipTime
• ServiceSignatureType
• 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

ServiceAccountBaseCharge Property (DShippingSDK_EzRates Class)

Transportation charges before surcharges and discounts applied to a ServiceType .

Object Oriented Interface

public function getServiceAccountBaseCharge($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 68 , $serviceidx);

Default Value

''

Remarks

Transportation charges before surcharges and discounts applied to a ServiceType. This applies to FedEx only and is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountBaseCharge will be filled with the value of discounted base charge amount specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the base cost of the shipment before taxes (numeric 99999.99).

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

ServiceAccountNetCharge Property (DShippingSDK_EzRates Class)

Net charge amount applied to a ServiceType .

Object Oriented Interface

public function getServiceAccountNetCharge($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 69 , $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

ServiceAccountTotalDiscount Property (DShippingSDK_EzRates Class)

Total discount amount applied to the shipment for a ServiceType .

Object Oriented Interface

public function getServiceAccountTotalDiscount($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 70 , $serviceidx);

Default Value

''

Remarks

Total discount amount applied to the shipment for a ServiceType. This is for FedEx only and is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountTotalDiscount will be filled with the value of total discount applied, which is specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of discounts.

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

ServiceAccountTotalSurcharge Property (DShippingSDK_EzRates Class)

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

Object Oriented Interface

public function getServiceAccountTotalSurcharge($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 71 , $serviceidx);

Default Value

''

Remarks

Total surcharge amount for all additional services applied to a ServiceType. This is only for FedEx, and is specific to the FedExAccountNumber. After calling the GetRates method, the ServiceAccountTotalSurcharge will be filled with the value of total surcharges applied, which is specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of surcharges.

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_EzRates 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_ezrates_get($res, 72 , $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_EzRates Class)

Number of business days from origin to destination location.

Object Oriented Interface

public function getServiceBusinessDays($serviceidx);

Procedural Interface

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

ServiceCommitments Property (DShippingSDK_EzRates Class)

Service commitments for the PackagingType when shipping to CountryCode .

Object Oriented Interface

public function getServiceCommitments($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 74 , $serviceidx);

Default Value

''

Remarks

Service commitments for the ServicePackagingType when shipping to RecipientCountryCode.

This is valid only for USPS, and indicates how long it will take for the package to be delivered when shipped via ServicePackagingType.

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

ServiceCustomerCenterCutoff Property (DShippingSDK_EzRates Class)

Time the UPS Customer Service Center closes.

Object Oriented Interface

public function getServiceCustomerCenterCutoff($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 75 , $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

ServiceDeliveryDate Property (DShippingSDK_EzRates Class)

This indicates the shipment delivery date for the ServiceType .

Object Oriented Interface

public function getServiceDeliveryDate($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 77 , $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

ServiceEffectiveNetDiscount Property (DShippingSDK_EzRates Class)

Indicates the net discount applied to a ServiceType .

Object Oriented Interface

public function getServiceEffectiveNetDiscount($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 80 , $serviceidx);

Default Value

''

Remarks

Indicates the net discount applied to a ServiceType. This is only valid for FedEx.

After calling the GetRates method, the ServiceEffectiveNetDiscount will be filled with the value of net discount applied. This is specific to the FedExAccountNumber (i.e. depending on the current rate schedule the FedExAccountNumber is receiving from FedEx). This is the difference between the list net charge and account net charge.

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

ServiceListBaseCharge Property (DShippingSDK_EzRates Class)

Transportation charges before surcharges and discounts applied to a ServiceType .

Object Oriented Interface

public function getServiceListBaseCharge($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 86 , $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_EzRates Class)

Net charge amount applied to a ServiceType .

Object Oriented Interface

public function getServiceListNetCharge($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 87 , $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

ServiceListTotalDiscount Property (DShippingSDK_EzRates Class)

Total discount amount applied to a ServiceType .

Object Oriented Interface

public function getServiceListTotalDiscount($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 88 , $serviceidx);

Default Value

''

Remarks

Total discount amount applied to a ServiceType. This applies only to FedEx. After calling the GetRates method, the ServiceListTotalDiscount will be filled with the value of total discount applied. 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_EzRates Class)

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

Object Oriented Interface

public function getServiceListTotalSurcharge($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 89 , $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

ServiceMaxDimensions Property (DShippingSDK_EzRates Class)

Maximum dimensions of a package allowed when sending to the CountryCode .

Object Oriented Interface

public function getServiceMaxDimensions($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 90 , $serviceidx);

Default Value

''

Remarks

Maximum dimensions of a package allowed when sending to the RecipientCountryCode. This is only applicable to USPS. After a call to GetRates, this property will contain the maximum allowable dimensions of a package sent to the RecipientCountryCode via the indicated ServiceType.

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

ServiceMaxWeight Property (DShippingSDK_EzRates Class)

Maximum weight of package allowed when sending to the CountryCode .

Object Oriented Interface

public function getServiceMaxWeight($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 91 , $serviceidx);

Default Value

''

Remarks

Maximum weight of package allowed when sending to the RecipientCountryCode.

This is only applicable to USPS.

After a call to GetRates, this property will contain the maximum allowable weight (in pounds) of a package sent to the RecipientCountryCode via the indicated ServiceType.

Note: This property may contain a fractional quantity (eg: "0.2188", which indicates a max weight of 3.5 ounces).

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

ServiceRateScale Property (DShippingSDK_EzRates Class)

Applicable rate scale for the ServiceType .

Object Oriented Interface

public function getServiceRateScale($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 93 , $serviceidx);

Default Value

''

Remarks

Applicable rate scale for the ServiceType.

The ServiceRateScale indicates the rate scale (this is specific to the FedExAccountNumber) used by FedEx to rate a shipment when shipped via the ServiceType. This is applicable for FedEx Express services only.

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

ServiceRateZone Property (DShippingSDK_EzRates Class)

Applicable rate zone for the ServiceType .

Object Oriented Interface

public function getServiceRateZone($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 94 , $serviceidx);

Default Value

''

Remarks

Applicable rate zone for the ServiceType.

The ServiceRateZone indicates the zone used by FedEx to rate a shipment (this is specific to the RecipientZipCode) when using a FedEx Express service. This is applicable for FedEx Express services only.

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

ServiceType Property (DShippingSDK_EzRates Class)

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

Object Oriented Interface

public function getServiceType($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 96 , $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:

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_EzRates 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_ezrates_get($res, 97 , $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

ServiceShipTime Property (DShippingSDK_EzRates Class)

Time UPS picks up the package from the origin.

Object Oriented Interface

public function getServiceShipTime($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 99 , $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

ServiceSignatureType Property (DShippingSDK_EzRates Class)

Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType .

Object Oriented Interface

public function getServiceSignatureType($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 100 , $serviceidx);

Default Value

''

Remarks

Indicates the textual description of the delivery signature services option required by FedEx for the ServiceType. This might be different from the requested PackageSignatureType.

Possible returned values 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

ServiceTransitTime Property (DShippingSDK_EzRates Class)

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

Object Oriented Interface

public function getServiceTransitTime($serviceidx);

Procedural Interface

dshippingsdk_ezrates_get($res, 101 , $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

ShipmentSpecialServices Property (DShippingSDK_EzRates Class)

Contains the collection of special services offered.

Object Oriented Interface

public function getShipmentSpecialServices();


public function setShipmentSpecialServices($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 102 );


dshippingsdk_ezrates_set($res, 102, $value );

Default Value

0

Remarks

To request any of the special services offered by FedEx in a ship 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:

Data Type

Long64

SSLAcceptServerCertEncoded Property (DShippingSDK_EzRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 104 );


dshippingsdk_ezrates_set($res, 104, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (DShippingSDK_EzRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 132 );


dshippingsdk_ezrates_set($res, 132, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (DShippingSDK_EzRates 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_ezrates_get($res, 148 );


dshippingsdk_ezrates_set($res, 148, $value );

Default Value

'MY'

Remarks

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

The StoreType property denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_EzRates 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_ezrates_get($res, 149 );


dshippingsdk_ezrates_set($res, 149, $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_EzRates Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 150 );


dshippingsdk_ezrates_set($res, 150, $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_EzRates 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_ezrates_get($res, 151 );


dshippingsdk_ezrates_set($res, 151, $value );

Default Value

''

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SSLProvider Property (DShippingSDK_EzRates Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 159 );


dshippingsdk_ezrates_set($res, 159, $value );

Default Value

0

Remarks

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

Possible values are:

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

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

Data Type

Integer

SSLServerCertEncoded Property (DShippingSDK_EzRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_ezrates_get($res, 161 );

Default Value

''

Remarks

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

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

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

Data Type

Binary String

Timeout Property (DShippingSDK_EzRates Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 188 );


dshippingsdk_ezrates_set($res, 188, $value );

Default Value

60

Remarks

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

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

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

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

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

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalWeight Property (DShippingSDK_EzRates Class)

Total shipment's weight.

Object Oriented Interface

public function getTotalWeight();


public function setTotalWeight($value);

Procedural Interface

dshippingsdk_ezrates_get($res, 189 );


dshippingsdk_ezrates_set($res, 189, $value );

Default Value

'1.0'

Remarks

This indicates shipment's weight.

Allows for only one decimal point and one decimal place.

For FedEx, this property is required unless there is only one package in the shipment and that package's weight is provided in the PackageWeight property.

For UPS, this is 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.

This property is not applicable to USPS shipments.

Data Type

String

Config Method (DShippingSDK_EzRates Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_ezrates_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_EzRates Class)

Returns rate information for a specified or all available services.

Object Oriented Interface

public function doGetRates();

Procedural Interface

dshippingsdk_ezrates_do_getrates($res);

Remarks

To get the courtesy rate quotes for the Provider's 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 specific service for which you want to retrieve rate information.

If the rates are wanted for all available services, you should set the RequestedService to 0 (stUnspecified). Following validation, the EzRates 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):

• Account (required)
• RequestedService (required)
• SenderAddress(required)
• RecipientAddress (required)
• Packages (required)

Returned values upon a successful reply are:

• Services

Reset Method (DShippingSDK_EzRates Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_ezrates_do_reset($res);

Remarks

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

Error Event (DShippingSDK_EzRates Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_ezrates_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_EzRates Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_ezrates_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_EzRates Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

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

Parameter List

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

Remarks

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

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

SSLStatus Event (DShippingSDK_EzRates Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

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

Parameter List

 'message'

Remarks

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

Config Settings (EzRates Class)

EzRates Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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