FedExFreightShip Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a FedEx shipping label for any of FedEx freight services complete with addresses and barcode, or cancel a shipment.

Syntax

FedExFreightShip

Remarks

Generating a shipping label can be done by calling either the GetPackageLabel or GetShipmentLabels method. You will have to specify the package information, FedEx service to be used for shipping this package, origin and destination information, and any other special services associated with the shipment (such as Saturday Pickup, Saturday Delivery, Hold At Location, etc.).

This class also allows you to delete packages included in the daily shipping log that have not already been tendered to FedEx by calling the CancelShipment method. The TrackingNumber parameter that identifies the shipment must be specified in the request along with the FedExAccountNumber.

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.

NOTE: FedEx requires that all applications that print shipping labels pass a series of certification tests prior to being placed in production. The full version of FedEx Integrator gives you access to a certification package that makes this process very easy. The certification package is available by request. It includes all test scenarios required by FedEx for FedEx Express and Ground (international and domestic), and Home Delivery. Through the application included in the certification package, you can generate all shipping labels for selected scenarios applicable to your shipping needs with a click of a button.

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.

ApprovedByCompany Property (FedExFreightShip Class)

Identifies the contact person's company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovedByCompany();
int SetApprovedByCompany(const char* lpszApprovedByCompany);

Unicode (Windows)
LPWSTR GetApprovedByCompany();
INT SetApprovedByCompany(LPCWSTR lpszApprovedByCompany);

char* dshippingsdk_fedexfreightship_getapprovedbycompany(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbycompany(void* lpObj, const char* lpszApprovedByCompany);

QString GetApprovedByCompany();
int SetApprovedByCompany(QString qsApprovedByCompany);

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either ApprovedByFirstName and ApprovedByLastName or ApprovedByCompany are required to be provided.

Data Type

String

ApprovedByEmail Property (FedExFreightShip Class)

Identifies the contact person's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovedByEmail();
int SetApprovedByEmail(const char* lpszApprovedByEmail);

Unicode (Windows)
LPWSTR GetApprovedByEmail();
INT SetApprovedByEmail(LPCWSTR lpszApprovedByEmail);

char* dshippingsdk_fedexfreightship_getapprovedbyemail(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbyemail(void* lpObj, const char* lpszApprovedByEmail);

QString GetApprovedByEmail();
int SetApprovedByEmail(QString qsApprovedByEmail);

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

ApprovedByFax Property (FedExFreightShip Class)

Recipient's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovedByFax();
int SetApprovedByFax(const char* lpszApprovedByFax);

Unicode (Windows)
LPWSTR GetApprovedByFax();
INT SetApprovedByFax(LPCWSTR lpszApprovedByFax);

char* dshippingsdk_fedexfreightship_getapprovedbyfax(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbyfax(void* lpObj, const char* lpszApprovedByFax);

QString GetApprovedByFax();
int SetApprovedByFax(QString qsApprovedByFax);

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

ApprovedByFirstName Property (FedExFreightShip Class)

Sender's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovedByFirstName();
int SetApprovedByFirstName(const char* lpszApprovedByFirstName);

Unicode (Windows)
LPWSTR GetApprovedByFirstName();
INT SetApprovedByFirstName(LPCWSTR lpszApprovedByFirstName);

char* dshippingsdk_fedexfreightship_getapprovedbyfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbyfirstname(void* lpObj, const char* lpszApprovedByFirstName);

QString GetApprovedByFirstName();
int SetApprovedByFirstName(QString qsApprovedByFirstName);

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either ApprovedByFirstName and ApprovedByLastName or ApprovedByCompany must be sent.

Data Type

String

ApprovedByLastName Property (FedExFreightShip Class)

Person's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovedByLastName();
int SetApprovedByLastName(const char* lpszApprovedByLastName);

Unicode (Windows)
LPWSTR GetApprovedByLastName();
INT SetApprovedByLastName(LPCWSTR lpszApprovedByLastName);

char* dshippingsdk_fedexfreightship_getapprovedbylastname(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbylastname(void* lpObj, const char* lpszApprovedByLastName);

QString GetApprovedByLastName();
int SetApprovedByLastName(QString qsApprovedByLastName);

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either ApprovedByFirstName and ApprovedByLastName or ApprovedByCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

ApprovedByMiddleInitial Property (FedExFreightShip Class)

Middle initial.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovedByMiddleInitial();
int SetApprovedByMiddleInitial(const char* lpszApprovedByMiddleInitial);

Unicode (Windows)
LPWSTR GetApprovedByMiddleInitial();
INT SetApprovedByMiddleInitial(LPCWSTR lpszApprovedByMiddleInitial);

char* dshippingsdk_fedexfreightship_getapprovedbymiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbymiddleinitial(void* lpObj, const char* lpszApprovedByMiddleInitial);

QString GetApprovedByMiddleInitial();
int SetApprovedByMiddleInitial(QString qsApprovedByMiddleInitial);

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

ApprovedByPhone Property (FedExFreightShip Class)

Identifies the contact person's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetApprovedByPhone();
int SetApprovedByPhone(const char* lpszApprovedByPhone);

Unicode (Windows)
LPWSTR GetApprovedByPhone();
INT SetApprovedByPhone(LPCWSTR lpszApprovedByPhone);

char* dshippingsdk_fedexfreightship_getapprovedbyphone(void* lpObj);
int dshippingsdk_fedexfreightship_setapprovedbyphone(void* lpObj, const char* lpszApprovedByPhone);

QString GetApprovedByPhone();
int SetApprovedByPhone(QString qsApprovedByPhone);

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

BrokerAddress1 Property (FedExFreightShip Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerAddress1();
int SetBrokerAddress1(const char* lpszBrokerAddress1);

Unicode (Windows)
LPWSTR GetBrokerAddress1();
INT SetBrokerAddress1(LPCWSTR lpszBrokerAddress1);

char* dshippingsdk_fedexfreightship_getbrokeraddress1(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokeraddress1(void* lpObj, const char* lpszBrokerAddress1);

QString GetBrokerAddress1();
int SetBrokerAddress1(QString qsBrokerAddress1);

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

Data Type

String

BrokerAddress2 Property (FedExFreightShip Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerAddress2();
int SetBrokerAddress2(const char* lpszBrokerAddress2);

Unicode (Windows)
LPWSTR GetBrokerAddress2();
INT SetBrokerAddress2(LPCWSTR lpszBrokerAddress2);

char* dshippingsdk_fedexfreightship_getbrokeraddress2(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokeraddress2(void* lpObj, const char* lpszBrokerAddress2);

QString GetBrokerAddress2();
int SetBrokerAddress2(QString qsBrokerAddress2);

Default Value

""

Remarks

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

Data Type

String

BrokerAddressFlags Property (FedExFreightShip Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBrokerAddressFlags();
int SetBrokerAddressFlags(int iBrokerAddressFlags);

Unicode (Windows)
INT GetBrokerAddressFlags();
INT SetBrokerAddressFlags(INT iBrokerAddressFlags);

int dshippingsdk_fedexfreightship_getbrokeraddressflags(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokeraddressflags(void* lpObj, int iBrokerAddressFlags);

int GetBrokerAddressFlags();
int SetBrokerAddressFlags(int iBrokerAddressFlags);

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

BrokerCity Property (FedExFreightShip Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerCity();
int SetBrokerCity(const char* lpszBrokerCity);

Unicode (Windows)
LPWSTR GetBrokerCity();
INT SetBrokerCity(LPCWSTR lpszBrokerCity);

char* dshippingsdk_fedexfreightship_getbrokercity(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokercity(void* lpObj, const char* lpszBrokerCity);

QString GetBrokerCity();
int SetBrokerCity(QString qsBrokerCity);

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

BrokerCountryCode Property (FedExFreightShip Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerCountryCode();
int SetBrokerCountryCode(const char* lpszBrokerCountryCode);

Unicode (Windows)
LPWSTR GetBrokerCountryCode();
INT SetBrokerCountryCode(LPCWSTR lpszBrokerCountryCode);

char* dshippingsdk_fedexfreightship_getbrokercountrycode(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokercountrycode(void* lpObj, const char* lpszBrokerCountryCode);

QString GetBrokerCountryCode();
int SetBrokerCountryCode(QString qsBrokerCountryCode);

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

BrokerState Property (FedExFreightShip Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerState();
int SetBrokerState(const char* lpszBrokerState);

Unicode (Windows)
LPWSTR GetBrokerState();
INT SetBrokerState(LPCWSTR lpszBrokerState);

char* dshippingsdk_fedexfreightship_getbrokerstate(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerstate(void* lpObj, const char* lpszBrokerState);

QString GetBrokerState();
int SetBrokerState(QString qsBrokerState);

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

BrokerZipCode Property (FedExFreightShip Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerZipCode();
int SetBrokerZipCode(const char* lpszBrokerZipCode);

Unicode (Windows)
LPWSTR GetBrokerZipCode();
INT SetBrokerZipCode(LPCWSTR lpszBrokerZipCode);

char* dshippingsdk_fedexfreightship_getbrokerzipcode(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerzipcode(void* lpObj, const char* lpszBrokerZipCode);

QString GetBrokerZipCode();
int SetBrokerZipCode(QString qsBrokerZipCode);

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 BrokerCity and BrokerState are not present.

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

Data Type

String

BrokerCompany Property (FedExFreightShip Class)

Identifies the contact person's company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerCompany();
int SetBrokerCompany(const char* lpszBrokerCompany);

Unicode (Windows)
LPWSTR GetBrokerCompany();
INT SetBrokerCompany(LPCWSTR lpszBrokerCompany);

char* dshippingsdk_fedexfreightship_getbrokercompany(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokercompany(void* lpObj, const char* lpszBrokerCompany);

QString GetBrokerCompany();
int SetBrokerCompany(QString qsBrokerCompany);

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either BrokerFirstName and BrokerLastName or BrokerCompany are required to be provided.

Data Type

String

BrokerEmail Property (FedExFreightShip Class)

Identifies the contact person's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerEmail();
int SetBrokerEmail(const char* lpszBrokerEmail);

Unicode (Windows)
LPWSTR GetBrokerEmail();
INT SetBrokerEmail(LPCWSTR lpszBrokerEmail);

char* dshippingsdk_fedexfreightship_getbrokeremail(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokeremail(void* lpObj, const char* lpszBrokerEmail);

QString GetBrokerEmail();
int SetBrokerEmail(QString qsBrokerEmail);

Default Value

""

Remarks

Identifies the contact person's email address. Maximum length: 120.

Data Type

String

BrokerFax Property (FedExFreightShip Class)

Recipient's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerFax();
int SetBrokerFax(const char* lpszBrokerFax);

Unicode (Windows)
LPWSTR GetBrokerFax();
INT SetBrokerFax(LPCWSTR lpszBrokerFax);

char* dshippingsdk_fedexfreightship_getbrokerfax(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerfax(void* lpObj, const char* lpszBrokerFax);

QString GetBrokerFax();
int SetBrokerFax(QString qsBrokerFax);

Default Value

""

Remarks

Recipient's fax number. The value of this property is optional. No format checking is done on international fax numbers.

Data Type

String

BrokerFirstName Property (FedExFreightShip Class)

Sender's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerFirstName();
int SetBrokerFirstName(const char* lpszBrokerFirstName);

Unicode (Windows)
LPWSTR GetBrokerFirstName();
INT SetBrokerFirstName(LPCWSTR lpszBrokerFirstName);

char* dshippingsdk_fedexfreightship_getbrokerfirstname(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerfirstname(void* lpObj, const char* lpszBrokerFirstName);

QString GetBrokerFirstName();
int SetBrokerFirstName(QString qsBrokerFirstName);

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either BrokerFirstName and BrokerLastName or BrokerCompany must be sent.

Data Type

String

BrokerLastName Property (FedExFreightShip Class)

Person's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerLastName();
int SetBrokerLastName(const char* lpszBrokerLastName);

Unicode (Windows)
LPWSTR GetBrokerLastName();
INT SetBrokerLastName(LPCWSTR lpszBrokerLastName);

char* dshippingsdk_fedexfreightship_getbrokerlastname(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerlastname(void* lpObj, const char* lpszBrokerLastName);

QString GetBrokerLastName();
int SetBrokerLastName(QString qsBrokerLastName);

Default Value

""

Remarks

Person's last name. The value of this property is required. Values for either BrokerFirstName and BrokerLastName or BrokerCompany must be sent. Maximum length: 45 characters for both names or company name.

Data Type

String

BrokerMiddleInitial Property (FedExFreightShip Class)

Middle initial.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerMiddleInitial();
int SetBrokerMiddleInitial(const char* lpszBrokerMiddleInitial);

Unicode (Windows)
LPWSTR GetBrokerMiddleInitial();
INT SetBrokerMiddleInitial(LPCWSTR lpszBrokerMiddleInitial);

char* dshippingsdk_fedexfreightship_getbrokermiddleinitial(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokermiddleinitial(void* lpObj, const char* lpszBrokerMiddleInitial);

QString GetBrokerMiddleInitial();
int SetBrokerMiddleInitial(QString qsBrokerMiddleInitial);

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

BrokerPhone Property (FedExFreightShip Class)

Identifies the contact person's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetBrokerPhone();
int SetBrokerPhone(const char* lpszBrokerPhone);

Unicode (Windows)
LPWSTR GetBrokerPhone();
INT SetBrokerPhone(LPCWSTR lpszBrokerPhone);

char* dshippingsdk_fedexfreightship_getbrokerphone(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokerphone(void* lpObj, const char* lpszBrokerPhone);

QString GetBrokerPhone();
int SetBrokerPhone(QString qsBrokerPhone);

Default Value

""

Remarks

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Data Type

String

BrokerType Property (FedExFreightShip Class)

Identifies the broker type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetBrokerType();
int SetBrokerType(int iBrokerType);

Unicode (Windows)
INT GetBrokerType();
INT SetBrokerType(INT iBrokerType);

BT_UNASSIGNED(0), 
BT_EXPORT(1), 
BT_IMPORT(2)

int dshippingsdk_fedexfreightship_getbrokertype(void* lpObj);
int dshippingsdk_fedexfreightship_setbrokertype(void* lpObj, int iBrokerType);

int GetBrokerType();
int SetBrokerType(int iBrokerType);

Default Value

0

Remarks

When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:

• stFedExInternationalPriority (20)
• stFedExInternationalEconomy (21)
• stFedExInternationalPriorityFreight (23)
• stFedExInternationalEconomyFreight (24)
• stFedExInternationalPriorityExpress (32)
• stFedExInternationalConnectPlus (33)

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

Possible values are:

Note this only applies when shipping internationally.

Data Type

Integer

CarrierType Property (FedExFreightShip Class)

The carrier type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCarrierType();
int SetCarrierType(int iCarrierType);

Unicode (Windows)
INT GetCarrierType();
INT SetCarrierType(INT iCarrierType);

CT_FDXC(0), 
CT_FDXE(1), 
CT_FDXG(2), 
CT_FXCC(3), 
CT_FXFR(4), 
CT_FXSP(5)

int dshippingsdk_fedexfreightship_getcarriertype(void* lpObj);
int dshippingsdk_fedexfreightship_setcarriertype(void* lpObj, int iCarrierType);

int GetCarrierType();
int SetCarrierType(int iCarrierType);

Default Value

1

Remarks

This specifies the carrier to be used when calling SchedulePickup, or CancelPickup.

The possible values are as follows:

Data Type

Integer

ClearanceBrokerageType Property (FedExFreightShip Class)

Specifies the type of brokerage to be applied to a shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetClearanceBrokerageType();
int SetClearanceBrokerageType(int iClearanceBrokerageType);

Unicode (Windows)
INT GetClearanceBrokerageType();
INT SetClearanceBrokerageType(INT iClearanceBrokerageType);

CB_UNASSIGNED(0), 
CB_INCLUSIVE(1), 
CB_INCLUSIVE_NON_RESIDENT_IMPORTER(2), 
CB_SELECT(3), 
CB_SELECT_NON_RESIDENT_IMPORTER(4)

int dshippingsdk_fedexfreightship_getclearancebrokeragetype(void* lpObj);
int dshippingsdk_fedexfreightship_setclearancebrokeragetype(void* lpObj, int iClearanceBrokerageType);

int GetClearanceBrokerageType();
int SetClearanceBrokerageType(int iClearanceBrokerageType);

Default Value

0

Remarks

When shipping internationally, the customer might want to have their own broker to deal with the delivery (for customs purposes). To request such service, the BrokerSelect option should be set in the ShipmentSpecialServices value. This allows you to designate a specific customs broker other than FedEx (or a FedEx designated broker). This is applicable to the following international FedEx services:

• stFedExInternationalPriority (20)
• stFedExInternationalEconomy (21)
• stFedExInternationalPriorityFreight (23)
• stFedExInternationalEconomyFreight (24)
• stFedExInternationalPriorityExpress (32)
• stFedExInternationalConnectPlus (33)

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

Possible values are:

Note this only applies when shipping internationally.

Data Type

Integer

CODLabel Property (FedExFreightShip Class)

The label that is returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCODLabel();

Unicode (Windows)
LPWSTR GetCODLabel();

char* dshippingsdk_fedexfreightship_getcodlabel(void* lpObj);

QString GetCODLabel();

Default Value

""

Remarks

If CODLabelFile is not set the image for the COD label this will be used to store the COD label.

Note that this will only be set if COD is used on the shipment level with an Express shipment.

This property is read-only.

Data Type

String

CODLabelFile Property (FedExFreightShip Class)

The file the COD label should be written to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCODLabelFile();
int SetCODLabelFile(const char* lpszCODLabelFile);

Unicode (Windows)
LPWSTR GetCODLabelFile();
INT SetCODLabelFile(LPCWSTR lpszCODLabelFile);

char* dshippingsdk_fedexfreightship_getcodlabelfile(void* lpObj);
int dshippingsdk_fedexfreightship_setcodlabelfile(void* lpObj, const char* lpszCODLabelFile);

QString GetCODLabelFile();
int SetCODLabelFile(QString qsCODLabelFile);

Default Value

""

Remarks

The COD label will be written to the file specified. If no file is specified then the image will be stored in memory in CODLabel.

Note that this will only be set if COD is used on the shipment level with an Express shipment.

Data Type

String

CODTotalAmount Property (FedExFreightShip 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_fedexfreightship_getcodtotalamount(void* lpObj);
int dshippingsdk_fedexfreightship_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

CODTrackingNumber Property (FedExFreightShip Class)

Contains the tracking number for the COD return shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCODTrackingNumber();

Unicode (Windows)
LPWSTR GetCODTrackingNumber();

char* dshippingsdk_fedexfreightship_getcodtrackingnumber(void* lpObj);

QString GetCODTrackingNumber();

Default Value

""

Remarks

When shipping COD via any of the domestic FedEx Express services, this is returned in the server response. This value can then be used to track the COD return package.

This property is read-only.

Data Type

String

CODType Property (FedExFreightShip 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_fedexfreightship_getcodtype(void* lpObj);
int dshippingsdk_fedexfreightship_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

CommercialInvoiceComments Property (FedExFreightShip Class)

Commercial Invoice comments to be uploaded to customs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceComments();
int SetCommercialInvoiceComments(const char* lpszCommercialInvoiceComments);

Unicode (Windows)
LPWSTR GetCommercialInvoiceComments();
INT SetCommercialInvoiceComments(LPCWSTR lpszCommercialInvoiceComments);

char* dshippingsdk_fedexfreightship_getcommercialinvoicecomments(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoicecomments(void* lpObj, const char* lpszCommercialInvoiceComments);

QString GetCommercialInvoiceComments();
int SetCommercialInvoiceComments(QString qsCommercialInvoiceComments);

Default Value

""

Remarks

Commercial Invoice comments to be uploaded to customs. This can be any extra information about the current shipment and is optional.

Data Type

String

CommercialInvoiceFreightCharge Property (FedExFreightShip Class)

Cost to transport the shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceFreightCharge();
int SetCommercialInvoiceFreightCharge(const char* lpszCommercialInvoiceFreightCharge);

Unicode (Windows)
LPWSTR GetCommercialInvoiceFreightCharge();
INT SetCommercialInvoiceFreightCharge(LPCWSTR lpszCommercialInvoiceFreightCharge);

char* dshippingsdk_fedexfreightship_getcommercialinvoicefreightcharge(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoicefreightcharge(void* lpObj, const char* lpszCommercialInvoiceFreightCharge);

QString GetCommercialInvoiceFreightCharge();
int SetCommercialInvoiceFreightCharge(QString qsCommercialInvoiceFreightCharge);

Default Value

"0.00"

Remarks

Cost to transport the shipment. This is required if CommercialInvoiceTerms is set to Cfr, Cpt, Cif, or Cip. This charge will be added to the total customs value amount.

Format: Two explicit decimal positions.

Data Type

String

CommercialInvoiceInsurance Property (FedExFreightShip Class)

The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceInsurance();
int SetCommercialInvoiceInsurance(const char* lpszCommercialInvoiceInsurance);

Unicode (Windows)
LPWSTR GetCommercialInvoiceInsurance();
INT SetCommercialInvoiceInsurance(LPCWSTR lpszCommercialInvoiceInsurance);

char* dshippingsdk_fedexfreightship_getcommercialinvoiceinsurance(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoiceinsurance(void* lpObj, const char* lpszCommercialInvoiceInsurance);

QString GetCommercialInvoiceInsurance();
int SetCommercialInvoiceInsurance(QString qsCommercialInvoiceInsurance);

Default Value

"0.00"

Remarks

The amount the shipper or receiver pays to cover the cost of replacing the shipment if it is lost or damaged. This is required if CommercialInvoiceTerms is set to Cif or Cip.. This charge will be added to the total customs value amount.

Format: Two explicit decimal positions.

Data Type

String

CommercialInvoiceNumber Property (FedExFreightShip Class)

Customer's assigned invoice number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCommercialInvoiceNumber();
int SetCommercialInvoiceNumber(const char* lpszCommercialInvoiceNumber);

Unicode (Windows)
LPWSTR GetCommercialInvoiceNumber();
INT SetCommercialInvoiceNumber(LPCWSTR lpszCommercialInvoiceNumber);

char* dshippingsdk_fedexfreightship_getcommercialinvoicenumber(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoicenumber(void* lpObj, const char* lpszCommercialInvoiceNumber);

QString GetCommercialInvoiceNumber();
int SetCommercialInvoiceNumber(QString qsCommercialInvoiceNumber);

Default Value

""

Remarks

Customer's assigned invoice number. This is optional. If included in the request, this element prints on the shipping label and commercial invoice.

Data Type

String

CommercialInvoicePurpose Property (FedExFreightShip Class)

Reason to export the current international shipment Required for dutiable international express or ground shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommercialInvoicePurpose();
int SetCommercialInvoicePurpose(int iCommercialInvoicePurpose);

Unicode (Windows)
INT GetCommercialInvoicePurpose();
INT SetCommercialInvoicePurpose(INT iCommercialInvoicePurpose);

CIP_SOLD(0), 
CIP_GIFT(1), 
CIP_NOT_SOLD(2), 
CIP_PERSONAL_EFFECTS(3), 
CIP_RETURN(4), 
CIP_REPAIR(5), 
CIP_REPAIR_AND_RETURN(6), 
CIP_SAMPLE(7), 
CIP_INTER_COMPANY_DATA(8)

int dshippingsdk_fedexfreightship_getcommercialinvoicepurpose(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoicepurpose(void* lpObj, int iCommercialInvoicePurpose);

int GetCommercialInvoicePurpose();
int SetCommercialInvoicePurpose(int iCommercialInvoicePurpose);

Default Value

0

Remarks

Reason to export the current international shipment

Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.

Valid values are:

Data Type

Integer

CommercialInvoiceTerms Property (FedExFreightShip Class)

Indicates the rights to the seller from the buyer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCommercialInvoiceTerms();
int SetCommercialInvoiceTerms(int iCommercialInvoiceTerms);

Unicode (Windows)
INT GetCommercialInvoiceTerms();
INT SetCommercialInvoiceTerms(INT iCommercialInvoiceTerms);

CIT_FCA(0), 
CIT_FOB(1), 
CIT_FAS(2), 
CIT_CFR(3), 
CIT_CIF(4), 
CIT_CIP(5), 
CIT_CPT(6), 
CIT_DAF(7), 
CIT_DDP(8), 
CIT_DDU(9), 
CIT_DEQ(10), 
CIT_DES(11), 
CIT_EXW(12)

int dshippingsdk_fedexfreightship_getcommercialinvoiceterms(void* lpObj);
int dshippingsdk_fedexfreightship_setcommercialinvoiceterms(void* lpObj, int iCommercialInvoiceTerms);

int GetCommercialInvoiceTerms();
int SetCommercialInvoiceTerms(int iCommercialInvoiceTerms);

Default Value

0

Remarks

Indicates the rights to the seller from the buyer.

Required for dutiable international express or ground shipment. This is not applicable to an international PIB (document) or a non-document which does not require a commercial invoice express shipment.

Valid values are:

Data Type

Integer

CommodityCount Property (FedExFreightShip 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_fedexfreightship_getcommoditycount(void* lpObj);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommoditydescription(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityfreightclass(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityfreightpackagingtype(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityhandlingunits(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityharmonizedcode(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityhazardousmaterialsoptions(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityheight(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityid(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommoditylength(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommoditymanufacturer(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommoditynmfccode(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommoditynumberofpieces(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommoditypartnumber(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityponumber(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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_fedexfreightship_getcommodityquantity(void* lpObj, int commodityidx);
int dshippingsdk_fedexfreightship_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 (FedExFreightShip 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);