USPSRates Class

Properties   Methods   Events   Config Settings   Errors  

Determines domestic and international postage rates based on weight, size, class of mail, and origin/destination information.

Class Name

DShippingSDK_USPSRates

Procedural Interface

 dshippingsdk_uspsrates_open();
 dshippingsdk_uspsrates_close($res);
 dshippingsdk_uspsrates_register_callback($res, $id, $function);
 dshippingsdk_uspsrates_get_last_error($res);
 dshippingsdk_uspsrates_get_last_error_code($res);
 dshippingsdk_uspsrates_set($res, $id, $index, $value);
 dshippingsdk_uspsrates_get($res, $id, $index);
 dshippingsdk_uspsrates_do_config($res, $configurationstring);
 dshippingsdk_uspsrates_do_getrates($res);
 dshippingsdk_uspsrates_do_getshippingtime($res);
 dshippingsdk_uspsrates_do_reset($res);

Remarks

This class provides automated online access to domestic and international rate information. These domestic rates are for: Express Mail, First-Class Mail, and Priority Mail, as well as single-piece rates for all four Package Services: Parcel Post, Bound Printed Matter, Library Mail, and Media Mail. The international rates are for International Priority Mail, International Express Mail (EMS), and International First Class Mail, along with service standards for each class of service.

To use this class to receive rate information for domestic shipments, simply set the PackageWeight, SenderZipCode, RecipientZipCode, and PackageSize. Then simply call GetRates.

You may also optionally supply dimensions of the package with PackageLength, PackageWidth, and PackageHeight, and filter the results returned by ServiceType and PackageType.

In response to this request, the USPS Server will return a list of postage services available for mailing your package. You can access these services through the ServiceListNetCharge, ServiceType, and ServiceTypeDescription properties. The number of PostalZones between the SenderZipCode and RecipientZipCode will also be returned, along with any Restrictions for mailing to APO/FPO addresses.

To use this class to receive rate information for international shipments, simply set the PackageWeight, PackageType, and RecipientCountryCode, and then call GetRates.

For International rates, the following properties may be returned:

• ServiceType
• ServiceTypeDescription
• ServiceCommitments
• ServiceMaxDimensions
• ServiceMaxWeight
• ServiceListNetCharge
• ServiceInsuranceCost
• ServiceInsuranceComment
• ServiceIndemnityCoverage

Please note that in most cases international packages may need a Customs Declaration form, and packages may also be subject to mailing restrictions unique to the destination country. To assist you with this important information, the International Rates class will return all the necessary mailing Restrictions, Prohibitions, and Observations, names of required CustomsForms, as well as delivery AreasServed.

Postage Provider Notes

When using USPS as the PostageProvider (i.e. ppNone) you will need to...

• Set PostageProvider to ppNone (default).
• Set USPSUserId to the UserId provided by USPS.
• Set USPSPassword to the password provided by USPS.
• Set USPSServer to either the test or production server.

When using Endicia as the PostageProvider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

• Set PostageProvider to ppEndicia.
• Set USPSAccountNumber to your production account number (provided by Endicia).
• Set USPSPassword to your production password (provided by Endicia).

The components come with a built in sandbox account for your use. To use that account with the components...

• Set PostageProvider to ppEndicia.
• Set EndiciaTestMode to either 1 or 2.

ppStamps

When using Stamps.com as the PostageProvider you will need to...

• Set PostageProvider to ppStamps.
• Set USPSUserId to the sandbox or production user provided by Stamps.com.
• Set USPSAccountNumber to the sandbox or production account number provided by Stamps.com.
• Set USPSPassword to the sandbox or production password provided by Stamps.com.
• Set USPSServer to either the test or production server.

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.

AreasServed Property (DShippingSDK_USPSRates Class)

Areas where the PackagingType service is available when shipped to CountryCode .

Object Oriented Interface

public function getAreasServed();

Procedural Interface

dshippingsdk_uspsrates_get($res, 1 );

Default Value

''

Remarks

Some countries may only deliver mail to major metropolitan areas, while others will deliver mail everywhere.

The value of this property is filled after a call to the GetRates method.

This property is read-only.

Data Type

String

CustomsForms Property (DShippingSDK_USPSRates Class)

Customs forms required to mail to CountryCode .

Object Oriented Interface

public function getCustomsForms();

Procedural Interface

dshippingsdk_uspsrates_get($res, 2 );

Default Value

''

Remarks

This property will contain the name and number of any customs forms needed to send mail to the indicated RecipientCountryCode.

The value of this property is filled after a call to the GetRates method.

This property is read-only.

Data Type

String

Days Property (DShippingSDK_USPSRates Class)

Estimated time for delivery.

Object Oriented Interface

public function getDays();

Procedural Interface

dshippingsdk_uspsrates_get($res, 3 );

Default Value

''

Remarks

Estimate of the number of days to ship a package from SenderZipCode to RecipientZipCode. This property is filled after a call to the GetShippingTime.

This property is read-only.

Data Type

String

ExpressMailInfo Property (DShippingSDK_USPSRates Class)

Express Mail information when shipping to CountryCode .

Object Oriented Interface

public function getExpressMailInfo();

Procedural Interface

dshippingsdk_uspsrates_get($res, 4 );

Default Value

''

Remarks

The value of this property is filled after a call to the GetRates method.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (DShippingSDK_USPSRates 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_uspsrates_get($res, 5 );


dshippingsdk_uspsrates_set($res, 5, $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_USPSRates Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 6 );


dshippingsdk_uspsrates_set($res, 6, $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_USPSRates 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_uspsrates_get($res, 7 );


dshippingsdk_uspsrates_set($res, 7, $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_USPSRates 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_uspsrates_get($res, 8 );


dshippingsdk_uspsrates_set($res, 8, $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_USPSRates 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_uspsrates_get($res, 9 );


dshippingsdk_uspsrates_set($res, 9, $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_USPSRates 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_uspsrates_get($res, 10 );


dshippingsdk_uspsrates_set($res, 10, $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

Machinable Property (DShippingSDK_USPSRates Class)

Indicates if the package being shipped is classified as machinable.

Object Oriented Interface

public function getMachinable();


public function setMachinable($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 11 );


dshippingsdk_uspsrates_set($res, 11, $value );

Default Value

true

Remarks

The value of this property is optional to be provided when GetRates is called.

This property applies only to Parcel Post and First Class Mail. (Machinable criteria do not apply to Priority Mail, Express Mail, Bound Printed Matter, Library Mail, or Media Mail). The size, content, and weight of a Parcel Post package determine whether it is machinable or non-machinable. Characteristics of machinable mail are listed below:

A parcel is machinable when it:

• Not less than 6" long, 3" high, 0.25" thick, and 6 ounces in weight.
• Not more than 34" long, 17" high, 17" thick, or 35 lbs in weight. For books or other printed matter, the maximum weight is 25 lbs.

A letter-sized piece is not machinable if it has one or more of the following characteristics:

• Has an aspect ratio (length divided by height) of less than 1.3 or more than 2.5.
• Is polybagged, polywrapped, or enclosed in any plastic material.
• Has clasps, strings, buttons, or similar closure devices.
• Contains items such as pens, pencils, or loose keys or coins that cause the thickness of the mailpiece to be uneven.
• Is too rigid (does not bend easily when subjected to a transport belt tension of 40 lbs around an 11" diameter turn).
• For pieces more than 4.25" high or 6" long, the thickness is less than 0.009".
• Has a delivery address parallel to the shorter dimension of the mailpiece.
• Is a self-mailer with a folded edge perpendicular to the address.
• Booklet-type pieces with the bound edge (spine) along the shorter dimension of the piece or at the top.

A flat (large envelope) is always machinable so long as it meets the criteria for being a flat. (See the PackageType property for more information).

This property can also be specified on service type "ALL", but it will only apply to the Parcel Post rate. Even if Machinable is True, if the weight or dimension requirements exceed the limitations above, USPS will automatically return rates that include the non-machinable surcharge.

Data Type

Boolean

Observations Property (DShippingSDK_USPSRates Class)

Additional mailing information based on country of destination.

Object Oriented Interface

public function getObservations();

Procedural Interface

dshippingsdk_uspsrates_get($res, 12 );

Default Value

''

Remarks

Additional information that may be important to the sender. Returned by the USPS Server The value of this property is filled after a call to the GetRates method.

This property is read-only.

Data Type

String

PackageCount Property (DShippingSDK_USPSRates Class)

The number of records in the Package arrays.

Object Oriented Interface

public function getPackageCount();


public function setPackageCount($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 13 );


dshippingsdk_uspsrates_set($res, 13, $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_USPSRates 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_uspsrates_get($res, 22 , $packageidx);


dshippingsdk_uspsrates_set($res, 22, $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_USPSRates Class)

The height of the package to be shipped.

Object Oriented Interface

public function getPackageHeight($packageidx);


public function setPackageHeight($packageidx, $value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 23 , $packageidx);


dshippingsdk_uspsrates_set($res, 23, $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_USPSRates Class)

Amount of insurance requested for this package.

Object Oriented Interface

public function getPackageInsuredValue($packageidx);


public function setPackageInsuredValue($packageidx, $value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 25 , $packageidx);


dshippingsdk_uspsrates_set($res, 25, $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_USPSRates Class)

The length of the package to be shipped.

Object Oriented Interface

public function getPackageLength($packageidx);


public function setPackageLength($packageidx, $value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 26 , $packageidx);


dshippingsdk_uspsrates_set($res, 26, $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_USPSRates 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_uspsrates_get($res, 28 , $packageidx);


dshippingsdk_uspsrates_set($res, 28, $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_USPSRates 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_uspsrates_get($res, 36 , $packageidx);


dshippingsdk_uspsrates_set($res, 36, $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_USPSRates Class)

Size of the package being mailed.

Object Oriented Interface

public function getPackageSize($packageidx);


public function setPackageSize($packageidx, $value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 37 , $packageidx);


dshippingsdk_uspsrates_set($res, 37, $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_USPSRates Class)

Weight of this package.

Object Oriented Interface

public function getPackageWeight($packageidx);


public function setPackageWeight($packageidx, $value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 42 , $packageidx);


dshippingsdk_uspsrates_set($res, 42, $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_USPSRates Class)

The width of the package to be shipped.

Object Oriented Interface

public function getPackageWidth($packageidx);


public function setPackageWidth($packageidx, $value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 43 , $packageidx);


dshippingsdk_uspsrates_set($res, 43, $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

PostageProvider Property (DShippingSDK_USPSRates Class)

The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.

Object Oriented Interface

public function getPostageProvider();


public function setPostageProvider($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 44 );


dshippingsdk_uspsrates_set($res, 44, $value );

Default Value

0

Remarks

When set to ppNone, the class will communicate with USPS servers. When set to this value the following properties should also be set.

• Set USPSUserId
• Set USPSPassword
• Set USPSServer

When set to ppEndicia, the class will communicate with Endicia's servers. When set to this value the following properties should also be set.

For Production

• Set USPSAccountNumber
• Set USPSPassword

For Testing

• Set EndiciaTestMode

When set to ppStamps, the class will communicate with Stamps.com's servers. When set to this value the following properties should also be set.

• Set USPSUserId
• Set USPSAccountNumber
• Set USPSPassword
• Set USPSServer

Data Type

Integer

PostalZone Property (DShippingSDK_USPSRates Class)

Indicates the number of postal rate zones between the origin and destination zip codes.

Object Oriented Interface

public function getPostalZone();

Procedural Interface

dshippingsdk_uspsrates_get($res, 45 );

Default Value

''

Remarks

The Postal Zone (which might be "Local" or "0 through 8") identifies the appropriate distance code assigned to each origination and destination Zip Code pairing for every Zip Code in the nation. These zones are used for Priority Mail packages over 5 lbs.

The value of this property is filled by the response from the USPS server.

This property is read-only.

Data Type

String

Prohibitions Property (DShippingSDK_USPSRates Class)

List of items prohibited from mailing to the destination country.

Object Oriented Interface

public function getProhibitions();

Procedural Interface

dshippingsdk_uspsrates_get($res, 46 );

Default Value

''

Remarks

Articles that are prohibited by the destination country are non-mailable. These prohibitions are based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific prohibitions as a country may return or seize mail containing articles prohibited within that country, whether or not notice of such prohibitions has been provided to or published by the Postal Service. The value of this property is set and returned in the GetRates method call.

This property is read-only.

Data Type

String

ProxyAuthScheme Property (DShippingSDK_USPSRates 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_uspsrates_get($res, 47 );


dshippingsdk_uspsrates_set($res, 47, $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_USPSRates 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_uspsrates_get($res, 48 );


dshippingsdk_uspsrates_set($res, 48, $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_USPSRates 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_uspsrates_get($res, 49 );


dshippingsdk_uspsrates_set($res, 49, $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_USPSRates 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_uspsrates_get($res, 50 );


dshippingsdk_uspsrates_set($res, 50, $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_USPSRates 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_uspsrates_get($res, 51 );


dshippingsdk_uspsrates_set($res, 51, $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_USPSRates 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_uspsrates_get($res, 52 );


dshippingsdk_uspsrates_set($res, 52, $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_USPSRates 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_uspsrates_get($res, 53 );


dshippingsdk_uspsrates_set($res, 53, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

RecipientAddress1 Property (DShippingSDK_USPSRates Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 54 );


dshippingsdk_uspsrates_set($res, 54, $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_USPSRates 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_uspsrates_get($res, 55 );


dshippingsdk_uspsrates_set($res, 55, $value );

Default Value

''

Remarks

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

Data Type

String

RecipientCity Property (DShippingSDK_USPSRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 57 );


dshippingsdk_uspsrates_set($res, 57, $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_USPSRates Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 58 );


dshippingsdk_uspsrates_set($res, 58, $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_USPSRates Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 59 );


dshippingsdk_uspsrates_set($res, 59, $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_USPSRates Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 60 );


dshippingsdk_uspsrates_set($res, 60, $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_USPSRates Class)

Service type for which the shipping rate is requested.

Object Oriented Interface

public function getRequestedService();


public function setRequestedService($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 61 );


dshippingsdk_uspsrates_set($res, 61, $value );

Default Value

0

Remarks

If you send a request with the RequestedService set to svcPriority, after a call to GetRates, the price to send a Priority Mail package will be returned in ServiceListNetCharge. However, if you set the RequestedService to stUnspecified, the rates for all service types will be returned.

The RequestedService is used to filter the postage rates that are returned by service type. If you are only interested in Priority Mail rates, there is no need to receive Parcel Post or Library mail, for instance. Rates will be returned in the ServiceListNetCharge array property, with the service it corresponds located in the ServiceType and ServiceTypeDescription properties.

This property is only valid for domestic shipments.

The stUnspecified value is not valid when PostageProvider is set to ppEndicia.

The available service types for USPS include:

Valid values for USPS are:

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

Please note that some ShipmentSpecialServices flags such as Hold For Pickup, Premium Service (Sunday/Holiday), and Commercial will affect the rate.

Also, please note that all ServiceListNetCharges are also dependant on the SenderZipCode, SenderZipCode (or SenderCountryCode for international shipments), PackageWeight, PackageSize and PackageType. Priority Mail packages larger than 1 cubic foot in size also require PackageLength, PackageWidth, and PackageHeight to accurately calculate the postage.

Note that when using any of the commercial service types, you must use the CommercialRate configuration setting to retrieve the commercial rate for the postage service at index i.

Data Type

Integer

Restrictions Property (DShippingSDK_USPSRates Class)

Restrictions on items being shipped.

Object Oriented Interface

public function getRestrictions();

Procedural Interface

dshippingsdk_uspsrates_get($res, 62 );

Default Value

''

Remarks

For domestic shipments, this describes the restrictions for APO/FPI destination Zip Codes. This data is returned in the GetRates method call if the RecipientZipCode is an APO/FPO Zip Code.

For international shipments, this property will contain information indicating mail articles which are restricted by the destination country, Any packages sent are subject to the import requirements of that country. The contents of this property is based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific restrictions as a country may return or seize mail containing articles prohibited or restricted within that country, whether or not notice of such restriction has been provided to or published by the Postal Service.

The value of this property is filled after a call to the GetRates method.

NOTE: For rates requests using APO/FPO/DPO ZIP codes (origin or destination), any restrictions will be found in the Restrictions[i] Configuration setting, not in this property.

This property is read-only.

Data Type

String

SenderZipCode Property (DShippingSDK_USPSRates Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 69 );


dshippingsdk_uspsrates_set($res, 69, $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_USPSRates Class)

The number of records in the Service arrays.

Object Oriented Interface

public function getServiceCount();

Procedural Interface

dshippingsdk_uspsrates_get($res, 70 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServiceCommitments
• ServiceIndemnityCoverage
• ServiceInsuranceComment
• ServiceInsuranceCost
• ServiceListNetCharge
• ServiceMaxDimensions
• ServiceMaxWeight
• ServicePackagingType
• 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

ServiceCommitments Property (DShippingSDK_USPSRates Class)

Service commitments for the PackagingType when shipping to CountryCode .

Object Oriented Interface

public function getServiceCommitments($serviceidx);

Procedural Interface

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

ServiceIndemnityCoverage Property (DShippingSDK_USPSRates Class)

Indicates the indemnity coverage available for this service.

Object Oriented Interface

public function getServiceIndemnityCoverage($serviceidx);

Procedural Interface

dshippingsdk_uspsrates_get($res, 86 , $serviceidx);

Default Value

''

Remarks

Indicates the indemnity coverage available for this service. This property is valid only for USPS, and is only returned when TotalValue was sent in the request. It contains the lesser of maximum parcel indemnity coverage per given weight and TotalValue, if applicable. Otherwise it will be blank.

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

ServiceInsuranceComment Property (DShippingSDK_USPSRates Class)

Explains why no InsuranceCost was returned in the response.

Object Oriented Interface

public function getServiceInsuranceComment($serviceidx);

Procedural Interface

dshippingsdk_uspsrates_get($res, 87 , $serviceidx);

Default Value

''

Remarks

Explains why no InsuranceCost was returned in the response.

This property is only applicable to USPS.

If the TotalValue was sent in the request (indicating you wish to receive the ServiceInsuranceCost in the response), but no ServiceInsuranceCost was returned, then ServiceInsuranceComment will contain text explaining why no value was returned for ServiceInsuranceCost. It may be one of three reasons:

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

ServiceInsuranceCost Property (DShippingSDK_USPSRates Class)

Insurance fee.

Object Oriented Interface

public function getServiceInsuranceCost($serviceidx);

Procedural Interface

dshippingsdk_uspsrates_get($res, 88 , $serviceidx);

Default Value

''

Remarks

Insurance fee. This is applicable only to USPS and it describes the cost of purchasing insurance for this package.

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

Net charge amount applied to a ServiceType .

Object Oriented Interface

public function getServiceListNetCharge($serviceidx);

Procedural Interface

dshippingsdk_uspsrates_get($res, 90 , $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

ServiceMaxDimensions Property (DShippingSDK_USPSRates Class)

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

Object Oriented Interface

public function getServiceMaxDimensions($serviceidx);

Procedural Interface

dshippingsdk_uspsrates_get($res, 93 , $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_USPSRates Class)

Maximum weight of package allowed when sending to the CountryCode .

Object Oriented Interface

public function getServiceMaxWeight($serviceidx);

Procedural Interface

dshippingsdk_uspsrates_get($res, 94 , $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

ServicePackagingType Property (DShippingSDK_USPSRates Class)

The mail service type when shipping to CountryCode .

Object Oriented Interface

public function getServicePackagingType($serviceidx);

Procedural Interface

dshippingsdk_uspsrates_get($res, 95 , $serviceidx);

Default Value

''

Remarks

The mail service type when shipping to RecipientCountryCode.

This is only valid for USPS international rate requests.

ServicePackagingType indicates what type of shipping service is being used for each InternationalService. ServicePackagingType may contain the following information:

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

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

Object Oriented Interface

public function getServiceType($serviceidx);

Procedural Interface

dshippingsdk_uspsrates_get($res, 99 , $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_USPSRates 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_uspsrates_get($res, 100 , $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

ShipmentSpecialServices Property (DShippingSDK_USPSRates Class)

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

Object Oriented Interface

public function getShipmentSpecialServices();


public function setShipmentSpecialServices($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 105 );


dshippingsdk_uspsrates_set($res, 105, $value );

Default Value

0

Remarks

To request any of the special services offered by USPS, 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_USPSRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 107 );


dshippingsdk_uspsrates_set($res, 107, $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_USPSRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 135 );


dshippingsdk_uspsrates_set($res, 135, $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_USPSRates 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_uspsrates_get($res, 151 );


dshippingsdk_uspsrates_set($res, 151, $value );

Default Value

'MY'

Remarks

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

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

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

Designations of certificate stores are platform dependent.

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

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

Data Type

Binary String

SSLCertStorePassword Property (DShippingSDK_USPSRates 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_uspsrates_get($res, 152 );


dshippingsdk_uspsrates_set($res, 152, $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_USPSRates Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 153 );


dshippingsdk_uspsrates_set($res, 153, $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_USPSRates 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_uspsrates_get($res, 154 );


dshippingsdk_uspsrates_set($res, 154, $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_USPSRates Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 162 );


dshippingsdk_uspsrates_set($res, 162, $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_USPSRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_uspsrates_get($res, 164 );

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

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 191 );


dshippingsdk_uspsrates_set($res, 191, $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_USPSRates Class)

Total value of the items inside the package.

Object Oriented Interface

public function getTotalValue();


public function setTotalValue($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 192 );


dshippingsdk_uspsrates_set($res, 192, $value );

Default Value

''

Remarks

This property is used by USPS to compute the InsuranceCost and IndemnityCoverage. (if they are available for the current RequestedService and RecipientCountryCode).

Data Type

String

USPSAccountNumber Property (DShippingSDK_USPSRates Class)

The shipper's Endicia account number.

Object Oriented Interface

public function getUSPSAccountNumber();


public function setUSPSAccountNumber($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 193 );


dshippingsdk_uspsrates_set($res, 193, $value );

Default Value

''

Remarks

The shipper's Endicia account number.

This property is only used when shipping with Endicia and will take a production account number. During testing please set EndiciaTestMode which will automatically use a sandbox account. During testing this property does not need to be set.

Data Type

String

USPSPassword Property (DShippingSDK_USPSRates Class)

Password to use for logging in to the USPS Server .

Object Oriented Interface

public function getUSPSPassword();


public function setUSPSPassword($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 194 );


dshippingsdk_uspsrates_set($res, 194, $value );

Default Value

''

Remarks

Password to use for logging in to the USPS Server.

This password is provided to you by USPS when you register for service. The password is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

Note, the Password property has been depreciated by USPS, and remains only for backwards compatibility.

When PostageProvider has been set to ppEndicia, this must be the pass phrase associated with your postage account that was supplied to you by Endicia upon registration.

Data Type

String

USPSServer Property (DShippingSDK_USPSRates Class)

URL for the USPS server where the requests are sent.

Object Oriented Interface

public function getUSPSServer();


public function setUSPSServer($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 195 );


dshippingsdk_uspsrates_set($res, 195, $value );

Default Value

'https://secure.shippingapis.com/ShippingAPI.dll'

Remarks

URL for the USPS server where the requests are sent.

When PostageProvider has been set to ppEndicia, the live production URL will be set automatically. For testing please set EndiciaTestMode.

When PostageProvider has been set to ppStamps, the live production URL will be set automatically. For testing please set StampsTestMode.

There are two different live and test URLs that have been provided by the US Postal service for use with the Webtools APIs (and these classs). There is one plaintext URL and one SSL-secured URL for both live and testing. These URLs are listed below, along with the classs that use them.

Live Servers:

Test Servers:

These test servers return CANNED RESPONSES. They will only accept a specific set of data, and will only return one pre-formed response. Any transaction that does not contain the exact data they expect will cause an error to be generated. Because of these limitations we strongly recommend you test using a live account.

Note that the label components must use the live server for testing, but with the Certify configuration setting set to True. There is no need to set Certify with Endicia or Stamps.com. Set EndiciaTestMode or StampsTestMode instead.

Data Type

String

USPSUserId Property (DShippingSDK_USPSRates Class)

User Id for logging in to the USPS WebTools or Stamps.

Object Oriented Interface

public function getUSPSUserId();


public function setUSPSUserId($value);

Procedural Interface

dshippingsdk_uspsrates_get($res, 196 );


dshippingsdk_uspsrates_set($res, 196, $value );

Default Value

''

Remarks

User Id for logging in to the USPS WebTools or Stamps.com Server.

This User Id is provided to you by USPS or Stamps.com when you register for service. The UserId is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity. During testing set StampsTestMode to use the built-in sandbox account. This field is not used by Endicia.

Data Type

String

Config Method (DShippingSDK_USPSRates Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_uspsrates_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_USPSRates Class)

Calculates postage rates to ship a package via the RequestedService .

Object Oriented Interface

public function doGetRates();

Procedural Interface

dshippingsdk_uspsrates_do_getrates($res);

Remarks

For domestic rate requests, this method allows you to calculate how much domestic shipping will cost to mail a package with a certain size and weight, from SenderZipCode to RecipientZipCode by Express Mail, Priority Mail, First-Class Mail, Parcel Post, Media Mail, Library Mail, or as Bound Printed Matter.

Domestic rate requests use values for the following properties:

• RequestedService (required)
• SenderZipCode (required)
• RecipientZipCode (required)
• PackageWeight (required)
• PackageSize (required)
• PackageLength (required for large packages)
• PackageWidth (required for large packages)
• PackageHeight (required for large packages)
• PackageGirth (required for irregular packages)
• PackageType (optional)
• Machinable (optional)

• Restrictions
• PostalZone
• ServiceListNetCharge
• ServiceType
• ServiceTypeDescription

• ServiceListNetCharge
• ServiceCommitments
• ServiceType
• ServiceTypeDescription
• ServicePackagingType
• ServiceMaxDimensions
• ServiceMaxWeight

• Restrictions
• Prohibitions
• Observations
• CustomsForms
• AreasServed
• ExpressMailInfo

• PackageType
• SenderCountryCode
• PackageWeight

GetShippingTime Method (DShippingSDK_USPSRates Class)

Returns the estimated time to ship a package from ZipCode to ZipCode .

Object Oriented Interface

public function doGetShippingTime();

Procedural Interface

dshippingsdk_uspsrates_do_getshippingtime($res);

Remarks

This method call contacts the USPS USPSServer and determines the average estimated time to ship a package from SenderZipCode to RecipientZipCode. This method call fills the following properties: SenderZipCode, RecipientZipCode and Days.

Origination and destination ZIP Codes must be valid. Only the first 3 digits of each ZIP code is required. If a 4- or 5-digit ZIP Code is entered, the last 1 or 2 digits will be ignored.

Reset Method (DShippingSDK_USPSRates Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_uspsrates_do_reset($res);

Remarks

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

Error Event (DShippingSDK_USPSRates Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_uspsrates_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_USPSRates Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_uspsrates_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_USPSRates Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dshippingsdk_uspsrates_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_USPSRates Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dshippingsdk_uspsrates_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 (USPSRates Class)

USPSRates Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (USPSRates Class)

USPSRates Errors

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

SOAP Errors

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

HTTP Errors

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

TCPClient Errors

SSL Errors