FedExRates Class

Properties   Methods   Events   Config Settings   Errors  

Provides access to pre-ship rate information for a single package per your established FedEx account rates.

Class Name

DShippingSDK_FedExRates

Procedural Interface

 dshippingsdk_fedexrates_open();
 dshippingsdk_fedexrates_close($res);
 dshippingsdk_fedexrates_register_callback($res, $id, $function);
 dshippingsdk_fedexrates_get_last_error($res);
 dshippingsdk_fedexrates_get_last_error_code($res);
 dshippingsdk_fedexrates_set($res, $id, $index, $value);
 dshippingsdk_fedexrates_get($res, $id, $index);
 dshippingsdk_fedexrates_do_config($res, $configurationstring);
 dshippingsdk_fedexrates_do_getrates($res);
 dshippingsdk_fedexrates_do_reset($res);

Remarks

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 FedEx Express services with the respective rate quotes.

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

• a specific FedEx 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 FedEx services (when RequestedService is set to UNSPECIFIED, which is the default value) and a specified destination. This option is available for all shipping types and destinations.

Discount rates are available for all services and origin/destination pairs. List rates are available for Express and Ground U.S. shipments only. To have list rates returned with your discount rates, you must set the RateType to 0 (rtList). This way, you will receive both discount and list rates.

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: Express U.S. Domestic and International multiple package shipments, Ground US Domestic and International multiple-package shipments, Express Domestic C.O.D. and International C.O.D. multiple-package shipments and Ground Domestic C.O.D. and International C.O.D. multiple-package shipments.

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

With the FedExRates Class, you can:

• Ensure service availability (after you provide the carrier code, service type, origination & destination postal codes, packaging type, drop-off type, and estimated weight);
• Retrieve the rate required for that shipment.

The restrictions on the allowed property values are listed separately under each control property description. If the user enters more than the allowed number of characters, an error will not be generated. The control will simply pass in the characters provided and the server may disregard the extra characters. This is important since the resulting value could prevent a correct response.

To use this class, you must have a FedEx FedExAccountNumber. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.

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.

CODTotalAmount Property (DShippingSDK_FedExRates Class)

The total amount to be collected on delivery.

Object Oriented Interface

public function getCODTotalAmount();


public function setCODTotalAmount($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 1 );


dshippingsdk_fedexrates_set($res, 1, $value );

Default Value

''

Remarks

This indicates customer's total COD amount (prior to any accumulations: total collection amount minus transportation charges). The CODTotalAmount is required to be provided in a ship request only if the corresponding flag of COD is contained in the ShipmentSpecialServices property.

For Ground COD shipments, the COD amount must be included on each package that uses COD service by setting the PackageCODAmount and the corresponding flag of COD is contained in the PackageSpecialServices field.

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

Data Type

String

CODType Property (DShippingSDK_FedExRates Class)

COD type.

Object Oriented Interface

public function getCODType();


public function setCODType($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 2 );


dshippingsdk_fedexrates_set($res, 2, $value );

Default Value

0

Remarks

This property identifies the type of funds FedEx should collect upon package delivery. It is required to be provided in a ship request only if the COD is present (requested) in the ShipmentSpecialServices.

Possible values are as follows:

Data Type

Integer

FedExAccountNumber Property (DShippingSDK_FedExRates Class)

The account number associated with the shipment.

Object Oriented Interface

public function getFedExAccountNumber();


public function setFedExAccountNumber($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 3 );


dshippingsdk_fedexrates_set($res, 3, $value );

Default Value

''

Remarks

The account number associated with the shipment.

The FedExAccountNumber 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.

Data Type

String

FedExAuthorizationToken Property (DShippingSDK_FedExRates Class)

Authorization Token used to authenticate the request.

Object Oriented Interface

public function getFedExAuthorizationToken();


public function setFedExAuthorizationToken($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 4 );


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

FedExLanguageCode Property (DShippingSDK_FedExRates Class)

Two-letter code for the language (e.

Object Oriented Interface

public function getFedExLanguageCode();


public function setFedExLanguageCode($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 5 );


dshippingsdk_fedexrates_set($res, 5, $value );

Default Value

'en'

Remarks

Two-letter code for the language (e.g. en, fr, etc.).

This field allows you to assign the language code. Default value is en.

Data Type

String

FedExLocaleCode Property (DShippingSDK_FedExRates Class)

Two-letter code for the region (e.

Object Oriented Interface

public function getFedExLocaleCode();


public function setFedExLocaleCode($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 6 );


dshippingsdk_fedexrates_set($res, 6, $value );

Default Value

'US'

Remarks

Two-letter code for the region (e.g. US, CA, etc.).

Some languages require a locale code to further identify the language. Default value is US.

Data Type

String

FedExServer Property (DShippingSDK_FedExRates Class)

URL for the FedEx Server where the requests are sent.

Object Oriented Interface

public function getFedExServer();


public function setFedExServer($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 7 );


dshippingsdk_fedexrates_set($res, 7, $value );

Default Value

''

Remarks

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

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

Data Type

String

FirewallAutoDetect Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 8 );


dshippingsdk_fedexrates_set($res, 8, $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_FedExRates Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 9 );


dshippingsdk_fedexrates_set($res, 9, $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_FedExRates 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_fedexrates_get($res, 10 );


dshippingsdk_fedexrates_set($res, 10, $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_FedExRates 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_fedexrates_get($res, 11 );


dshippingsdk_fedexrates_set($res, 11, $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_FedExRates 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_fedexrates_get($res, 12 );


dshippingsdk_fedexrates_set($res, 12, $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_FedExRates 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_fedexrates_get($res, 13 );


dshippingsdk_fedexrates_set($res, 13, $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

FreightGuaranteeDate Property (DShippingSDK_FedExRates Class)

The date the freight shipment is guaranteed for.

Object Oriented Interface

public function getFreightGuaranteeDate();


public function setFreightGuaranteeDate($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 14 );


dshippingsdk_fedexrates_set($res, 14, $value );

Default Value

''

Remarks

The date the freight shipment is guaranteed for.

The valid format for the date is YYYY-MM-DD

Data Type

String

FreightGuaranteeType Property (DShippingSDK_FedExRates Class)

Specifies what type of freight guarantee is requested.

Object Oriented Interface

public function getFreightGuaranteeType();


public function setFreightGuaranteeType($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 15 );


dshippingsdk_fedexrates_set($res, 15, $value );

Default Value

0

Remarks

Specifies what type of freight guarantee is requested.

The valid values are:

Data Type

Integer

HomeDeliveryDate Property (DShippingSDK_FedExRates Class)

Date for Ground Home Delivery service.

Object Oriented Interface

public function getHomeDeliveryDate();


public function setHomeDeliveryDate($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 16 );


dshippingsdk_fedexrates_set($res, 16, $value );

Default Value

''

Remarks

The date when the Home Delivery Premium service is requested to happen. This is required when HomeDeliveryType is set to 1 (DateCertain). Valid dates are Monday through Saturday.

Format: YYYY-MM-DD.

Data Type

String

HomeDeliveryPhone Property (DShippingSDK_FedExRates Class)

The phone number of the delivery location.

Object Oriented Interface

public function getHomeDeliveryPhone();


public function setHomeDeliveryPhone($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 17 );


dshippingsdk_fedexrates_set($res, 17, $value );

Default Value

''

Remarks

This is required when HomeDeliveryType is set to 0 (Appointment) or 1 (DateCertain). In a ship request, if this is not specified, it will default to RecipientPhone.

Data Type

String

HomeDeliveryType Property (DShippingSDK_FedExRates Class)

The type of Home Delivery Premium service being requested.

Object Oriented Interface

public function getHomeDeliveryType();


public function setHomeDeliveryType($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 18 );


dshippingsdk_fedexrates_set($res, 18, $value );

Default Value

0

Remarks

This property is required to be provided in a ship request when ServiceType is set to GroundHomeDelivery and ShipmentSpecialServices is set to Home Delivery Premium.

Possible values are as follows:

Data Type

Integer

InsuredValue Property (DShippingSDK_FedExRates Class)

The total amount of insurance requested for the shipment being rated.

Object Oriented Interface

public function getInsuredValue();


public function setInsuredValue($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 19 );


dshippingsdk_fedexrates_set($res, 19, $value );

Default Value

'0.00'

Remarks

This property is optional to be provided in the rate request, and if present, this will affect the rates and service availability.

Format: Two explicit decimal positions (e.g. 100.00). Total length including decimal position: 11.

Data Type

String

PackageCount Property (DShippingSDK_FedExRates Class)

The number of records in the Package arrays.

Object Oriented Interface

public function getPackageCount();


public function setPackageCount($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 20 );


dshippingsdk_fedexrates_set($res, 20, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageCODAmount
• PackageCODType
• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageSignatureType
• PackageSpecialServices
• 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

PackageCODAmount Property (DShippingSDK_FedExRates Class)

The COD monetary value for the package.

Object Oriented Interface

public function getPackageCODAmount($packageidx);


public function setPackageCODAmount($packageidx, $value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 22 , $packageidx);


dshippingsdk_fedexrates_set($res, 22, $value , $packageidx);

Default Value

''

Remarks

The COD monetary value for the package.

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

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

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

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

This property is not applicable to USPS packages.

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

This is not applicable for Canada Post.

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

This property is not available at design time.

Data Type

String

PackageCODType Property (DShippingSDK_FedExRates Class)

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

Object Oriented Interface

public function getPackageCODType($packageidx);


public function setPackageCODType($packageidx, $value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 25 , $packageidx);


dshippingsdk_fedexrates_set($res, 25, $value , $packageidx);

Default Value

0

Remarks

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

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

Valid values are:

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

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

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

This property is not available at design time.

Data Type

Integer

PackageHeight Property (DShippingSDK_FedExRates Class)

The height of the package to be shipped.

Object Oriented Interface

public function getPackageHeight($packageidx);


public function setPackageHeight($packageidx, $value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 30 , $packageidx);


dshippingsdk_fedexrates_set($res, 30, $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_FedExRates Class)

Amount of insurance requested for this package.

Object Oriented Interface

public function getPackageInsuredValue($packageidx);


public function setPackageInsuredValue($packageidx, $value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 32 , $packageidx);


dshippingsdk_fedexrates_set($res, 32, $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_FedExRates Class)

The length of the package to be shipped.

Object Oriented Interface

public function getPackageLength($packageidx);


public function setPackageLength($packageidx, $value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 33 , $packageidx);


dshippingsdk_fedexrates_set($res, 33, $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_FedExRates 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_fedexrates_get($res, 35 , $packageidx);


dshippingsdk_fedexrates_set($res, 35, $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_FedExRates 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_fedexrates_get($res, 43 , $packageidx);


dshippingsdk_fedexrates_set($res, 43, $value , $packageidx);

Default Value

0

Remarks

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

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

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

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

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

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

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

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

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

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

This does not apply for Canada Post.

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

This property is not available at design time.

Data Type

Integer

PackageSpecialServices Property (DShippingSDK_FedExRates Class)

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

Object Oriented Interface

public function getPackageSpecialServices($packageidx);


public function setPackageSpecialServices($packageidx, $value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 45 , $packageidx);


dshippingsdk_fedexrates_set($res, 45, $value , $packageidx);

Default Value

0

Remarks

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

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

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

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

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

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

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

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

This property is not applicable to USPS or Canada Post.

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

This property is not available at design time.

Data Type

Long64

PackageWeight Property (DShippingSDK_FedExRates Class)

Weight of this package.

Object Oriented Interface

public function getPackageWeight($packageidx);


public function setPackageWeight($packageidx, $value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 49 , $packageidx);


dshippingsdk_fedexrates_set($res, 49, $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_FedExRates Class)

The width of the package to be shipped.

Object Oriented Interface

public function getPackageWidth($packageidx);


public function setPackageWidth($packageidx, $value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 50 , $packageidx);


dshippingsdk_fedexrates_set($res, 50, $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

PickupType Property (DShippingSDK_FedExRates Class)

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

Object Oriented Interface

public function getPickupType();


public function setPickupType($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 51 );


dshippingsdk_fedexrates_set($res, 51, $value );

Default Value

0

Remarks

Indicate the pickup type method by which the shipment to be tendered to FedEx.

Valid values are:

Data Type

Integer

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


dshippingsdk_fedexrates_set($res, 52, $value );

Default Value

0

Remarks

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

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

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

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

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

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

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

Data Type

Integer

ProxyAutoDetect Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 53 );


dshippingsdk_fedexrates_set($res, 53, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ProxyPassword Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 54 );


dshippingsdk_fedexrates_set($res, 54, $value );

Default Value

''

Remarks

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

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

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

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

Data Type

String

ProxyPort Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 55 );


dshippingsdk_fedexrates_set($res, 55, $value );

Default Value

80

Remarks

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

Data Type

Integer

ProxyServer Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 56 );


dshippingsdk_fedexrates_set($res, 56, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 57 );


dshippingsdk_fedexrates_set($res, 57, $value );

Default Value

0

Remarks

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

Data Type

Integer

ProxyUser Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 58 );


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

RateType Property (DShippingSDK_FedExRates Class)

Indicates the type of rates to be returned.

Object Oriented Interface

public function getRateType();


public function setRateType($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 59 );


dshippingsdk_fedexrates_set($res, 59, $value );

Default Value

1

Remarks

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

Data Type

Integer

RecipientAddress1 Property (DShippingSDK_FedExRates Class)

Street name.

Object Oriented Interface

public function getRecipientAddress1();


public function setRecipientAddress1($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 60 );


dshippingsdk_fedexrates_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 RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 61 );


dshippingsdk_fedexrates_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 RecipientAddress2 should not exceed 35 characters.

Data Type

String

RecipientAddressFlags Property (DShippingSDK_FedExRates Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getRecipientAddressFlags();


public function setRecipientAddressFlags($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 62 );


dshippingsdk_fedexrates_set($res, 62, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (DShippingSDK_FedExRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getRecipientCity();


public function setRecipientCity($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 63 );


dshippingsdk_fedexrates_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

RecipientCountryCode Property (DShippingSDK_FedExRates Class)

Country code.

Object Oriented Interface

public function getRecipientCountryCode();


public function setRecipientCountryCode($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 64 );


dshippingsdk_fedexrates_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

RecipientState Property (DShippingSDK_FedExRates Class)

State or province code.

Object Oriented Interface

public function getRecipientState();


public function setRecipientState($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 65 );


dshippingsdk_fedexrates_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

RecipientZipCode Property (DShippingSDK_FedExRates Class)

Postal code.

Object Oriented Interface

public function getRecipientZipCode();


public function setRecipientZipCode($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 66 );


dshippingsdk_fedexrates_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 RecipientCity and RecipientState are not present.

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

Data Type

String

RequestedService Property (DShippingSDK_FedExRates Class)

Service type for which the shipping rate is requested.

Object Oriented Interface

public function getRequestedService();


public function setRequestedService($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 67 );


dshippingsdk_fedexrates_set($res, 67, $value );

Default Value

0

Remarks

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

Otherwise, the rate request will be considered by FedEx server as it has been made for all available services and respective rates.

Valid values for FedEx are:

Data Type

Integer

SenderAddress1 Property (DShippingSDK_FedExRates Class)

Street name.

Object Oriented Interface

public function getSenderAddress1();


public function setSenderAddress1($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 68 );


dshippingsdk_fedexrates_set($res, 68, $value );

Default Value

''

Remarks

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

Data Type

String

SenderAddress2 Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 69 );


dshippingsdk_fedexrates_set($res, 69, $value );

Default Value

''

Remarks

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

Data Type

String

SenderAddressFlags Property (DShippingSDK_FedExRates Class)

Various flags that denote information about the address.

Object Oriented Interface

public function getSenderAddressFlags();


public function setSenderAddressFlags($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 70 );


dshippingsdk_fedexrates_set($res, 70, $value );

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

SenderCity Property (DShippingSDK_FedExRates Class)

Name of city, town, etc.

Object Oriented Interface

public function getSenderCity();


public function setSenderCity($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 71 );


dshippingsdk_fedexrates_set($res, 71, $value );

Default Value

''

Remarks

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

Data Type

String

SenderCountryCode Property (DShippingSDK_FedExRates Class)

Country code.

Object Oriented Interface

public function getSenderCountryCode();


public function setSenderCountryCode($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 72 );


dshippingsdk_fedexrates_set($res, 72, $value );

Default Value

'US'

Remarks

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

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

* Not supported by USPS

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

Data Type

String

SenderState Property (DShippingSDK_FedExRates Class)

State or province code.

Object Oriented Interface

public function getSenderState();


public function setSenderState($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 73 );


dshippingsdk_fedexrates_set($res, 73, $value );

Default Value

''

Remarks

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

Data Type

String

SenderZipCode Property (DShippingSDK_FedExRates Class)

Postal code.

Object Oriented Interface

public function getSenderZipCode();


public function setSenderZipCode($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 74 );


dshippingsdk_fedexrates_set($res, 74, $value );

Default Value

''

Remarks

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

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

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

Data Type

String

ServiceCount Property (DShippingSDK_FedExRates Class)

The number of records in the Service arrays.

Object Oriented Interface

public function getServiceCount();

Procedural Interface

dshippingsdk_fedexrates_get($res, 75 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ServiceAccountBaseCharge
• ServiceAccountNetCharge
• ServiceAccountTotalDiscount
• ServiceAccountTotalSurcharge
• ServiceAggregate
• ServiceDeliveryDate
• ServiceDeliveryDay
• ServiceEffectiveNetDiscount
• ServiceListBaseCharge
• ServiceListNetCharge
• ServiceListTotalDiscount
• ServiceListTotalSurcharge
• ServiceRateScale
• ServiceRateZone
• 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_FedExRates Class)

Transportation charges before surcharges and discounts applied to a ServiceType .

Object Oriented Interface

public function getServiceAccountBaseCharge($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 76 , $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_FedExRates Class)

Net charge amount applied to a ServiceType .

Object Oriented Interface

public function getServiceAccountNetCharge($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 77 , $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_FedExRates Class)

Total discount amount applied to the shipment for a ServiceType .

Object Oriented Interface

public function getServiceAccountTotalDiscount($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 78 , $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_FedExRates Class)

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

Object Oriented Interface

public function getServiceAccountTotalSurcharge($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 79 , $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_FedExRates 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_fedexrates_get($res, 80 , $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

ServiceDeliveryDate Property (DShippingSDK_FedExRates Class)

This indicates the shipment delivery date for the ServiceType .

Object Oriented Interface

public function getServiceDeliveryDate($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 85 , $serviceidx);

Default Value

''

Remarks

This indicates the shipment delivery date for the ServiceType.

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

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

This is not applicable to USPS.

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

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

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

Data Type

String

ServiceDeliveryDay Property (DShippingSDK_FedExRates Class)

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

Object Oriented Interface

public function getServiceDeliveryDay($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 86 , $serviceidx);

Default Value

''

Remarks

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

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

This is not applicable to USPS.

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

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

Data Type

String

ServiceEffectiveNetDiscount Property (DShippingSDK_FedExRates Class)

Indicates the net discount applied to a ServiceType .

Object Oriented Interface

public function getServiceEffectiveNetDiscount($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 88 , $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_FedExRates Class)

Transportation charges before surcharges and discounts applied to a ServiceType .

Object Oriented Interface

public function getServiceListBaseCharge($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 94 , $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_FedExRates Class)

Net charge amount applied to a ServiceType .

Object Oriented Interface

public function getServiceListNetCharge($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 95 , $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_FedExRates Class)

Total discount amount applied to a ServiceType .

Object Oriented Interface

public function getServiceListTotalDiscount($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 96 , $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_FedExRates Class)

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

Object Oriented Interface

public function getServiceListTotalSurcharge($serviceidx);

Procedural Interface

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

ServiceRateScale Property (DShippingSDK_FedExRates Class)

Applicable rate scale for the ServiceType .

Object Oriented Interface

public function getServiceRateScale($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 101 , $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_FedExRates Class)

Applicable rate zone for the ServiceType .

Object Oriented Interface

public function getServiceRateZone($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 102 , $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_FedExRates Class)

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

Object Oriented Interface

public function getServiceType($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 104 , $serviceidx);

Default Value

0

Remarks

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

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

Valid values for FedEx are:

Valid values for UPS are:

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

Valid values for USPS are:

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

Valid values for Canada Post are:

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

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

Data Type

Integer

ServiceTypeDescription Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 105 , $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

ServiceSignatureType Property (DShippingSDK_FedExRates 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_fedexrates_get($res, 108 , $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_FedExRates Class)

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

Object Oriented Interface

public function getServiceTransitTime($serviceidx);

Procedural Interface

dshippingsdk_fedexrates_get($res, 109 , $serviceidx);

Default Value

''

Remarks

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

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

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

Data Type

String

ShipDate Property (DShippingSDK_FedExRates Class)

The date on which the package will be shipped.

Object Oriented Interface

public function getShipDate();


public function setShipDate($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 110 );


dshippingsdk_fedexrates_set($res, 110, $value );

Default Value

''

Remarks

This property value is optional to be entered in the request. This might affect the service availability.

The date should be the current date, or a date no more than 10 days in the future.

Defaults to current system date if not present.

Supported date formats are "yyyy-MM-dd" and "yyyy-MM-ddTHH:mm:ss".

Data Type

String

ShipmentSpecialServices Property (DShippingSDK_FedExRates Class)

Contains the collection of special services offered by FedEx.

Object Oriented Interface

public function getShipmentSpecialServices();


public function setShipmentSpecialServices($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 111 );


dshippingsdk_fedexrates_set($res, 111, $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:

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

• COD: Indicates that this is a COD shipment. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the PackageCODAmount and PackageCODType must also be provided in the request.
• Dry Ice: Indicates that the shipment contains dry ice. This might affect the shipping rates and service availability. When this service is requested (i.e., when the corresponding Dry Ice flag is contained in the ShipmentSpecialServices), then the DryIceCount and PackageDryIceWeight are required to be specified in the request (shipment level).
• Event Notification: Indicates that event notification is requested. This might affect the service availability.
• Hold At Location: This is applicable for FedEx Express services only. Indicates that the FedEx shipment is to be held at the destination FedEx location for pickup by the recipient. The request of this special service might affect the shipping rates and/or service availability. This service is not valid with the Hold Saturday service, and when the Residential flag is set in RecipientAddressFlags (i.e., for residential delivery). When this service is requested (i.e., when the corresponding Hold At Location flag is contained in the ShipmentSpecialServices), then the HoldAtLocation is required to be provided in the request as well.
• Home Delivery: Indicates that the Home Delivery Premium special service is requested. This is applicable for residential delivery only (i.e., when this is present in the request, the Residential flag in RecipientAddressFlags is automatically set in the request). If ServiceType is set to GROUND HOME DELIVERY, the corresponding flag of Home Delivery is automatically added to the ShipmentSpecialServices. In this case, the HomeDeliveryDate, HomeDeliveryPhone, and HomeDeliveryType properties are required to be provided in the request as well. This property is applicable for FedEx Ground services only.
• Inside Delivery: Indicates that inside delivery service is requested. In this case, FedEx may move shipments to positions beyond the adjacent loading area. In doing so, FedEx will assess an inside delivery charge in addition to all other applicable charges. The adjacent loading area is defined as a delivery site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. FedEx will assess an inside delivery charge when shipment breakdown is necessary to fit a shipment through a doorway. FedEx does not provide piece count or piece verification when a breakdown of a freight shipment occurs at the delivery site. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
• Inside Pickup: Indicates that inside pickup service is requested. In this case, FedEx may move shipments from positions beyond the adjacent loading area. In doing so, FedEx will assess an inside pickup charge in addition to all other applicable charges. The adjacent loading area is defined as a pickup site that is directly accessible from the curb and is no more than 50 feet inside the outermost door. Current FedEx surcharge for this option: US$0.0412 per lb./$0.0908 per kg (US$60 minimum).
• Return Shipment: Indicates that this shipment is a return one. This might affect the shipping rates and/or service availability.
• Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on Thursday or Friday and you want Saturday delivery, the ground option and some express option will not be valid.
• Saturday Pickup: Indicates that you request to have the shipment picked up on a Saturday. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair. This service is available for: FedEx Priority Overnight, FedEx 2day, FedEx International Priority, FedEx 1Day Freight, and FedEx 2Day Freight. The rates and service availability depend on the ship date specified in the request. If the ship date falls on week day other than Saturday and you want Saturday pickup, the ground option and some express option will not be valid.
• ThirdParty Consignee: Indicates that the third party special service is requested. This is applicable to domestic shipments only. This might affect the shipping rates and/or service availability.
• Broker Select: Indicates that the broker select special service is requested. When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:
  • stFedExInternationalPriority (20)
  • stFedExInternationalEconomy (21)
  • stFedExInternationalPriorityFreight (23)
  • stFedExInternationalEconomyFreight (24)
  • stFedExInternationalPriorityExpress (32)
  • stFedExInternationalConnectPlus (33)
  FedEx International Broker Select is a contract service. Before you begin using FedEx International Broker Select (BSO), you must contact your FedEx account executive to be enrolled for this service. An additional routing surcharge applies to your BSO shipments if you choose to have FedEx complete delivery after customs clearance and if your recipient and customs broker are served by different FedEx clearance points. This service is not valid with SaturdayPickup/SaturdayDelivery services. When this service is requested, then the ClearanceBrokerageType, BrokerType, BrokerContact, and BrokerAddress are required to be provided in the ship request as well.

  Note: Certain customs limitations may apply for BSO shipments. Contact FedEx Express International customer service at 1.800.247.4747 for requirements.

• East Coast Special: Indicates that East Coast special service is requested. This is applicable to domestic shipments only. This might affect the shipping rates and/or service availability.

Data Type

Long64

SSLAcceptServerCertEncoded Property (DShippingSDK_FedExRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 113 );


dshippingsdk_fedexrates_set($res, 113, $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_FedExRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 141 );


dshippingsdk_fedexrates_set($res, 141, $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_FedExRates 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_fedexrates_get($res, 157 );


dshippingsdk_fedexrates_set($res, 157, $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_FedExRates 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_fedexrates_get($res, 158 );


dshippingsdk_fedexrates_set($res, 158, $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_FedExRates Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 159 );


dshippingsdk_fedexrates_set($res, 159, $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_FedExRates 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_fedexrates_get($res, 160 );


dshippingsdk_fedexrates_set($res, 160, $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_FedExRates Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 168 );


dshippingsdk_fedexrates_set($res, 168, $value );

Default Value

0

Remarks

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

Possible values are:

Additional Notes

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

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

Data Type

Integer

SSLServerCertEncoded Property (DShippingSDK_FedExRates Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

dshippingsdk_fedexrates_get($res, 170 );

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

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 197 );


dshippingsdk_fedexrates_set($res, 197, $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_FedExRates Class)

The total weight of all the pieces in this shipment.

Object Oriented Interface

public function getTotalWeight();


public function setTotalWeight($value);

Procedural Interface

dshippingsdk_fedexrates_get($res, 198 );


dshippingsdk_fedexrates_set($res, 198, $value );

Default Value

''

Remarks

This property is required when submitting a rate request by calling GetRates method. It requires one explicit decimal position (i.e. N.N formatting, example 5.0) and has a maximum length of 12 including the decimal.

Data Type

String

Config Method (DShippingSDK_FedExRates Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

dshippingsdk_fedexrates_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_FedExRates Class)

Returns rate information for a specified or all available FedEx services.

Object Oriented Interface

public function doGetRates();

Procedural Interface

dshippingsdk_fedexrates_do_getrates($res);

Remarks

To get the courtesy rate quotes for FedEx services, you can call the GetRates method. If the rates are needed for a specific service type, you will have to pass a value of the RequestedService (other than 'UNSPECIFIED') in the request. The RequestedService identifies the FedEx service for which you want to retrieve rate information. If the rates are wanted for all available FedEx services, you should not set a value to RequestedService before sending the request to the FedEx Server. It will default to 'UNSPECIFIED').

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):

• FedExAuthorizationToken (required)
• FedExServer (optional)
• FedExAccountNumber (required)
• RateType (required)
• ShipDate (optional)
• PackageType (required)
• SenderAddress (required)
• RecipientAddress (required)
• TotalWeight (required)
• InsuredValue (optional)
• Packages (required)
• ShipmentSpecialServices that can affect rates and/or service availability (such as COD, Saturday Pickup, Saturday Delivery, Hold At Location, Dry Ice, etc.) (optional)

Regarding the Packages, please note the following:

• when requesting rates for all available services (RequestedService set to 'UNSPECIFIED'), only one package should be added to this collection even for MPS. When rating MPS, just specify the Packages and the details for one package only. FedEx will consider all packages the same;
• when requesting rates for a specific service (RequestedService set to a value other than 'UNSPECIFIED'), you will have to add as many packages as there are in the MPS specifying the package detail for each package included in the shipment.

In each above mentioned cases, if there are no packages added and specified (Packages = null), the class will throw an error.

Upon a successful response, the Services property gets populated.

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

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

Reset Method (DShippingSDK_FedExRates Class)

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

Object Oriented Interface

public function doReset();

Procedural Interface

dshippingsdk_fedexrates_do_reset($res);

Remarks

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

Error Event (DShippingSDK_FedExRates Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

dshippingsdk_fedexrates_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_FedExRates Class)

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

Object Oriented Interface

public function fireNotification($param);

Procedural Interface

dshippingsdk_fedexrates_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_FedExRates Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

dshippingsdk_fedexrates_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_FedExRates Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

dshippingsdk_fedexrates_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 (FedExRates Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

FedExRates Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (FedExRates Class)

FedExRates Errors

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

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