FedExShipIntl Class

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a FedEx shipping label for any of FedEx international services complete with addresses and barcode, cancel a shipment, or close out the FedEx Ground shipments.

Syntax

FedExShipIntl

Remarks

Generating a shipping label can be done by calling either the GetPackageLabel or the 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 Locations, 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 FedExDeveloperKey, FedExPassword, FedExAccountNumber, and FedExMeterNumber.

When shipping with FedEx Ground, you can close out your shipments and generate a FedEx Ground Close Manifest by calling the CloseGroundShipments method.

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.

BrokerAddress1 Property (FedExShipIntl 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_fedexshipintl_getbrokeraddress1(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokeraddress2(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokeraddressflags(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokercity(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokercountrycode(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokerstate(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokerzipcode(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokercompany(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokeremail(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokerfax(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokerfirstname(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokerlastname(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokermiddleinitial(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokerphone(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getbrokertype(void* lpObj);
int dshippingsdk_fedexshipintl_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:

Data Type

Integer

ClearanceBrokerageType Property (FedExShipIntl 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_fedexshipintl_getclearancebrokeragetype(void* lpObj);
int dshippingsdk_fedexshipintl_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:

Data Type

Integer

CloseDate Property (FedExShipIntl Class)

Identifies the date up to which the unclosed FedEx Ground shipments are to be closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCloseDate();
int SetCloseDate(const char* lpszCloseDate);

Unicode (Windows)
LPWSTR GetCloseDate();
INT SetCloseDate(LPCWSTR lpszCloseDate);

char* dshippingsdk_fedexshipintl_getclosedate(void* lpObj);
int dshippingsdk_fedexshipintl_setclosedate(void* lpObj, const char* lpszCloseDate);

QString GetCloseDate();
int SetCloseDate(QString qsCloseDate);

Default Value

""

Remarks

Identifies the date up to which the unclosed FedEx Ground shipments are to be closed. The CloseDate and CloseTime are both required to be provided in a close operation request (when CloseGroundShipments method is called). If not provided, it will default to the current date.

This property is applicable for FedEx Ground services only. Format: YYYY-MM-DD (e.g. 2006-06-26).

Data Type

String

CloseReportFile Property (FedExShipIntl Class)

File name of the report to be saved and/or printed by customer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCloseReportFile();
int SetCloseReportFile(const char* lpszCloseReportFile);

Unicode (Windows)
LPWSTR GetCloseReportFile();
INT SetCloseReportFile(LPCWSTR lpszCloseReportFile);

char* dshippingsdk_fedexshipintl_getclosereportfile(void* lpObj);
int dshippingsdk_fedexshipintl_setclosereportfile(void* lpObj, const char* lpszCloseReportFile);

QString GetCloseReportFile();
int SetCloseReportFile(QString qsCloseReportFile);

Default Value

""

Remarks

File name of the report to be saved and/or printed by customer. A value (a name for the file) has to be assigned to this property if CloseReportType is set to a value other than 0 (Unspecified) when CloseGroundShipments is called. Depending on the value assigned to CloseReportType, the server response will include only one of the following reports: Manifest, MultiweightReport, COD Report or HazMatCertificate. The contents of any of these reports are written to disk in CloseReportFile. The file name must have the TXT extension.

This property is applicable for FedEx Ground services only.

Data Type

String

CloseReportType Property (FedExShipIntl Class)

Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCloseReportType();
int SetCloseReportType(int iCloseReportType);

Unicode (Windows)
INT GetCloseReportType();
INT SetCloseReportType(INT iCloseReportType);

CRT_UNSPECIFIED(0), 
CRT_MANIFEST(1), 
CRT_COD(2), 
CRT_HAZ_MAT(3), 
CRT_MULTIWEIGHT(4)

int dshippingsdk_fedexshipintl_getclosereporttype(void* lpObj);
int dshippingsdk_fedexshipintl_setclosereporttype(void* lpObj, int iCloseReportType);

int GetCloseReportType();
int SetCloseReportType(int iCloseReportType);

Default Value

0

Remarks

Indicates what type of report(s) from the last 3 days are to be returned in a report-only close operation request.

If this is set to a value other than 0 (Unspecified), the server with return that specific report from the last three closed shipping days. Otherwise, the server will return the shipment manifest along with all applicable reports.

When requesting a certain type of report, only one type can be returned per Close request. If you need multiple report types you will have to issue multiple CloseGroundShipments requests.

Valid report types are listed below:

This property is applicable for FedEx Ground services only.

NOTE: This only takes effect when calling ReprintDocuments.

Data Type

Integer

CloseTime Property (FedExShipIntl Class)

Identifies the time up to which the unclosed FedEx Ground shipments are to be closed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCloseTime();
int SetCloseTime(const char* lpszCloseTime);

Unicode (Windows)
LPWSTR GetCloseTime();
INT SetCloseTime(LPCWSTR lpszCloseTime);

char* dshippingsdk_fedexshipintl_getclosetime(void* lpObj);
int dshippingsdk_fedexshipintl_setclosetime(void* lpObj, const char* lpszCloseTime);

QString GetCloseTime();
int SetCloseTime(QString qsCloseTime);

Default Value

"19:00:00"

Remarks

Identifies the time up to which the unclosed FedEx Ground shipments are to be closed. The CloseDate and CloseTime are both required to be provided in a close operation request (when the CloseGroundShipments method is called).

Format: HH:MM:SS using a 24 hour clock. This property is applicable for FedEx Ground services only.

NOTE: This only takes effect when calling ReprintDocuments.

Data Type

String

CloseTrackingNumber Property (FedExShipIntl Class)

Shipment Ground tracking number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCloseTrackingNumber();
int SetCloseTrackingNumber(const char* lpszCloseTrackingNumber);

Unicode (Windows)
LPWSTR GetCloseTrackingNumber();
INT SetCloseTrackingNumber(LPCWSTR lpszCloseTrackingNumber);

char* dshippingsdk_fedexshipintl_getclosetrackingnumber(void* lpObj);
int dshippingsdk_fedexshipintl_setclosetrackingnumber(void* lpObj, const char* lpszCloseTrackingNumber);

QString GetCloseTrackingNumber();
int SetCloseTrackingNumber(QString qsCloseTrackingNumber);

Default Value

""

Remarks

Shipment Ground tracking number. Provided to obtain the manifest containing this tracking number. If you include the CloseTrackingNumber of a particular Ground shipment for which you want to print Ground reports (Manifest, C.O.D., Hazmat or Multiweight Detail), the report(s) requested in the CloseReportType element are returned.

Maximum length: 20 characters.

NOTE: This only takes effect when calling ReprintDocuments.

Data Type

String

CommercialInvoiceComments Property (FedExShipIntl 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_fedexshipintl_getcommercialinvoicecomments(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getcommercialinvoicefreightcharge(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getcommercialinvoiceinsurance(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getcommercialinvoicenumber(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getcommercialinvoicepurpose(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getcommercialinvoiceterms(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getcommoditycount(void* lpObj);
int dshippingsdk_fedexshipintl_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
• CommodityHarmonizedCode
• CommodityManufacturer
• CommodityNumberOfPieces
• CommodityQuantity
• CommodityQuantityUnit
• CommodityUnitPrice
• CommodityValue
• CommodityWeight

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

This property is not available at design time.

Data Type

Integer

CommodityDescription Property (FedExShipIntl 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_fedexshipintl_getcommoditydescription(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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. 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.

For FedEx, 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

CommodityHarmonizedCode Property (FedExShipIntl 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_fedexshipintl_getcommodityharmonizedcode(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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

CommodityManufacturer Property (FedExShipIntl 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_fedexshipintl_getcommoditymanufacturer(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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.

In USPS, the value of this property is optional, and is only used by commercial shippers. If PostageProvider is set to ppEndicia or ppStamps, then the format must be 2 charachters long (for example: US for United States, CA for Canada etc.).

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

CommodityNumberOfPieces Property (FedExShipIntl 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_fedexshipintl_getcommoditynumberofpieces(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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.

In UPS, it is required and applicable to CO only.

In FedEx, 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.

This property is not applicable to USPS.

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

CommodityQuantity Property (FedExShipIntl 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_fedexshipintl_getcommodityquantity(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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.

For FedEx, 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.

For UPS, these are all required for Invoice form type and optional for Partial Invoice (not applicable to other international form types).

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 (FedExShipIntl 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_fedexshipintl_getcommodityquantityunit(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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.

For FedEx, 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:

For UPS, this is required and applicable only to Invoice and Partial Invoice forms.

Here is a list of possible values for CommodityQuantityUnit:

This is not available for USPS.

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 (FedExShipIntl 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_fedexshipintl_getcommodityunitprice(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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.

For FedEx, 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.

For UPS, it is required and applicable to Invoice and Partial Invoice forms only.

For USPS, use the CommodityValue property instead.

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 (FedExShipIntl 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_fedexshipintl_getcommodityvalue(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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.

This property is only applicable to USPS and UPS freight.

Note: For USPS, the maximum value for this property is "99999.99".

Note: For UPS freight, the maximum value for this property is "99999999999999.99".

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 (FedExShipIntl 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_fedexshipintl_getcommodityweight(void* lpObj, int commodityidx);
int dshippingsdk_fedexshipintl_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.

For FedEx, 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.

For UPS, this is required and applicable to CO and SED forms only .

When using USPS and PostageProvider is set to ppNone, the format of this property must be "XX lbs YY oz", where XX is the number of pounds and YY is the number of ounces.

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

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

DeliveryDate Property (FedExShipIntl Class)

Date on which shipment is expected to be delivered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDeliveryDate();

Unicode (Windows)
LPWSTR GetDeliveryDate();

char* dshippingsdk_fedexshipintl_getdeliverydate(void* lpObj);

QString GetDeliveryDate();

Default Value

""

Remarks

When either the GetPackageLabel or the GetShipmentLabels method is called, the DeliveryDate will be returned in the server reply. For international shipments, this information is limited to a number of international countries.

This property is read-only.

Data Type

String

DutiesPayorAccountNumber Property (FedExShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDutiesPayorAccountNumber();
int SetDutiesPayorAccountNumber(const char* lpszDutiesPayorAccountNumber);

Unicode (Windows)
LPWSTR GetDutiesPayorAccountNumber();
INT SetDutiesPayorAccountNumber(LPCWSTR lpszDutiesPayorAccountNumber);

char* dshippingsdk_fedexshipintl_getdutiespayoraccountnumber(void* lpObj);
int dshippingsdk_fedexshipintl_setdutiespayoraccountnumber(void* lpObj, const char* lpszDutiesPayorAccountNumber);

QString GetDutiesPayorAccountNumber();
int SetDutiesPayorAccountNumber(QString qsDutiesPayorAccountNumber);

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 DutiesPayorPayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to DutiesPayorAccountNumber.

Data Type

String

DutiesPayorCountryCode Property (FedExShipIntl Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDutiesPayorCountryCode();
int SetDutiesPayorCountryCode(const char* lpszDutiesPayorCountryCode);

Unicode (Windows)
LPWSTR GetDutiesPayorCountryCode();
INT SetDutiesPayorCountryCode(LPCWSTR lpszDutiesPayorCountryCode);

char* dshippingsdk_fedexshipintl_getdutiespayorcountrycode(void* lpObj);
int dshippingsdk_fedexshipintl_setdutiespayorcountrycode(void* lpObj, const char* lpszDutiesPayorCountryCode);

QString GetDutiesPayorCountryCode();
int SetDutiesPayorCountryCode(QString qsDutiesPayorCountryCode);

Default Value

"US"

Remarks

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

When shipping via FedEx Express, the DutiesPayorCountryCode is required to be provided in the ship request only if DutiesPayorPayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the DutiesPayorCountryCode is required only if DutiesPayorPayorType 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

DutiesPayorType Property (FedExShipIntl Class)

Method of payment for shipment, or duties and taxes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetDutiesPayorType();
int SetDutiesPayorType(int iDutiesPayorType);

Unicode (Windows)
INT GetDutiesPayorType();
INT SetDutiesPayorType(INT iDutiesPayorType);

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

int dshippingsdk_fedexshipintl_getdutiespayortype(void* lpObj);
int dshippingsdk_fedexshipintl_setdutiespayortype(void* lpObj, int iDutiesPayorType);

int GetDutiesPayorType();
int SetDutiesPayorType(int iDutiesPayorType);

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 DutiesPayorAccountNumber and DutiesPayorCountryCode 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 DutiesPayorAccountNumber is automatically set to UPSAccountNumber. When ptRecipient is specified, DutiesPayorAccountNumber and DutiesPayorZipCode 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 DutiesPayorAccountNumber, DutiesPayorZipCode and DutiesPayorCountryCode 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

FedExAccountNumber Property (FedExShipIntl Class)

Account number for logging in to the FedEx Server .

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexshipintl_getfedexaccountnumber(void* lpObj);
int dshippingsdk_fedexshipintl_setfedexaccountnumber(void* lpObj, const char* lpszFedExAccountNumber);

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

Default Value

""

Remarks

Account number for logging in to the FedEx Server. An FedExAccountNumber and FedExMeterNumber will be required with each input request a user makes to a FedEx server.

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.

For all transaction whether they are Ground or Express service, you will need to pass your valid 9 digit FedEx account number.

Data Type

String

FedExAuthorizationToken Property (FedExShipIntl 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_fedexshipintl_getfedexauthorizationtoken(void* lpObj);
int dshippingsdk_fedexshipintl_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

FedExCSPProductId Property (FedExShipIntl Class)

Identifies the CSP product.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExCSPProductId();
int SetFedExCSPProductId(const char* lpszFedExCSPProductId);

Unicode (Windows)
LPWSTR GetFedExCSPProductId();
INT SetFedExCSPProductId(LPCWSTR lpszFedExCSPProductId);

char* dshippingsdk_fedexshipintl_getfedexcspproductid(void* lpObj);
int dshippingsdk_fedexshipintl_setfedexcspproductid(void* lpObj, const char* lpszFedExCSPProductId);

QString GetFedExCSPProductId();
int SetFedExCSPProductId(QString qsFedExCSPProductId);

Default Value

""

Remarks

Identifies the CSP product.

This is applicable to CSP developers only. It is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the rest of security elements: FedExAccountNumber, FedExMeterNumber, FedExDeveloperKey, FedExPassword, FedExCSPUserKey, FedExCSPUserPassword and FedExCSPProductVersion.

Data Type

String

FedExCSPProductVersion Property (FedExShipIntl Class)

Identifies the CSP product version.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExCSPProductVersion();
int SetFedExCSPProductVersion(const char* lpszFedExCSPProductVersion);

Unicode (Windows)
LPWSTR GetFedExCSPProductVersion();
INT SetFedExCSPProductVersion(LPCWSTR lpszFedExCSPProductVersion);

char* dshippingsdk_fedexshipintl_getfedexcspproductversion(void* lpObj);
int dshippingsdk_fedexshipintl_setfedexcspproductversion(void* lpObj, const char* lpszFedExCSPProductVersion);

QString GetFedExCSPProductVersion();
int SetFedExCSPProductVersion(QString qsFedExCSPProductVersion);

Default Value

""

Remarks

Identifies the CSP product version.

This is applicable to CSP developers only. It is provided by FedEx to the CSP developers and it is required to be present in all requests as part of the user details along with the rest of security elements: FedExAccountNumber, FedExMeterNumber, FedExDeveloperKey, FedExPassword, FedExCSPUserKey, FedExCSPUserPassword and FedExCSPProductId.

Data Type

String

FedExCSPUserKey Property (FedExShipIntl Class)

CSP end user key.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExCSPUserKey();
int SetFedExCSPUserKey(const char* lpszFedExCSPUserKey);

Unicode (Windows)
LPWSTR GetFedExCSPUserKey();
INT SetFedExCSPUserKey(LPCWSTR lpszFedExCSPUserKey);

char* dshippingsdk_fedexshipintl_getfedexcspuserkey(void* lpObj);
int dshippingsdk_fedexshipintl_setfedexcspuserkey(void* lpObj, const char* lpszFedExCSPUserKey);

QString GetFedExCSPUserKey();
int SetFedExCSPUserKey(QString qsFedExCSPUserKey);

Default Value

""

Remarks

CSP end user key.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique FedExCSPUserKey and FedExCSPUserPassword that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (FedExDeveloperKey and FedExPassword respectively).

Data Type

String

FedExCSPUserPassword Property (FedExShipIntl Class)

CSP end user password.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExCSPUserPassword();
int SetFedExCSPUserPassword(const char* lpszFedExCSPUserPassword);

Unicode (Windows)
LPWSTR GetFedExCSPUserPassword();
INT SetFedExCSPUserPassword(LPCWSTR lpszFedExCSPUserPassword);

char* dshippingsdk_fedexshipintl_getfedexcspuserpassword(void* lpObj);
int dshippingsdk_fedexshipintl_setfedexcspuserpassword(void* lpObj, const char* lpszFedExCSPUserPassword);

QString GetFedExCSPUserPassword();
int SetFedExCSPUserPassword(QString qsFedExCSPUserPassword);

Default Value

""

Remarks

CSP end user password.

This is applicable to CSP developers only. When registering a CSP user, FedEx provides a unique FedExCSPUserKey and FedExCSPUserPassword that identifies that user.

This end user key and password inherits the services enabled for the CSP credentials and must be passed in all subsequent requests sent to FedEx Web Services as the part of the user authentication along with the provider's (CSP) key and password (FedExDeveloperKey and FedExPassword respectively).

Data Type

String

FedExDeveloperKey Property (FedExShipIntl Class)

Identifying part of the authentication key used for the sender's identity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExDeveloperKey();
int SetFedExDeveloperKey(const char* lpszFedExDeveloperKey);

Unicode (Windows)
LPWSTR GetFedExDeveloperKey();
INT SetFedExDeveloperKey(LPCWSTR lpszFedExDeveloperKey);

char* dshippingsdk_fedexshipintl_getfedexdeveloperkey(void* lpObj);
int dshippingsdk_fedexshipintl_setfedexdeveloperkey(void* lpObj, const char* lpszFedExDeveloperKey);

QString GetFedExDeveloperKey();
int SetFedExDeveloperKey(QString qsFedExDeveloperKey);

Default Value

""

Remarks

Identifying part of the authentication key used for the sender's identity.

The FedExDeveloperKey is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Developer Key is provided to you by FedEx after registration and it is the publicly known part of authentication credential. The Developer Key may also be referred to as an Authentication Key.

The FedExDeveloperKey, FedExAccountNumber, FedExMeterNumber, and FedExPassword will be required with each input request a user makes to a FedEx server. This 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

FedExLanguageCode Property (FedExShipIntl 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_fedexshipintl_getfedexlanguagecode(void* lpObj);
int dshippingsdk_fedexshipintl_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 (FedExShipIntl 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_fedexshipintl_getfedexlocalecode(void* lpObj);
int dshippingsdk_fedexshipintl_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

FedExMeterNumber Property (FedExShipIntl Class)

Meter number to use for submitting requests to the FedEx Server .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExMeterNumber();
int SetFedExMeterNumber(const char* lpszFedExMeterNumber);

Unicode (Windows)
LPWSTR GetFedExMeterNumber();
INT SetFedExMeterNumber(LPCWSTR lpszFedExMeterNumber);

char* dshippingsdk_fedexshipintl_getfedexmeternumber(void* lpObj);
int dshippingsdk_fedexshipintl_setfedexmeternumber(void* lpObj, const char* lpszFedExMeterNumber);

QString GetFedExMeterNumber();
int SetFedExMeterNumber(QString qsFedExMeterNumber);

Default Value

""

Remarks

Meter number to use for submitting requests to the FedEx FedExServer.

An FedExAccountNumber and FedExMeterNumber will be required with each input request a user makes to a FedEx server. The Meter Number is provided to you by FedEx when you register for service. This 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

FedExPassword Property (FedExShipIntl Class)

Secret part of authentication key used for the sender's identity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetFedExPassword();
int SetFedExPassword(const char* lpszFedExPassword);

Unicode (Windows)
LPWSTR GetFedExPassword();
INT SetFedExPassword(LPCWSTR lpszFedExPassword);

char* dshippingsdk_fedexshipintl_getfedexpassword(void* lpObj);
int dshippingsdk_fedexshipintl_setfedexpassword(void* lpObj, const char* lpszFedExPassword);

QString GetFedExPassword();
int SetFedExPassword(QString qsFedExPassword);

Default Value

""

Remarks

Secret part of authentication key used for the sender's identity.

The FedExPassword is part of the authentication string used to verify sender's identity. This credential is used to authenticate a specific software application, so that your transactions are recognized by the FedEx back-end systems. The Password is provided to you by FedEx after registration and it is the private part of authentication credential, known only to the user and FedEx.

The FedExDeveloperKey, FedExAccountNumber, FedExMeterNumber, and FedExPassword will be required with each input request a user makes to a FedEx server. This 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

FedExServer Property (FedExShipIntl 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);