FedExFreightRates Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

FedExFreightRates

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

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 FedExFreightRates 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 (FedExFreightRates 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_fedexfreightrates_getcodtotalamount(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getcodtype(void* lpObj);
int dshippingsdk_fedexfreightrates_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

CommodityCount Property (FedExFreightRates Class)

The number of records in the Commodity arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

Unicode (Windows)
INT GetCommodityCount();
INT SetCommodityCount(INT iCommodityCount);

int dshippingsdk_fedexfreightrates_getcommoditycount(void* lpObj);
int dshippingsdk_fedexfreightrates_setcommoditycount(void* lpObj, int iCommodityCount);

int GetCommodityCount();
int SetCommodityCount(int iCommodityCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• CommodityDescription
• CommodityFreightClass
• CommodityFreightPackagingType
• CommodityHandlingUnits
• CommodityHarmonizedCode
• CommodityHazardousMaterialsOptions
• CommodityHeight
• CommodityId
• CommodityLength
• CommodityManufacturer
• CommodityNmfcCode
• CommodityNumberOfPieces
• CommodityPartNumber
• CommodityPONumber
• CommodityQuantity
• CommodityQuantityUnit
• CommodityUnitPrice
• CommodityValue
• CommodityVolume
• CommodityWeight
• CommodityWidth

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

This property is not available at design time.

Data Type

Integer

CommodityDescription Property (FedExFreightRates Class)

Complete and accurate description of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityDescription(int iCommodityIdx);
int SetCommodityDescription(int iCommodityIdx, const char* lpszCommodityDescription);

Unicode (Windows)
LPWSTR GetCommodityDescription(INT iCommodityIdx);
INT SetCommodityDescription(INT iCommodityIdx, LPCWSTR lpszCommodityDescription);

char* dshippingsdk_fedexfreightrates_getcommoditydescription(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommoditydescription(void* lpObj, int commodityidx, const char* lpszCommodityDescription);

QString GetCommodityDescription(int iCommodityIdx);
int SetCommodityDescription(int iCommodityIdx, QString qsCommodityDescription);

Default Value

""

Remarks

Complete and accurate description of this commodity line item.

It is applicable to all international forms and freight shipments. Optional for Partial Invoice and required for the rest of form types.

Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.

If the shipment contains documents only (i.e., Documents is set to True), then the CommodityDescription has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityFreightClass Property (FedExFreightRates Class)

Indicates the freight class of the commodity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityFreightClass(int iCommodityIdx);
int SetCommodityFreightClass(int iCommodityIdx, int iCommodityFreightClass);

Unicode (Windows)
INT GetCommodityFreightClass(INT iCommodityIdx);
INT SetCommodityFreightClass(INT iCommodityIdx, INT iCommodityFreightClass);

FC_50(0), 
FC_55(1), 
FC_60(2), 
FC_65(3), 
FC_70(4), 
FC_77_5(5), 
FC_85(6), 
FC_92_5(7), 
FC_100(8), 
FC_110(9), 
FC_125(10), 
FC_150(11), 
FC_175(12), 
FC_200(13), 
FC_250(14), 
FC_300(15), 
FC_400(16), 
FC_500(17)

int dshippingsdk_fedexfreightrates_getcommodityfreightclass(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityfreightclass(void* lpObj, int commodityidx, int iCommodityFreightClass);

int GetCommodityFreightClass(int iCommodityIdx);
int SetCommodityFreightClass(int iCommodityIdx, int iCommodityFreightClass);

Default Value

0

Remarks

Indicates the freight class of the commodity.

The following table lists freight classes available from FedEx freight services.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityFreightPackagingType Property (FedExFreightRates Class)

Identifies the Commodity item's packaging type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityFreightPackagingType(int iCommodityIdx);
int SetCommodityFreightPackagingType(int iCommodityIdx, int iCommodityFreightPackagingType);

Unicode (Windows)
INT GetCommodityFreightPackagingType(INT iCommodityIdx);
INT SetCommodityFreightPackagingType(INT iCommodityIdx, INT iCommodityFreightPackagingType);

FCPT_NONE(0), 
FCPT_BAG(1), 
FCPT_BARREL(2), 
FCPT_BASKET(3), 
FCPT_BOX(4), 
FCPT_BUCKET(5), 
FCPT_BUNDLE(6), 
FCPT_CAGE(7), 
FCPT_CARTON(8), 
FCPT_CASE(9), 
FCPT_CHEST(10), 
FCPT_CONTAINER(11), 
FCPT_CRATE(12), 
FCPT_CYLINDER(13), 
FCPT_DRUM(14), 
FCPT_ENVELOPE(15), 
FCPT_HAMPER(16), 
FCPT_OTHER(17), 
FCPT_PACKAGE(18), 
FCPT_PAIL(19), 
FCPT_PALLET(20), 
FCPT_PARCEL(21), 
FCPT_PIECE(22), 
FCPT_REEL(23), 
FCPT_ROLL(24), 
FCPT_SACK(25), 
FCPT_SHRINKWRAPPED(26), 
FCPT_SKID(27), 
FCPT_TANK(28), 
FCPT_TOTEBIN(29), 
FCPT_TUBE(30), 
FCPT_UNIT(31)

int dshippingsdk_fedexfreightrates_getcommodityfreightpackagingtype(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityfreightpackagingtype(void* lpObj, int commodityidx, int iCommodityFreightPackagingType);

int GetCommodityFreightPackagingType(int iCommodityIdx);
int SetCommodityFreightPackagingType(int iCommodityIdx, int iCommodityFreightPackagingType);

Default Value

0

Remarks

Identifies the Commodity item's packaging type. Possible values are:

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityHandlingUnits Property (FedExFreightRates Class)

Number of individual handling units to which this commodity applies.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityHandlingUnits(int iCommodityIdx);
int SetCommodityHandlingUnits(int iCommodityIdx, int iCommodityHandlingUnits);

Unicode (Windows)
INT GetCommodityHandlingUnits(INT iCommodityIdx);
INT SetCommodityHandlingUnits(INT iCommodityIdx, INT iCommodityHandlingUnits);

int dshippingsdk_fedexfreightrates_getcommodityhandlingunits(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityhandlingunits(void* lpObj, int commodityidx, int iCommodityHandlingUnits);

int GetCommodityHandlingUnits(int iCommodityIdx);
int SetCommodityHandlingUnits(int iCommodityIdx, int iCommodityHandlingUnits);

Default Value

1

Remarks

Number of individual handling units to which this commodity applies. (NOTE: Total of commodity-level handling units may not balance to shipment-level total handling units.)

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityHarmonizedCode Property (FedExFreightRates Class)

Unique code representing this commodity line item (for imports only).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityHarmonizedCode(int iCommodityIdx);
int SetCommodityHarmonizedCode(int iCommodityIdx, const char* lpszCommodityHarmonizedCode);

Unicode (Windows)
LPWSTR GetCommodityHarmonizedCode(INT iCommodityIdx);
INT SetCommodityHarmonizedCode(INT iCommodityIdx, LPCWSTR lpszCommodityHarmonizedCode);

char* dshippingsdk_fedexfreightrates_getcommodityharmonizedcode(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityharmonizedcode(void* lpObj, int commodityidx, const char* lpszCommodityHarmonizedCode);

QString GetCommodityHarmonizedCode(int iCommodityIdx);
int SetCommodityHarmonizedCode(int iCommodityIdx, QString qsCommodityHarmonizedCode);

Default Value

""

Remarks

Unique code representing this commodity line item (for imports only).

The World Trade Organization has classified all commodities with a number. This number is called a Harmonized Schedule code and ranges from six to 12 digits depending on the country. However, the first six digits of this number are more or less uniform throughout the world. Customs uses the HS number to determine the import duties, taxes and import license requirements for goods entering a country. This number is required for filling in the Customs documentation.

It is applicable to Invoice, Partial Invoice and NAFTA CO. Required for NAFTA CO and optional for Partial Invoice. For NAFTA CO: For each good described in CommodityDescription, identify the Harmonized Schedule (HS) tariff classification using the one of the country into whose territory the good is imported. This number must appear on import documentation that accompanies a shipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityHarmonizedCode is required for each commodity line item for shipments to EU countries.

At least one occurrence is required for U.S. Export shipments if the TotalCustomsValue is greater than 2,500 USD or if a valid U.S. Export license is required.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityHazardousMaterialsOptions Property (FedExFreightRates Class)

Indicates the kind of hazardous material content in this commodity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityHazardousMaterialsOptions(int iCommodityIdx);
int SetCommodityHazardousMaterialsOptions(int iCommodityIdx, int iCommodityHazardousMaterialsOptions);

Unicode (Windows)
INT GetCommodityHazardousMaterialsOptions(INT iCommodityIdx);
INT SetCommodityHazardousMaterialsOptions(INT iCommodityIdx, INT iCommodityHazardousMaterialsOptions);

int dshippingsdk_fedexfreightrates_getcommodityhazardousmaterialsoptions(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityhazardousmaterialsoptions(void* lpObj, int commodityidx, int iCommodityHazardousMaterialsOptions);

int GetCommodityHazardousMaterialsOptions(int iCommodityIdx);
int SetCommodityHazardousMaterialsOptions(int iCommodityIdx, int iCommodityHazardousMaterialsOptions);

Default Value

0

Remarks

Indicates the kind of hazardous material content in this commodity.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to include multiple options:

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityHeight Property (FedExFreightRates Class)

The height of the commodity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityHeight(int iCommodityIdx);
int SetCommodityHeight(int iCommodityIdx, int iCommodityHeight);

Unicode (Windows)
INT GetCommodityHeight(INT iCommodityIdx);
INT SetCommodityHeight(INT iCommodityIdx, INT iCommodityHeight);

int dshippingsdk_fedexfreightrates_getcommodityheight(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityheight(void* lpObj, int commodityidx, int iCommodityHeight);

int GetCommodityHeight(int iCommodityIdx);
int SetCommodityHeight(int iCommodityIdx, int iCommodityHeight);

Default Value

1

Remarks

The height of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityId Property (FedExFreightRates Class)

A unique identifier assigned to this line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityId(int iCommodityIdx);
int SetCommodityId(int iCommodityIdx, const char* lpszCommodityId);

Unicode (Windows)
LPWSTR GetCommodityId(INT iCommodityIdx);
INT SetCommodityId(INT iCommodityIdx, LPCWSTR lpszCommodityId);

char* dshippingsdk_fedexfreightrates_getcommodityid(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityid(void* lpObj, int commodityidx, const char* lpszCommodityId);

QString GetCommodityId(int iCommodityIdx);
int SetCommodityId(int iCommodityIdx, QString qsCommodityId);

Default Value

""

Remarks

A unique identifier assigned to this line item.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityLength Property (FedExFreightRates Class)

The width of the commodity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityLength(int iCommodityIdx);
int SetCommodityLength(int iCommodityIdx, int iCommodityLength);

Unicode (Windows)
INT GetCommodityLength(INT iCommodityIdx);
INT SetCommodityLength(INT iCommodityIdx, INT iCommodityLength);

int dshippingsdk_fedexfreightrates_getcommoditylength(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommoditylength(void* lpObj, int commodityidx, int iCommodityLength);

int GetCommodityLength(int iCommodityIdx);
int SetCommodityLength(int iCommodityIdx, int iCommodityLength);

Default Value

1

Remarks

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityManufacturer Property (FedExFreightRates Class)

Country code where the contents of this commodity line were produced, manufactured or grown in their final form.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityManufacturer(int iCommodityIdx);
int SetCommodityManufacturer(int iCommodityIdx, const char* lpszCommodityManufacturer);

Unicode (Windows)
LPWSTR GetCommodityManufacturer(INT iCommodityIdx);
INT SetCommodityManufacturer(INT iCommodityIdx, LPCWSTR lpszCommodityManufacturer);

char* dshippingsdk_fedexfreightrates_getcommoditymanufacturer(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommoditymanufacturer(void* lpObj, int commodityidx, const char* lpszCommodityManufacturer);

QString GetCommodityManufacturer(int iCommodityIdx);
int SetCommodityManufacturer(int iCommodityIdx, QString qsCommodityManufacturer);

Default Value

"US"

Remarks

Country code where the contents of this commodity line were produced, manufactured or grown in their final form. In international shipment requests, the CommodityManufacturer is required to be entered.

In FedEx, when the shipment contains documents only (i.e., Documents is set to True), this represent the country where the documents were compiled and/or produced in their final form. In this case, only the CommodityManufacturer and CommodityDescription are required to be provided in the request. If the CommodityManufacturer is not provided, it defaults to US.

When the shipment contains non-documents items (i.e., Documents is set to False and the shipment is considered dutiable), at least one occurrence of a commodity item is required to be entered. The CommodityManufacturer has to be provided for each commodity item included in that international shipment.

In UPS, this applies to Invoice, Partial Invoice, CO and NAFTA CO. It is required for Invoice and CO forms, and optional for Partial Invoice.

Here is a list of country names and their codes where UPS services are available. Code is the value that has to be provided in all requests sent to UPS where country code is to be entered. This is also echoed in server reply.

Along with country names and their codes, we have also listed here the currency code used in that country, the maximum weight applicable to that country, whether address validation is supported and if postal code is required.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityNmfcCode Property (FedExFreightRates Class)

NMFC Code for commodity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityNmfcCode(int iCommodityIdx);
int SetCommodityNmfcCode(int iCommodityIdx, const char* lpszCommodityNmfcCode);

Unicode (Windows)
LPWSTR GetCommodityNmfcCode(INT iCommodityIdx);
INT SetCommodityNmfcCode(INT iCommodityIdx, LPCWSTR lpszCommodityNmfcCode);

char* dshippingsdk_fedexfreightrates_getcommoditynmfccode(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommoditynmfccode(void* lpObj, int commodityidx, const char* lpszCommodityNmfcCode);

QString GetCommodityNmfcCode(int iCommodityIdx);
int SetCommodityNmfcCode(int iCommodityIdx, QString qsCommodityNmfcCode);

Default Value

""

Remarks

NMFC Code for commodity.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityNumberOfPieces Property (FedExFreightRates Class)

The total number of packages, cartons, or containers for the commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityNumberOfPieces(int iCommodityIdx);
int SetCommodityNumberOfPieces(int iCommodityIdx, int iCommodityNumberOfPieces);

Unicode (Windows)
INT GetCommodityNumberOfPieces(INT iCommodityIdx);
INT SetCommodityNumberOfPieces(INT iCommodityIdx, INT iCommodityNumberOfPieces);

int dshippingsdk_fedexfreightrates_getcommoditynumberofpieces(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommoditynumberofpieces(void* lpObj, int commodityidx, int iCommodityNumberOfPieces);

int GetCommodityNumberOfPieces(int iCommodityIdx);
int SetCommodityNumberOfPieces(int iCommodityIdx, int iCommodityNumberOfPieces);

Default Value

1

Remarks

The total number of packages, cartons, or containers for the commodity line item.

If the Documents is set to False in ship request, the CommodityNumberOfPieces is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityPartNumber Property (FedExFreightRates Class)

The part number of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityPartNumber(int iCommodityIdx);
int SetCommodityPartNumber(int iCommodityIdx, const char* lpszCommodityPartNumber);

Unicode (Windows)
LPWSTR GetCommodityPartNumber(INT iCommodityIdx);
INT SetCommodityPartNumber(INT iCommodityIdx, LPCWSTR lpszCommodityPartNumber);

char* dshippingsdk_fedexfreightrates_getcommoditypartnumber(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommoditypartnumber(void* lpObj, int commodityidx, const char* lpszCommodityPartNumber);

QString GetCommodityPartNumber(int iCommodityIdx);
int SetCommodityPartNumber(int iCommodityIdx, QString qsCommodityPartNumber);

Default Value

""

Remarks

The part number of this commodity line item.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityPONumber Property (FedExFreightRates Class)

The PO Number for printed reference per commodity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityPONumber(int iCommodityIdx);
int SetCommodityPONumber(int iCommodityIdx, const char* lpszCommodityPONumber);

Unicode (Windows)
LPWSTR GetCommodityPONumber(INT iCommodityIdx);
INT SetCommodityPONumber(INT iCommodityIdx, LPCWSTR lpszCommodityPONumber);

char* dshippingsdk_fedexfreightrates_getcommodityponumber(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityponumber(void* lpObj, int commodityidx, const char* lpszCommodityPONumber);

QString GetCommodityPONumber(int iCommodityIdx);
int SetCommodityPONumber(int iCommodityIdx, QString qsCommodityPONumber);

Default Value

""

Remarks

The PO Number for printed reference per commodity.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityQuantity Property (FedExFreightRates Class)

Number of units contained in this commodity line item measured in units specified by the QuantityUnit .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityQuantity(int iCommodityIdx);
int SetCommodityQuantity(int iCommodityIdx, int iCommodityQuantity);

Unicode (Windows)
INT GetCommodityQuantity(INT iCommodityIdx);
INT SetCommodityQuantity(INT iCommodityIdx, INT iCommodityQuantity);

int dshippingsdk_fedexfreightrates_getcommodityquantity(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityquantity(void* lpObj, int commodityidx, int iCommodityQuantity);

int GetCommodityQuantity(int iCommodityIdx);
int SetCommodityQuantity(int iCommodityIdx, int iCommodityQuantity);

Default Value

1

Remarks

Number of units contained in this commodity line item measured in units specified by the CommodityQuantityUnit. This is used in conjunction with the CommodityQuantityUnit and CommodityUnitPrice.

If the Documents is set to False in ship request, the CommodityQuantity is required to be entered for each commodity item included in an international shipment. At least one occurrence is required for international dutiable (non-documents) shipments.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

CommodityQuantityUnit Property (FedExFreightRates Class)

Unit of measure used to express the Quantity of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityQuantityUnit(int iCommodityIdx);
int SetCommodityQuantityUnit(int iCommodityIdx, const char* lpszCommodityQuantityUnit);

Unicode (Windows)
LPWSTR GetCommodityQuantityUnit(INT iCommodityIdx);
INT SetCommodityQuantityUnit(INT iCommodityIdx, LPCWSTR lpszCommodityQuantityUnit);

char* dshippingsdk_fedexfreightrates_getcommodityquantityunit(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityquantityunit(void* lpObj, int commodityidx, const char* lpszCommodityQuantityUnit);

QString GetCommodityQuantityUnit(int iCommodityIdx);
int SetCommodityQuantityUnit(int iCommodityIdx, QString qsCommodityQuantityUnit);

Default Value

"EA"

Remarks

Unit of measure used to express the CommodityQuantity of this commodity line item.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityQuantityUnit is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Here is a list of possible values for FedEx:

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityUnitPrice Property (FedExFreightRates Class)

Value of each QuantityUnit in Quantity of this commodity line item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityUnitPrice(int iCommodityIdx);
int SetCommodityUnitPrice(int iCommodityIdx, const char* lpszCommodityUnitPrice);

Unicode (Windows)
LPWSTR GetCommodityUnitPrice(INT iCommodityIdx);
INT SetCommodityUnitPrice(INT iCommodityIdx, LPCWSTR lpszCommodityUnitPrice);

char* dshippingsdk_fedexfreightrates_getcommodityunitprice(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityunitprice(void* lpObj, int commodityidx, const char* lpszCommodityUnitPrice);

QString GetCommodityUnitPrice(int iCommodityIdx);
int SetCommodityUnitPrice(int iCommodityIdx, QString qsCommodityUnitPrice);

Default Value

"1.00"

Remarks

Value of each CommodityQuantityUnit in CommodityQuantity of this commodity line item. This is used in conjunction with the CommodityQuantityUnit and CommodityQuantity. This indicates the monetary amount used to specify the worth or price of the commodity and it should be greater than zero.

When the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityUnitPrice is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

Format: Limit to 6 digits after the decimal (e.g. 900.000000).

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityValue Property (FedExFreightRates Class)

The value of an individual item being shipped.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityValue(int iCommodityIdx);
int SetCommodityValue(int iCommodityIdx, const char* lpszCommodityValue);

Unicode (Windows)
LPWSTR GetCommodityValue(INT iCommodityIdx);
INT SetCommodityValue(INT iCommodityIdx, LPCWSTR lpszCommodityValue);

char* dshippingsdk_fedexfreightrates_getcommodityvalue(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityvalue(void* lpObj, int commodityidx, const char* lpszCommodityValue);

QString GetCommodityValue(int iCommodityIdx);
int SetCommodityValue(int iCommodityIdx, QString qsCommodityValue);

Default Value

""

Remarks

The value of an individual item being shipped. This should be provided for each item contained in the package being shipped. This property provides the value of the set of items. If the item is 2 boxes of 50 pens and the value of each box is $10.00, "20.00" (2 boxes x $10.00) should be entered. If the value of each pen is .25, then "25.00" (100 pens x .25) should be entered.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityVolume Property (FedExFreightRates Class)

This should contain the volume of the freight item.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityVolume(int iCommodityIdx);
int SetCommodityVolume(int iCommodityIdx, const char* lpszCommodityVolume);

Unicode (Windows)
LPWSTR GetCommodityVolume(INT iCommodityIdx);
INT SetCommodityVolume(INT iCommodityIdx, LPCWSTR lpszCommodityVolume);

char* dshippingsdk_fedexfreightrates_getcommodityvolume(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityvolume(void* lpObj, int commodityidx, const char* lpszCommodityVolume);

QString GetCommodityVolume(int iCommodityIdx);
int SetCommodityVolume(int iCommodityIdx, QString qsCommodityVolume);

Default Value

"0.0"

Remarks

This should contain the volume of the freight item. This should be specified in cubic feet if SizeUnit is set to IN and cubic meters if SizeUnit is set to CM.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityWeight Property (FedExFreightRates Class)

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommodityWeight(int iCommodityIdx);
int SetCommodityWeight(int iCommodityIdx, const char* lpszCommodityWeight);

Unicode (Windows)
LPWSTR GetCommodityWeight(INT iCommodityIdx);
INT SetCommodityWeight(INT iCommodityIdx, LPCWSTR lpszCommodityWeight);

char* dshippingsdk_fedexfreightrates_getcommodityweight(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommodityweight(void* lpObj, int commodityidx, const char* lpszCommodityWeight);

QString GetCommodityWeight(int iCommodityIdx);
int SetCommodityWeight(int iCommodityIdx, QString qsCommodityWeight);

Default Value

"0.00"

Remarks

The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. This weight does not include carrier equipment.

If the shipment contains non-documents item(s) (i.e., the Documents is set to False), the CommodityWeight is required to be entered for each commodity line item included in shipment. At least one commodity occurrence is required for international dutiable (non-documents) shipments.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

String

CommodityWidth Property (FedExFreightRates Class)

The width of the commodity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommodityWidth(int iCommodityIdx);
int SetCommodityWidth(int iCommodityIdx, int iCommodityWidth);

Unicode (Windows)
INT GetCommodityWidth(INT iCommodityIdx);
INT SetCommodityWidth(INT iCommodityIdx, INT iCommodityWidth);

int dshippingsdk_fedexfreightrates_getcommoditywidth(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightrates_setcommoditywidth(void* lpObj, int commodityidx, int iCommodityWidth);

int GetCommodityWidth(int iCommodityIdx);
int SetCommodityWidth(int iCommodityIdx, int iCommodityWidth);

Default Value

1

Remarks

The width of the commodity.

This only applies when using the FedExFreightEconomy and FedExFreightPriority services.

The CommodityIdx parameter specifies the index of the item in the array. The size of the array is controlled by the CommodityCount property.

This property is not available at design time.

Data Type

Integer

FedExAccountNumber Property (FedExFreightRates 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_fedexfreightrates_getfedexaccountnumber(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfedexauthorizationtoken(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfedexlanguagecode(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfedexlocalecode(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfedexserver(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfirewallautodetect(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfirewalltype(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfirewallhost(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfirewallpassword(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfirewallport(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfirewalluser(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfreightguaranteedate(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getfreightguaranteetype(void* lpObj);
int dshippingsdk_fedexfreightrates_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

InsuredValue Property (FedExFreightRates 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_fedexfreightrates_getinsuredvalue(void* lpObj);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getpackagecount(void* lpObj);
int dshippingsdk_fedexfreightrates_setpackagecount(void* lpObj, int iPackageCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageDescription
• PackageHeight
• PackageId
• 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

PackageDescription Property (FedExFreightRates Class)

For FedEx, this is the description that appears in the email to identify this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDescription(int iPackageIdx);
int SetPackageDescription(int iPackageIdx, const char* lpszPackageDescription);

Unicode (Windows)
LPWSTR GetPackageDescription(INT iPackageIdx);
INT SetPackageDescription(INT iPackageIdx, LPCWSTR lpszPackageDescription);

char* dshippingsdk_fedexfreightrates_getpackagedescription(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_setpackagedescription(void* lpObj, int packageidx, const char* lpszPackageDescription);

QString GetPackageDescription(int iPackageIdx);
int SetPackageDescription(int iPackageIdx, QString qsPackageDescription);

Default Value

""

Remarks

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and 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

PackageHeight Property (FedExFreightRates 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_fedexfreightrates_getpackageheight(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_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

PackageId Property (FedExFreightRates Class)

An 8-digit Unique Parcel Identification Number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageId(int iPackageIdx);
int SetPackageId(int iPackageIdx, const char* lpszPackageId);

Unicode (Windows)
LPWSTR GetPackageId(INT iPackageIdx);
INT SetPackageId(INT iPackageIdx, LPCWSTR lpszPackageId);

char* dshippingsdk_fedexfreightrates_getpackageid(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_setpackageid(void* lpObj, int packageidx, const char* lpszPackageId);

QString GetPackageId(int iPackageIdx);
int SetPackageId(int iPackageIdx, QString qsPackageId);

Default Value

""

Remarks

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This property is optional, and only applies to USPS return labels.

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

PackageInsuredValue Property (FedExFreightRates 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_fedexfreightrates_getpackageinsuredvalue(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getpackagelength(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getpackagetype(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getpackagesignaturetype(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getpackagespecialservices(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getpackageweight(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_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 (FedExFreightRates 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_fedexfreightrates_getpackagewidth(void* lpObj, int packageidx);
int dshippingsdk_fedexfreightrates_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

PayorAccountNumber Property (FedExFreightRates Class)

The account number of the party responsible for payment (shipping charges, or duties and taxes).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorAccountNumber();
int SetPayorAccountNumber(const char* lpszPayorAccountNumber);

Unicode (Windows)
LPWSTR GetPayorAccountNumber();
INT SetPayorAccountNumber(LPCWSTR lpszPayorAccountNumber);

char* dshippingsdk_fedexfreightrates_getpayoraccountnumber(void* lpObj);
int dshippingsdk_fedexfreightrates_setpayoraccountnumber(void* lpObj, const char* lpszPayorAccountNumber);

QString GetPayorAccountNumber();
int SetPayorAccountNumber(QString qsPayorAccountNumber);

Default Value

""

Remarks

The account number of the party responsible for payment (shipping charges, or duties and taxes).

This is required to be provided in the ship request, only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to PayorAccountNumber.

Data Type

String

PayorAddress1 Property (FedExFreightRates Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorAddress1();
int SetPayorAddress1(const char* lpszPayorAddress1);

Unicode (Windows)
LPWSTR GetPayorAddress1();
INT SetPayorAddress1(LPCWSTR lpszPayorAddress1);

char* dshippingsdk_fedexfreightrates_getpayoraddress1(void* lpObj);
int dshippingsdk_fedexfreightrates_setpayoraddress1(void* lpObj, const char* lpszPayorAddress1);

QString GetPayorAddress1();
int SetPayorAddress1(QString qsPayorAddress1);

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. Combination of PayorAddress1 and PayorAddress2 should not exceed 35 characters.

Data Type

String

PayorAddress2 Property (FedExFreightRates Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorAddress2();
int SetPayorAddress2(const char* lpszPayorAddress2);

Unicode (Windows)
LPWSTR GetPayorAddress2();
INT SetPayorAddress2(LPCWSTR lpszPayorAddress2);

char* dshippingsdk_fedexfreightrates_getpayoraddress2(void* lpObj);
int dshippingsdk_fedexfreightrates_setpayoraddress2(void* lpObj, const char* lpszPayorAddress2);

QString GetPayorAddress2();
int SetPayorAddress2(QString qsPayorAddress2);

Default Value

""

Remarks

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. Combination of PayorAddress1 and PayorAddress2 should not exceed 35 characters.

Data Type

String

PayorCity Property (FedExFreightRates Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorCity();
int SetPayorCity(const char* lpszPayorCity);

Unicode (Windows)
LPWSTR GetPayorCity();
INT SetPayorCity(LPCWSTR lpszPayorCity);

char* dshippingsdk_fedexfreightrates_getpayorcity(void* lpObj);
int dshippingsdk_fedexfreightrates_setpayorcity(void* lpObj, const char* lpszPayorCity);

QString GetPayorCity();
int SetPayorCity(QString qsPayorCity);

Default Value

""

Remarks

Name of city, town, etc.

Data Type

String

PayorCountryCode Property (FedExFreightRates Class)

The country code for the payor of the shipment, or duties and taxes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorCountryCode();
int SetPayorCountryCode(const char* lpszPayorCountryCode);

Unicode (Windows)
LPWSTR GetPayorCountryCode();
INT SetPayorCountryCode(LPCWSTR lpszPayorCountryCode);

char* dshippingsdk_fedexfreightrates_getpayorcountrycode(void* lpObj);
int dshippingsdk_fedexfreightrates_setpayorcountrycode(void* lpObj, const char* lpszPayorCountryCode);

QString GetPayorCountryCode();
int SetPayorCountryCode(QString qsPayorCountryCode);

Default Value

"US"

Remarks

The country code for the payor of the shipment, or duties and taxes.

When shipping via FedEx Express, the PayorCountryCode is required to be provided in the ship request only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the PayorCountryCode is required only if PayorType is set to 'THIRDPARTY'.

For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US.

Data Type

String

PayorName Property (FedExFreightRates Class)

Identifies the payor's name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorName();
int SetPayorName(const char* lpszPayorName);

Unicode (Windows)
LPWSTR GetPayorName();
INT SetPayorName(LPCWSTR lpszPayorName);

char* dshippingsdk_fedexfreightrates_getpayorname(void* lpObj);
int dshippingsdk_fedexfreightrates_setpayorname(void* lpObj, const char* lpszPayorName);

QString GetPayorName();
int SetPayorName(QString qsPayorName);

Default Value

""

Remarks

Identifies the payor's name.

PayorName is required only if PayorType is set to 'THIRDPARTY'.

Note: This property is only applicable to UPSFreightRates and UPSFreightShip.

Data Type

String

PayorType Property (FedExFreightRates Class)

Method of payment for shipment, or duties and taxes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPayorType();
int SetPayorType(int iPayorType);

Unicode (Windows)
INT GetPayorType();
INT SetPayorType(INT iPayorType);

PT_SENDER(0), 
PT_RECIPIENT(1), 
PT_THIRD_PARTY(2), 
PT_COLLECT(3), 
PT_CONSIGNEE(4)

int dshippingsdk_fedexfreightrates_getpayortype(void* lpObj);
int dshippingsdk_fedexfreightrates_setpayortype(void* lpObj, int iPayorType);

int GetPayorType();
int SetPayorType(int iPayorType);

Default Value

0

Remarks

Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:

The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service.

For FedEx, when this property is set to a value other than 0 (ptSender), the PayorAccountNumber and PayorCountryCode are required to be provided in the request as well. Otherwise, those will default to FedExAccountNumber and SenderCountryCode.

For UPS, when set to ptSender, the PayorAccountNumber is automatically set to UPSAccountNumber. When ptRecipient is specified, PayorAccountNumber and PayorZipCode are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the PayorAccountNumber, PayorZipCode and PayorCountryCode are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination.

Data Type

Integer

PayorState Property (FedExFreightRates Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPayorState();
int SetPayorState(const char* lpszPayorState);

Unicode (Windows)
LPWSTR GetPayorState();
INT SetPayorState(LPCWSTR lpszPayorState);