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.

Syntax

FedExRates

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

The total amount to be collected on delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCODTotalAmount();
int SetCODTotalAmount(const char* lpszCODTotalAmount);

Unicode (Windows)
LPWSTR GetCODTotalAmount();
INT SetCODTotalAmount(LPCWSTR lpszCODTotalAmount);

char* dshippingsdk_fedexrates_getcodtotalamount(void* lpObj);
int dshippingsdk_fedexrates_setcodtotalamount(void* lpObj, const char* lpszCODTotalAmount);

QString GetCODTotalAmount();
int SetCODTotalAmount(QString qsCODTotalAmount);

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

COD type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCODType();
int SetCODType(int iCODType);

Unicode (Windows)
INT GetCODType();
INT SetCODType(INT iCODType);

CODT_ANY(0), 
CODT_CASH(1), 
CODT_GUARANTEED_FUNDS(2), 
CODT_COMPANY_CHECK(3), 
CODT_PERSONAL_CHECK(4)

int dshippingsdk_fedexrates_getcodtype(void* lpObj);
int dshippingsdk_fedexrates_setcodtype(void* lpObj, int iCODType);

int GetCODType();
int SetCODType(int iCODType);

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

The account number associated with the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExAccountNumber();
int SetFedExAccountNumber(const char* lpszFedExAccountNumber);

Unicode (Windows)
LPWSTR GetFedExAccountNumber();
INT SetFedExAccountNumber(LPCWSTR lpszFedExAccountNumber);

char* dshippingsdk_fedexrates_getfedexaccountnumber(void* lpObj);
int dshippingsdk_fedexrates_setfedexaccountnumber(void* lpObj, const char* lpszFedExAccountNumber);

QString GetFedExAccountNumber();
int SetFedExAccountNumber(QString qsFedExAccountNumber);

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

Authorization Token used to authenticate the request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExAuthorizationToken();
int SetFedExAuthorizationToken(const char* lpszFedExAuthorizationToken);

Unicode (Windows)
LPWSTR GetFedExAuthorizationToken();
INT SetFedExAuthorizationToken(LPCWSTR lpszFedExAuthorizationToken);

char* dshippingsdk_fedexrates_getfedexauthorizationtoken(void* lpObj);
int dshippingsdk_fedexrates_setfedexauthorizationtoken(void* lpObj, const char* lpszFedExAuthorizationToken);

QString GetFedExAuthorizationToken();
int SetFedExAuthorizationToken(QString qsFedExAuthorizationToken);

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

Two-letter code for the language (e.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExLanguageCode();
int SetFedExLanguageCode(const char* lpszFedExLanguageCode);

Unicode (Windows)
LPWSTR GetFedExLanguageCode();
INT SetFedExLanguageCode(LPCWSTR lpszFedExLanguageCode);

char* dshippingsdk_fedexrates_getfedexlanguagecode(void* lpObj);
int dshippingsdk_fedexrates_setfedexlanguagecode(void* lpObj, const char* lpszFedExLanguageCode);

QString GetFedExLanguageCode();
int SetFedExLanguageCode(QString qsFedExLanguageCode);

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

Two-letter code for the region (e.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExLocaleCode();
int SetFedExLocaleCode(const char* lpszFedExLocaleCode);

Unicode (Windows)
LPWSTR GetFedExLocaleCode();
INT SetFedExLocaleCode(LPCWSTR lpszFedExLocaleCode);

char* dshippingsdk_fedexrates_getfedexlocalecode(void* lpObj);
int dshippingsdk_fedexrates_setfedexlocalecode(void* lpObj, const char* lpszFedExLocaleCode);

QString GetFedExLocaleCode();
int SetFedExLocaleCode(QString qsFedExLocaleCode);

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

URL for the FedEx Server where the requests are sent.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExServer();
int SetFedExServer(const char* lpszFedExServer);

Unicode (Windows)
LPWSTR GetFedExServer();
INT SetFedExServer(LPCWSTR lpszFedExServer);

char* dshippingsdk_fedexrates_getfedexserver(void* lpObj);
int dshippingsdk_fedexrates_setfedexserver(void* lpObj, const char* lpszFedExServer);

QString GetFedExServer();
int SetFedExServer(QString qsFedExServer);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallAutoDetect();
int SetFirewallAutoDetect(int bFirewallAutoDetect);

Unicode (Windows)
BOOL GetFirewallAutoDetect();
INT SetFirewallAutoDetect(BOOL bFirewallAutoDetect);

int dshippingsdk_fedexrates_getfirewallautodetect(void* lpObj);
int dshippingsdk_fedexrates_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

bool GetFirewallAutoDetect();
int SetFirewallAutoDetect(bool bFirewallAutoDetect);

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

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallType();
int SetFirewallType(int iFirewallType);

Unicode (Windows)
INT GetFirewallType();
INT SetFirewallType(INT iFirewallType);

FW_NONE(0), 
FW_TUNNEL(1), 
FW_SOCKS4(2), 
FW_SOCKS5(3), 
FW_SOCKS4A(10)

int dshippingsdk_fedexrates_getfirewalltype(void* lpObj);
int dshippingsdk_fedexrates_setfirewalltype(void* lpObj, int iFirewallType);

int GetFirewallType();
int SetFirewallType(int iFirewallType);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallHost();
int SetFirewallHost(const char* lpszFirewallHost);

Unicode (Windows)
LPWSTR GetFirewallHost();
INT SetFirewallHost(LPCWSTR lpszFirewallHost);

char* dshippingsdk_fedexrates_getfirewallhost(void* lpObj);
int dshippingsdk_fedexrates_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

QString GetFirewallHost();
int SetFirewallHost(QString qsFirewallHost);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallPassword();
int SetFirewallPassword(const char* lpszFirewallPassword);

Unicode (Windows)
LPWSTR GetFirewallPassword();
INT SetFirewallPassword(LPCWSTR lpszFirewallPassword);

char* dshippingsdk_fedexrates_getfirewallpassword(void* lpObj);
int dshippingsdk_fedexrates_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

QString GetFirewallPassword();
int SetFirewallPassword(QString qsFirewallPassword);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

Unicode (Windows)
INT GetFirewallPort();
INT SetFirewallPort(INT iFirewallPort);

int dshippingsdk_fedexrates_getfirewallport(void* lpObj);
int dshippingsdk_fedexrates_setfirewallport(void* lpObj, int iFirewallPort);

int GetFirewallPort();
int SetFirewallPort(int iFirewallPort);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFirewallUser();
int SetFirewallUser(const char* lpszFirewallUser);

Unicode (Windows)
LPWSTR GetFirewallUser();
INT SetFirewallUser(LPCWSTR lpszFirewallUser);

char* dshippingsdk_fedexrates_getfirewalluser(void* lpObj);
int dshippingsdk_fedexrates_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

QString GetFirewallUser();
int SetFirewallUser(QString qsFirewallUser);

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

The date the freight shipment is guaranteed for.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFreightGuaranteeDate();
int SetFreightGuaranteeDate(const char* lpszFreightGuaranteeDate);

Unicode (Windows)
LPWSTR GetFreightGuaranteeDate();
INT SetFreightGuaranteeDate(LPCWSTR lpszFreightGuaranteeDate);

char* dshippingsdk_fedexrates_getfreightguaranteedate(void* lpObj);
int dshippingsdk_fedexrates_setfreightguaranteedate(void* lpObj, const char* lpszFreightGuaranteeDate);

QString GetFreightGuaranteeDate();
int SetFreightGuaranteeDate(QString qsFreightGuaranteeDate);

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

Specifies what type of freight guarantee is requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetFreightGuaranteeType();
int SetFreightGuaranteeType(int iFreightGuaranteeType);

Unicode (Windows)
INT GetFreightGuaranteeType();
INT SetFreightGuaranteeType(INT iFreightGuaranteeType);

FGT_GUARANTEED_DATE(0), 
FGT_GUARANTEED_MORNING(1)

int dshippingsdk_fedexrates_getfreightguaranteetype(void* lpObj);
int dshippingsdk_fedexrates_setfreightguaranteetype(void* lpObj, int iFreightGuaranteeType);

int GetFreightGuaranteeType();
int SetFreightGuaranteeType(int iFreightGuaranteeType);

Default Value

0

Remarks

Specifies what type of freight guarantee is requested.

The valid values are:

Data Type

Integer

HomeDeliveryDate Property (FedExRates Class)

Date for Ground Home Delivery service.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHomeDeliveryDate();
int SetHomeDeliveryDate(const char* lpszHomeDeliveryDate);

Unicode (Windows)
LPWSTR GetHomeDeliveryDate();
INT SetHomeDeliveryDate(LPCWSTR lpszHomeDeliveryDate);

char* dshippingsdk_fedexrates_gethomedeliverydate(void* lpObj);
int dshippingsdk_fedexrates_sethomedeliverydate(void* lpObj, const char* lpszHomeDeliveryDate);

QString GetHomeDeliveryDate();
int SetHomeDeliveryDate(QString qsHomeDeliveryDate);

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

The phone number of the delivery location.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHomeDeliveryPhone();
int SetHomeDeliveryPhone(const char* lpszHomeDeliveryPhone);

Unicode (Windows)
LPWSTR GetHomeDeliveryPhone();
INT SetHomeDeliveryPhone(LPCWSTR lpszHomeDeliveryPhone);

char* dshippingsdk_fedexrates_gethomedeliveryphone(void* lpObj);
int dshippingsdk_fedexrates_sethomedeliveryphone(void* lpObj, const char* lpszHomeDeliveryPhone);

QString GetHomeDeliveryPhone();
int SetHomeDeliveryPhone(QString qsHomeDeliveryPhone);

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

The type of Home Delivery Premium service being requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetHomeDeliveryType();
int SetHomeDeliveryType(int iHomeDeliveryType);

Unicode (Windows)
INT GetHomeDeliveryType();
INT SetHomeDeliveryType(INT iHomeDeliveryType);

HDT_APPOINTMENT(0), 
HDT_DATE_CERTAIN(1), 
HDT_EVENING(2)

int dshippingsdk_fedexrates_gethomedeliverytype(void* lpObj);
int dshippingsdk_fedexrates_sethomedeliverytype(void* lpObj, int iHomeDeliveryType);

int GetHomeDeliveryType();
int SetHomeDeliveryType(int iHomeDeliveryType);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetInsuredValue();
int SetInsuredValue(const char* lpszInsuredValue);

Unicode (Windows)
LPWSTR GetInsuredValue();
INT SetInsuredValue(LPCWSTR lpszInsuredValue);

char* dshippingsdk_fedexrates_getinsuredvalue(void* lpObj);
int dshippingsdk_fedexrates_setinsuredvalue(void* lpObj, const char* lpszInsuredValue);

QString GetInsuredValue();
int SetInsuredValue(QString qsInsuredValue);

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

The number of records in the Package arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCount();
int SetPackageCount(int iPackageCount);

Unicode (Windows)
INT GetPackageCount();
INT SetPackageCount(INT iPackageCount);

int dshippingsdk_fedexrates_getpackagecount(void* lpObj);
int dshippingsdk_fedexrates_setpackagecount(void* lpObj, int iPackageCount);

int GetPackageCount();
int SetPackageCount(int iPackageCount);

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

The COD monetary value for the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageCODAmount(int iPackageIdx);
int SetPackageCODAmount(int iPackageIdx, const char* lpszPackageCODAmount);

Unicode (Windows)
LPWSTR GetPackageCODAmount(INT iPackageIdx);
INT SetPackageCODAmount(INT iPackageIdx, LPCWSTR lpszPackageCODAmount);

char* dshippingsdk_fedexrates_getpackagecodamount(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackagecodamount(void* lpObj, int packageidx, const char* lpszPackageCODAmount);

QString GetPackageCODAmount(int iPackageIdx);
int SetPackageCODAmount(int iPackageIdx, QString qsPackageCODAmount);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCODType(int iPackageIdx);
int SetPackageCODType(int iPackageIdx, int iPackageCODType);

Unicode (Windows)
INT GetPackageCODType(INT iPackageIdx);
INT SetPackageCODType(INT iPackageIdx, INT iPackageCODType);

CODTP_ANY(0), 
CODTP_CASH(1), 
CODTP_GUARANTEED_FUNDS(2), 
CODTP_COMPANY_CHECK(3), 
CODTP_PERSONAL_CHECK(4)

int dshippingsdk_fedexrates_getpackagecodtype(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackagecodtype(void* lpObj, int packageidx, int iPackageCODType);

int GetPackageCODType(int iPackageIdx);
int SetPackageCODType(int iPackageIdx, int iPackageCODType);

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

The height of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

Unicode (Windows)
INT GetPackageHeight(INT iPackageIdx);
INT SetPackageHeight(INT iPackageIdx, INT iPackageHeight);

int dshippingsdk_fedexrates_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackageheight(void* lpObj, int packageidx, int iPackageHeight);

int GetPackageHeight(int iPackageIdx);
int SetPackageHeight(int iPackageIdx, int iPackageHeight);

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

Amount of insurance requested for this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, const char* lpszPackageInsuredValue);

Unicode (Windows)
LPWSTR GetPackageInsuredValue(INT iPackageIdx);
INT SetPackageInsuredValue(INT iPackageIdx, LPCWSTR lpszPackageInsuredValue);

char* dshippingsdk_fedexrates_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackageinsuredvalue(void* lpObj, int packageidx, const char* lpszPackageInsuredValue);

QString GetPackageInsuredValue(int iPackageIdx);
int SetPackageInsuredValue(int iPackageIdx, QString qsPackageInsuredValue);

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

The length of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

Unicode (Windows)
INT GetPackageLength(INT iPackageIdx);
INT SetPackageLength(INT iPackageIdx, INT iPackageLength);

int dshippingsdk_fedexrates_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackagelength(void* lpObj, int packageidx, int iPackageLength);

int GetPackageLength(int iPackageIdx);
int SetPackageLength(int iPackageIdx, int iPackageLength);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

Unicode (Windows)
INT GetPackageType(INT iPackageIdx);
INT SetPackageType(INT iPackageIdx, INT iPackageType);

PT_NONE(0), 
PT_POSTCARDS(1), 
PT_LETTER(2), 
PT_LARGE_ENVELOPE(3), 
PT_FLAT_RATE_ENVELOPE(4), 
PT_FLAT_RATE_LEGAL_ENVELOPE(5), 
PT_FLAT_RATE_PADDED_ENVELOPE(6), 
PT_FLAT_RATE_GIFT_CARD_ENVELOPE(7), 
PT_FLAT_RATE_WINDOW_ENVELOPE(8), 
PT_FLAT_RATE_CARDBOARD_ENVELOPE(9), 
PT_SMALL_FLAT_RATE_ENVELOPE(10), 
PT_PAK(11), 
PT_BOX(12), 
PT_10KG_BOX(13), 
PT_25KG_BOX(14), 
PT_SMALL_EXPRESS_BOX(15), 
PT_MEDIUM_EXPRESS_BOX(16), 
PT_LARGE_EXPRESS_BOX(17), 
PT_FLAT_RATE_BOX(18), 
PT_SMALL_FLAT_RATE_BOX(19), 
PT_MEDIUM_FLAT_RATE_BOX(20), 
PT_LARGE_FLAT_RATE_BOX(21), 
PT_DVDFLAT_RATE_BOX(22), 
PT_LARGE_VIDEO_FLAT_RATE_BOX(23), 
PT_REGIONAL_RATE_BOX_A(24), 
PT_REGIONAL_RATE_BOX_B(25), 
PT_RECTANGULAR(26), 
PT_NON_RECTANGULAR(27), 
PT_TUBE(28), 
PT_MATTER_FOR_THE_BLIND(29), 
PT_PALLET(30), 
PT_YOUR_PACKAGING(31), 
PT_DOCUMENT(32), 
PT_FLATS(33), 
PT_PARCELS(34), 
PT_BPM(35), 
PT_FIRST_CLASS(36), 
PT_PRIORITY(37), 
PT_MACHINABLES(38), 
PT_IRREGULARS(39), 
PT_PARCEL_POST(40), 
PT_BPMPARCEL(41), 
PT_MEDIA_MAIL(42), 
PT_BPMFLAT(43), 
PT_STANDARD_FLAT(44), 
PT_REGIONAL_RATE_BOX_C(45), 
PT_THICK_ENVELOPE(46), 
PT_SMALL_BOX(47), 
PT_MEDIUM_BOX(48), 
PT_LARGE_BOX(49), 
PT_EXTRA_LARGE_BOX(50), 
PT_PACKAGE_SERVICE(51), 
PT_CUBIC_PARCELS(52), 
PT_CUBIC_SOFT_PACK(53)

int dshippingsdk_fedexrates_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackagetype(void* lpObj, int packageidx, int iPackageType);

int GetPackageType(int iPackageIdx);
int SetPackageType(int iPackageIdx, int iPackageType);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

Unicode (Windows)
INT GetPackageSignatureType(INT iPackageIdx);
INT SetPackageSignatureType(INT iPackageIdx, INT iPackageSignatureType);

ST_SERVICE_DEFAULT(0), 
ST_ADULT(1), 
ST_DIRECT(2), 
ST_INDIRECT(3), 
ST_NO_SIGNATURE_REQUIRED(4), 
ST_USPSDELIVERY_CONFIRMATION(5), 
ST_ADULT_19(6)

int dshippingsdk_fedexrates_getpackagesignaturetype(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackagesignaturetype(void* lpObj, int packageidx, int iPackageSignatureType);

int GetPackageSignatureType(int iPackageIdx);
int SetPackageSignatureType(int iPackageIdx, int iPackageSignatureType);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int64 GetPackageSpecialServices(int iPackageIdx);
int SetPackageSpecialServices(int iPackageIdx, int64 lPackageSpecialServices);

Unicode (Windows)
LONG64 GetPackageSpecialServices(INT iPackageIdx);
INT SetPackageSpecialServices(INT iPackageIdx, LONG64 lPackageSpecialServices);

int64 dshippingsdk_fedexrates_getpackagespecialservices(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackagespecialservices(void* lpObj, int packageidx, int64 lPackageSpecialServices);

qint64 GetPackageSpecialServices(int iPackageIdx);
int SetPackageSpecialServices(int iPackageIdx, qint64 lPackageSpecialServices);

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

Weight of this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, const char* lpszPackageWeight);

Unicode (Windows)
LPWSTR GetPackageWeight(INT iPackageIdx);
INT SetPackageWeight(INT iPackageIdx, LPCWSTR lpszPackageWeight);

char* dshippingsdk_fedexrates_getpackageweight(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackageweight(void* lpObj, int packageidx, const char* lpszPackageWeight);

QString GetPackageWeight(int iPackageIdx);
int SetPackageWeight(int iPackageIdx, QString qsPackageWeight);

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

The width of the package to be shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

Unicode (Windows)
INT GetPackageWidth(INT iPackageIdx);
INT SetPackageWidth(INT iPackageIdx, INT iPackageWidth);

int dshippingsdk_fedexrates_getpackagewidth(void* lpObj, int packageidx);
int dshippingsdk_fedexrates_setpackagewidth(void* lpObj, int packageidx, int iPackageWidth);

int GetPackageWidth(int iPackageIdx);
int SetPackageWidth(int iPackageIdx, int iPackageWidth);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPickupType();
int SetPickupType(int iPickupType);

Unicode (Windows)
INT GetPickupType();
INT SetPickupType(INT iPickupType);

FPT_DROPOFF_AT_FEDEX_LOCATION(0), 
FPT_CONTACT_FEDEX_TO_SCHEDULE(1), 
FPT_USE_SCHEDULED_PICKUP(2), 
FPT_ON_CALL(3), 
FPT_PACKAGE_RETURN_PROGRAM(4), 
FPT_REGULAR_STOP(5), 
FPT_TAG(6), 
FPT_NONE(7)

int dshippingsdk_fedexrates_getpickuptype(void* lpObj);
int dshippingsdk_fedexrates_setpickuptype(void* lpObj, int iPickupType);

int GetPickupType();
int SetPickupType(int iPickupType);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

Unicode (Windows)
INT GetProxyAuthScheme();
INT SetProxyAuthScheme(INT iProxyAuthScheme);

AUTH_BASIC(0), 
AUTH_DIGEST(1), 
AUTH_PROPRIETARY(2), 
AUTH_NONE(3), 
AUTH_NTLM(4), 
AUTH_NEGOTIATE(5)

int dshippingsdk_fedexrates_getproxyauthscheme(void* lpObj);
int dshippingsdk_fedexrates_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

int GetProxyAuthScheme();
int SetProxyAuthScheme(int iProxyAuthScheme);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyAutoDetect();
int SetProxyAutoDetect(int bProxyAutoDetect);

Unicode (Windows)
BOOL GetProxyAutoDetect();
INT SetProxyAutoDetect(BOOL bProxyAutoDetect);

int dshippingsdk_fedexrates_getproxyautodetect(void* lpObj);
int dshippingsdk_fedexrates_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

bool GetProxyAutoDetect();
int SetProxyAutoDetect(bool bProxyAutoDetect);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyPassword();
int SetProxyPassword(const char* lpszProxyPassword);

Unicode (Windows)
LPWSTR GetProxyPassword();
INT SetProxyPassword(LPCWSTR lpszProxyPassword);

char* dshippingsdk_fedexrates_getproxypassword(void* lpObj);
int dshippingsdk_fedexrates_setproxypassword(void* lpObj, const char* lpszProxyPassword);

QString GetProxyPassword();
int SetProxyPassword(QString qsProxyPassword);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxyPort();
int SetProxyPort(int iProxyPort);

Unicode (Windows)
INT GetProxyPort();
INT SetProxyPort(INT iProxyPort);

int dshippingsdk_fedexrates_getproxyport(void* lpObj);
int dshippingsdk_fedexrates_setproxyport(void* lpObj, int iProxyPort);

int GetProxyPort();
int SetProxyPort(int iProxyPort);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyServer();
int SetProxyServer(const char* lpszProxyServer);

Unicode (Windows)
LPWSTR GetProxyServer();
INT SetProxyServer(LPCWSTR lpszProxyServer);

char* dshippingsdk_fedexrates_getproxyserver(void* lpObj);
int dshippingsdk_fedexrates_setproxyserver(void* lpObj, const char* lpszProxyServer);

QString GetProxyServer();
int SetProxyServer(QString qsProxyServer);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetProxySSL();
int SetProxySSL(int iProxySSL);

Unicode (Windows)
INT GetProxySSL();
INT SetProxySSL(INT iProxySSL);

PS_AUTOMATIC(0), 
PS_ALWAYS(1), 
PS_NEVER(2), 
PS_TUNNEL(3)

int dshippingsdk_fedexrates_getproxyssl(void* lpObj);
int dshippingsdk_fedexrates_setproxyssl(void* lpObj, int iProxySSL);

int GetProxySSL();
int SetProxySSL(int iProxySSL);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProxyUser();
int SetProxyUser(const char* lpszProxyUser);

Unicode (Windows)
LPWSTR GetProxyUser();
INT SetProxyUser(LPCWSTR lpszProxyUser);

char* dshippingsdk_fedexrates_getproxyuser(void* lpObj);
int dshippingsdk_fedexrates_setproxyuser(void* lpObj, const char* lpszProxyUser);

QString GetProxyUser();
int SetProxyUser(QString qsProxyUser);

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

Indicates the type of rates to be returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRateType();
int SetRateType(int iRateType);

Unicode (Windows)
INT GetRateType();
INT SetRateType(INT iRateType);

int dshippingsdk_fedexrates_getratetype(void* lpObj);
int dshippingsdk_fedexrates_setratetype(void* lpObj, int iRateType);

int GetRateType();
int SetRateType(int iRateType);

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

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress1();
int SetRecipientAddress1(const char* lpszRecipientAddress1);

Unicode (Windows)
LPWSTR GetRecipientAddress1();
INT SetRecipientAddress1(LPCWSTR lpszRecipientAddress1);

char* dshippingsdk_fedexrates_getrecipientaddress1(void* lpObj);
int dshippingsdk_fedexrates_setrecipientaddress1(void* lpObj, const char* lpszRecipientAddress1);

QString GetRecipientAddress1();
int SetRecipientAddress1(QString qsRecipientAddress1);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientAddress2();
int SetRecipientAddress2(const char* lpszRecipientAddress2);

Unicode (Windows)
LPWSTR GetRecipientAddress2();
INT SetRecipientAddress2(LPCWSTR lpszRecipientAddress2);

char* dshippingsdk_fedexrates_getrecipientaddress2(void* lpObj);
int dshippingsdk_fedexrates_setrecipientaddress2(void* lpObj, const char* lpszRecipientAddress2);

QString GetRecipientAddress2();
int SetRecipientAddress2(QString qsRecipientAddress2);

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

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRecipientAddressFlags();
int SetRecipientAddressFlags(int iRecipientAddressFlags);

Unicode (Windows)
INT GetRecipientAddressFlags();
INT SetRecipientAddressFlags(INT iRecipientAddressFlags);

int dshippingsdk_fedexrates_getrecipientaddressflags(void* lpObj);
int dshippingsdk_fedexrates_setrecipientaddressflags(void* lpObj, int iRecipientAddressFlags);

int GetRecipientAddressFlags();
int SetRecipientAddressFlags(int iRecipientAddressFlags);

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (FedExRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCity();
int SetRecipientCity(const char* lpszRecipientCity);

Unicode (Windows)
LPWSTR GetRecipientCity();
INT SetRecipientCity(LPCWSTR lpszRecipientCity);

char* dshippingsdk_fedexrates_getrecipientcity(void* lpObj);
int dshippingsdk_fedexrates_setrecipientcity(void* lpObj, const char* lpszRecipientCity);

QString GetRecipientCity();
int SetRecipientCity(QString qsRecipientCity);

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

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientCountryCode();
int SetRecipientCountryCode(const char* lpszRecipientCountryCode);

Unicode (Windows)
LPWSTR GetRecipientCountryCode();
INT SetRecipientCountryCode(LPCWSTR lpszRecipientCountryCode);

char* dshippingsdk_fedexrates_getrecipientcountrycode(void* lpObj);
int dshippingsdk_fedexrates_setrecipientcountrycode(void* lpObj, const char* lpszRecipientCountryCode);

QString GetRecipientCountryCode();
int SetRecipientCountryCode(QString qsRecipientCountryCode);

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

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientState();
int SetRecipientState(const char* lpszRecipientState);

Unicode (Windows)
LPWSTR GetRecipientState();
INT SetRecipientState(LPCWSTR lpszRecipientState);

char* dshippingsdk_fedexrates_getrecipientstate(void* lpObj);
int dshippingsdk_fedexrates_setrecipientstate(void* lpObj, const char* lpszRecipientState);

QString GetRecipientState();
int SetRecipientState(QString qsRecipientState);

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

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRecipientZipCode();
int SetRecipientZipCode(const char* lpszRecipientZipCode);

Unicode (Windows)
LPWSTR GetRecipientZipCode();
INT SetRecipientZipCode(LPCWSTR lpszRecipientZipCode);

char* dshippingsdk_fedexrates_getrecipientzipcode(void* lpObj);
int dshippingsdk_fedexrates_setrecipientzipcode(void* lpObj, const char* lpszRecipientZipCode);

QString GetRecipientZipCode();
int SetRecipientZipCode(QString qsRecipientZipCode);

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

Service type for which the shipping rate is requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestedService();
int SetRequestedService(int iRequestedService);

Unicode (Windows)
INT GetRequestedService();
INT SetRequestedService(INT iRequestedService);

ST_UNSPECIFIED(0), 
ST_FED_EX_PRIORITY_OVERNIGHT(10), 
ST_FED_EX_STANDARD_OVERNIGHT(11), 
ST_FED_EX_FIRST_OVERNIGHT(12), 
ST_FED_EX_2DAY(13), 
ST_FED_EX_EXPRESS_SAVER(14), 
ST_FED_EX_GROUND(15), 
ST_FED_EX_GROUND_HOME_DELIVERY(16), 
ST_FED_EX_1DAY_FREIGHT(17), 
ST_FED_EX_2DAY_FREIGHT(18), 
ST_FED_EX_3DAY_FREIGHT(19), 
ST_FED_EX_INTERNATIONAL_PRIORITY(20), 
ST_FED_EX_INTERNATIONAL_ECONOMY(21), 
ST_FED_EX_INTERNATIONAL_FIRST(22), 
ST_FED_EX_INTERNATIONAL_PRIORITY_FREIGHT(23), 
ST_FED_EX_INTERNATIONAL_ECONOMY_FREIGHT(24), 
ST_FED_EX_EUROPE_FIRST_INTERNATIONAL_PRIORITY(25), 
ST_FED_EX_SMART_POST(26), 
ST_FED_EX_2DAY_AM(27), 
ST_FED_EX_FIRST_FREIGHT(28), 
ST_FED_EX_INTERNATIONAL_GROUND(29), 
ST_FED_EX_FREIGHT_ECONOMY(30), 
ST_FED_EX_FREIGHT_PRIORITY(31), 
ST_FED_EX_INTERNATIONAL_PRIORITY_EXPRESS(32), 
ST_FED_EX_INTERNATIONAL_CONNECT_PLUS(33), 
ST_UPSFIRST_CLASS(35), 
ST_UPSPRIORITY_MAIL(36), 
ST_UPSEXPEDITED_MAIL_INNOVATIONS(37), 
ST_UPSPRIORITY_MAIL_INNOVATIONS(38), 
ST_UPSECONOMY_MAIL_INNOVATIONS(39), 
ST_UPSNEXT_DAY_AIR(40), 
ST_UPSEXPRESS(41), 
ST_UPS2ND_DAY_AIR(42), 
ST_UPSGROUND(43), 
ST_UPSWORLDWIDE_EXPRESS(44), 
ST_UPSWORLDWIDE_EXPEDITED(45), 
ST_UPSEXPEDITED(46), 
ST_UPSSTANDARD(47), 
ST_UPS3DAY_SELECT(48), 
ST_UPSNEXT_DAY_AIR_SAVER(49), 
ST_UPSSAVER(50), 
ST_UPSNEXT_DAY_AIR_EARLY_AM(51), 
ST_UPSEXPRESS_EARLY_AM(52), 
ST_UPSWORLDWIDE_EXPRESS_PLUS(53), 
ST_UPSEXPRESS_PLUS(54), 
ST_UPS2ND_DAY_AIR_AM(55), 
ST_UPSTODAY_STANDARD(56), 
ST_UPSTODAY_COURRIER(57), 
ST_UPSTODAY_INTER_CITY(58), 
ST_UPSTODAY_EXPRESS(59), 
ST_UPSTODAY_EXPRESS_SAVER(60), 
ST_UPSWORLDWIDE_EXPRESS_FREIGHT(61), 
ST_UPSSURE_POST_LESS_THAN_1LB(62), 
ST_UPSSURE_POST_1LBOR_GREATER(63), 
ST_UPSSURE_POST_BPM(64), 
ST_UPSSURE_POST_MEDIA(65), 
ST_USPSEXPRESS(70), 
ST_USPSFIRST_CLASS(71), 
ST_USPSPRIORITY(72), 
ST_USPSPARCEL_POST(73), 
ST_USPSBPM(74), 
ST_USPSMEDIA(75), 
ST_USPSLIBRARY(76), 
ST_USPSONLINE(77), 
ST_USPSGLOBAL_EXPRESS(78), 
ST_USPSPARCEL_SELECT(79), 
ST_USPSCRITICAL_MAIL(80), 
ST_USPSSTANDARD_MAIL(81), 
ST_USPSEXPRESS_MAIL_INTERNATIONAL(82), 
ST_USPSFIRST_CLASS_MAIL_INTERNATIONAL(83), 
ST_USPSPRIORITY_MAIL_INTERNATIONAL(84), 
ST_USPSPRIORITY_EXPRESS(85), 
ST_USPSRETAIL_GROUND(86), 
ST_USPSFIRST_CLASS_PACKAGE_INTERNATIONAL_SERVICE(87), 
ST_USPSPRIORITY_MAIL_EXPRESS_INTERNATIONAL(88), 
ST_CANADA_REGULAR_PARCEL(90), 
ST_CANADA_EXPEDITED_PARCEL(91), 
ST_CANADA_XPRESSPOST(92), 
ST_CANADA_LIBRARY(93), 
ST_CANADA_PRIORITY(94), 
ST_CANADA_PRIORITY_ENVELOPE_USA(95), 
ST_CANADA_PRIORITY_PAK_USA(96), 
ST_CANADA_PRIORITY_PARCEL_USA(97), 
ST_CANADA_XPRESSPOST_USA(98), 
ST_CANADA_EXPEDITED_PARCEL_USA(99), 
ST_CANADA_SMALL_PACKET_AIR_USA(100), 
ST_CANADA_TRACKED_PACKET_USA(101), 
ST_CANADA_TRACKED_PACKET_LVMUSA(102), 
ST_CANADA_PRIORITY_ENVELOPE_INTERNATIONAL(103), 
ST_CANADA_PRIORITY_PAK_INTERNATIONAL(104), 
ST_CANADA_PRIORITY_PARCEL_INTERNATIONAL(105), 
ST_CANADA_XPRESSPOST_INTERNATIONAL(106), 
ST_CANADA_SMALL_PACKET_AIR_INTERNATIONAL(107), 
ST_CANADA_SMALL_PACKET_LAND_INTERNATIONAL(108), 
ST_CANADA_PARCEL_AIR_INTERNATIONAL(109), 
ST_CANADA_PARCEL_LAND_INTERNATIONAL(110), 
ST_CANADA_TRACKED_PACKET_INTERNATIONAL(111), 
ST_FED_EX_SAME_DAY(126), 
ST_FED_EX_SAME_DAY_CITY(127), 
ST_FED_EX_SAME_DAY_METRO_AFTERNOON(128), 
ST_FED_EX_SAME_DAY_METRO_MORNING(129), 
ST_FED_EX_SAME_DAY_METRO_RUSH(130), 
ST_UPSWORLDWIDE_ECONOMY_DDU(131), 
ST_UPSWORLDWIDE_ECONOMY_DDP(132), 
ST_USPSPARCEL_SELECT_GROUND(133), 
ST_USPSPRIORITY_MAIL_CUBIC(134), 
ST_USPSGROUND_ADVANTAGE(135), 
ST_USPSGROUND_ADVANTAGE_CUBIC(136), 
ST_FED_EX_FIRST(140), 
ST_FED_EX_PRIORITY(141), 
ST_FED_EX_PRIORITY_EXPRESS(142), 
ST_FED_EX_PRIORITY_EXPRESS_FREIGHT(143), 
ST_FED_EX_PRIORITY_FREIGHT(144), 
ST_FED_EX_ECONOMY_SELECT(145)

int dshippingsdk_fedexrates_getrequestedservice(void* lpObj);
int dshippingsdk_fedexrates_setrequestedservice(void* lpObj, int iRequestedService);

int GetRequestedService();
int SetRequestedService(int iRequestedService);

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

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderAddress1();
int SetSenderAddress1(const char* lpszSenderAddress1);

Unicode (Windows)
LPWSTR GetSenderAddress1();
INT SetSenderAddress1(LPCWSTR lpszSenderAddress1);

char* dshippingsdk_fedexrates_getsenderaddress1(void* lpObj);
int dshippingsdk_fedexrates_setsenderaddress1(void* lpObj, const char* lpszSenderAddress1);

QString GetSenderAddress1();
int SetSenderAddress1(QString qsSenderAddress1);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderAddress2();
int SetSenderAddress2(const char* lpszSenderAddress2);

Unicode (Windows)
LPWSTR GetSenderAddress2();
INT SetSenderAddress2(LPCWSTR lpszSenderAddress2);

char* dshippingsdk_fedexrates_getsenderaddress2(void* lpObj);
int dshippingsdk_fedexrates_setsenderaddress2(void* lpObj, const char* lpszSenderAddress2);

QString GetSenderAddress2();
int SetSenderAddress2(QString qsSenderAddress2);

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

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSenderAddressFlags();
int SetSenderAddressFlags(int iSenderAddressFlags);

Unicode (Windows)
INT GetSenderAddressFlags();
INT SetSenderAddressFlags(INT iSenderAddressFlags);

int dshippingsdk_fedexrates_getsenderaddressflags(void* lpObj);
int dshippingsdk_fedexrates_setsenderaddressflags(void* lpObj, int iSenderAddressFlags);

int GetSenderAddressFlags();
int SetSenderAddressFlags(int iSenderAddressFlags);

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

SenderCity Property (FedExRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderCity();
int SetSenderCity(const char* lpszSenderCity);

Unicode (Windows)
LPWSTR GetSenderCity();
INT SetSenderCity(LPCWSTR lpszSenderCity);

char* dshippingsdk_fedexrates_getsendercity(void* lpObj);
int dshippingsdk_fedexrates_setsendercity(void* lpObj, const char* lpszSenderCity);

QString GetSenderCity();
int SetSenderCity(QString qsSenderCity);

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

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderCountryCode();
int SetSenderCountryCode(const char* lpszSenderCountryCode);

Unicode (Windows)
LPWSTR GetSenderCountryCode();
INT SetSenderCountryCode(LPCWSTR lpszSenderCountryCode);

char* dshippingsdk_fedexrates_getsendercountrycode(void* lpObj);
int dshippingsdk_fedexrates_setsendercountrycode(void* lpObj, const char* lpszSenderCountryCode);

QString GetSenderCountryCode();
int SetSenderCountryCode(QString qsSenderCountryCode);

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

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderState();
int SetSenderState(const char* lpszSenderState);

Unicode (Windows)
LPWSTR GetSenderState();
INT SetSenderState(LPCWSTR lpszSenderState);

char* dshippingsdk_fedexrates_getsenderstate(void* lpObj);
int dshippingsdk_fedexrates_setsenderstate(void* lpObj, const char* lpszSenderState);

QString GetSenderState();
int SetSenderState(QString qsSenderState);

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

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderZipCode();
int SetSenderZipCode(const char* lpszSenderZipCode);

Unicode (Windows)
LPWSTR GetSenderZipCode();
INT SetSenderZipCode(LPCWSTR lpszSenderZipCode);

char* dshippingsdk_fedexrates_getsenderzipcode(void* lpObj);
int dshippingsdk_fedexrates_setsenderzipcode(void* lpObj, const char* lpszSenderZipCode);

QString GetSenderZipCode();
int SetSenderZipCode(QString qsSenderZipCode);

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

The number of records in the Service arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetServiceCount();

Unicode (Windows)
INT GetServiceCount();

int dshippingsdk_fedexrates_getservicecount(void* lpObj);

int GetServiceCount();

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

Transportation charges before surcharges and discounts applied to a ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceAccountBaseCharge(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceAccountBaseCharge(INT iServiceIdx);

char* dshippingsdk_fedexrates_getserviceaccountbasecharge(void* lpObj, int serviceidx);

QString GetServiceAccountBaseCharge(int iServiceIdx);

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

Net charge amount applied to a ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceAccountNetCharge(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceAccountNetCharge(INT iServiceIdx);

char* dshippingsdk_fedexrates_getserviceaccountnetcharge(void* lpObj, int serviceidx);

QString GetServiceAccountNetCharge(int iServiceIdx);

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

Total discount amount applied to the shipment for a ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceAccountTotalDiscount(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceAccountTotalDiscount(INT iServiceIdx);

char* dshippingsdk_fedexrates_getserviceaccounttotaldiscount(void* lpObj, int serviceidx);

QString GetServiceAccountTotalDiscount(int iServiceIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceAccountTotalSurcharge(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceAccountTotalSurcharge(INT iServiceIdx);

char* dshippingsdk_fedexrates_getserviceaccounttotalsurcharge(void* lpObj, int serviceidx);

QString GetServiceAccountTotalSurcharge(int iServiceIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceAggregate(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceAggregate(INT iServiceIdx);

char* dshippingsdk_fedexrates_getserviceaggregate(void* lpObj, int serviceidx);

QString GetServiceAggregate(int iServiceIdx);

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

This indicates the shipment delivery date for the ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceDeliveryDate(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceDeliveryDate(INT iServiceIdx);

char* dshippingsdk_fedexrates_getservicedeliverydate(void* lpObj, int serviceidx);

QString GetServiceDeliveryDate(int iServiceIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceDeliveryDay(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceDeliveryDay(INT iServiceIdx);

char* dshippingsdk_fedexrates_getservicedeliveryday(void* lpObj, int serviceidx);

QString GetServiceDeliveryDay(int iServiceIdx);

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

Indicates the net discount applied to a ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceEffectiveNetDiscount(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceEffectiveNetDiscount(INT iServiceIdx);

char* dshippingsdk_fedexrates_getserviceeffectivenetdiscount(void* lpObj, int serviceidx);

QString GetServiceEffectiveNetDiscount(int iServiceIdx);

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

Transportation charges before surcharges and discounts applied to a ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceListBaseCharge(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceListBaseCharge(INT iServiceIdx);

char* dshippingsdk_fedexrates_getservicelistbasecharge(void* lpObj, int serviceidx);

QString GetServiceListBaseCharge(int iServiceIdx);

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

Net charge amount applied to a ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceListNetCharge(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceListNetCharge(INT iServiceIdx);

char* dshippingsdk_fedexrates_getservicelistnetcharge(void* lpObj, int serviceidx);

QString GetServiceListNetCharge(int iServiceIdx);

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

Total discount amount applied to a ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceListTotalDiscount(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceListTotalDiscount(INT iServiceIdx);

char* dshippingsdk_fedexrates_getservicelisttotaldiscount(void* lpObj, int serviceidx);

QString GetServiceListTotalDiscount(int iServiceIdx);

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

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceListTotalSurcharge(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceListTotalSurcharge(INT iServiceIdx);

char* dshippingsdk_fedexrates_getservicelisttotalsurcharge(void* lpObj, int serviceidx);

QString GetServiceListTotalSurcharge(int iServiceIdx);

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

Applicable rate scale for the ServiceType .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetServiceRateScale(int iServiceIdx);

Unicode (Windows)
LPWSTR GetServiceRateScale(INT iServiceIdx);