FedExShip Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

FedExShip

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

When shipping with FedEx Ground, you can close out your shipments and generate a FedEx Ground Close Manifest by calling 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.

CarrierType Property (FedExShip 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_fedexship_getcarriertype(void* lpObj);
int dshippingsdk_fedexship_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

CloseDate Property (FedExShip 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_fedexship_getclosedate(void* lpObj);
int dshippingsdk_fedexship_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 is 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. 2024-12-30).

Data Type

String

CloseReportFile Property (FedExShip Class)

Filename and location to save the report to.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getclosereportfile(void* lpObj);
int dshippingsdk_fedexship_setclosereportfile(void* lpObj, const char* lpszCloseReportFile);

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

Default Value

""

Remarks

Filename and location to save the report to. When the CloseReportFile is set to a valid path and filename, the content of the report is written to disk upon successful response. 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. The file name must have the TXT extension.

This property is applicable for FedEx Ground services only.

Data Type

String

CloseReportType Property (FedExShip 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_OP950(2)

int dshippingsdk_fedexship_getclosereporttype(void* lpObj);
int dshippingsdk_fedexship_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.

Data Type

Integer

CloseTrackingNumber Property (FedExShip 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_fedexship_getclosetrackingnumber(void* lpObj);
int dshippingsdk_fedexship_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

CODLabel Property (FedExShip Class)

The label that is returned.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCODLabel();

Unicode (Windows)
LPWSTR GetCODLabel();

char* dshippingsdk_fedexship_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 (FedExShip 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_fedexship_getcodlabelfile(void* lpObj);
int dshippingsdk_fedexship_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 (FedExShip 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_fedexship_getcodtotalamount(void* lpObj);
int dshippingsdk_fedexship_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 (FedExShip 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_fedexship_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 (FedExShip 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_fedexship_getcodtype(void* lpObj);
int dshippingsdk_fedexship_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

CompanyCloseTime Property (FedExShip Class)

The time your company closes.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCompanyCloseTime();
int SetCompanyCloseTime(const char* lpszCompanyCloseTime);

Unicode (Windows)
LPWSTR GetCompanyCloseTime();
INT SetCompanyCloseTime(LPCWSTR lpszCompanyCloseTime);

char* dshippingsdk_fedexship_getcompanyclosetime(void* lpObj);
int dshippingsdk_fedexship_setcompanyclosetime(void* lpObj, const char* lpszCompanyCloseTime);

QString GetCompanyCloseTime();
int SetCompanyCloseTime(QString qsCompanyCloseTime);

Default Value

""

Remarks

This property is required for PickupAvailability and SchedulePickup requests. The ShipTime can be used to set the ready time stamp for the pickup. The ShipTime and the CompanyCloseTime must allow a long enough time period for the pickup to occur.

Data Type

String

DeliveryDate Property (FedExShip 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_fedexship_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

FedExAccountNumber Property (FedExShip Class)

The account number associated with the shipment.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getfedexaccountnumber(void* lpObj);
int dshippingsdk_fedexship_setfedexaccountnumber(void* lpObj, const char* lpszFedExAccountNumber);

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

Default Value

""

Remarks

The account number associated with the shipment.

The FedExAccountNumber is not to be shared with others outside your organization, nor is it to be packaged, distributed, or sold to any other person or entity.

Data Type

String

FedExAuthorizationToken Property (FedExShip 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_fedexship_getfedexauthorizationtoken(void* lpObj);
int dshippingsdk_fedexship_setfedexauthorizationtoken(void* lpObj, const char* lpszFedExAuthorizationToken);

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

Default Value

""

Remarks

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

Data Type

String

FedExLanguageCode Property (FedExShip 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_fedexship_getfedexlanguagecode(void* lpObj);
int dshippingsdk_fedexship_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 (FedExShip 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_fedexship_getfedexlocalecode(void* lpObj);
int dshippingsdk_fedexship_setfedexlocalecode(void* lpObj, const char* lpszFedExLocaleCode);

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

Default Value

"US"

Remarks

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

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

Data Type

String

FedExServer Property (FedExShip Class)

URL for the FedEx Server where the requests are sent.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getfedexserver(void* lpObj);
int dshippingsdk_fedexship_setfedexserver(void* lpObj, const char* lpszFedExServer);

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

Default Value

""

Remarks

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

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

Data Type

String

FirewallAutoDetect Property (FedExShip Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_fedexship_getfirewallautodetect(void* lpObj);
int dshippingsdk_fedexship_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

FirewallType Property (FedExShip Class)

This property determines the type of firewall to connect through.

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_fedexship_getfirewalltype(void* lpObj);
int dshippingsdk_fedexship_setfirewalltype(void* lpObj, int iFirewallType);

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

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (FedExShip Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getfirewallhost(void* lpObj);
int dshippingsdk_fedexship_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

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

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (FedExShip Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getfirewallpassword(void* lpObj);
int dshippingsdk_fedexship_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

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

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (FedExShip Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_fedexship_getfirewallport(void* lpObj);
int dshippingsdk_fedexship_setfirewallport(void* lpObj, int iFirewallPort);

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

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (FedExShip Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getfirewalluser(void* lpObj);
int dshippingsdk_fedexship_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FreightGuaranteeDate Property (FedExShip Class)

The date the freight shipment is guaranteed for.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getfreightguaranteedate(void* lpObj);
int dshippingsdk_fedexship_setfreightguaranteedate(void* lpObj, const char* lpszFreightGuaranteeDate);

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

Default Value

""

Remarks

The date the freight shipment is guaranteed for.

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

Data Type

String

FreightGuaranteeType Property (FedExShip Class)

Specifies what type of freight guarantee is requested.

Syntax

• C++
• C
• Qt

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

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

FGT_GUARANTEED_DATE(0), 
FGT_GUARANTEED_MORNING(1)

int dshippingsdk_fedexship_getfreightguaranteetype(void* lpObj);
int dshippingsdk_fedexship_setfreightguaranteetype(void* lpObj, int iFreightGuaranteeType);

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

Default Value

0

Remarks

Specifies what type of freight guarantee is requested.

The valid values are:

Data Type

Integer

HoldAtLocationAddress1 Property (FedExShip Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationAddress1();
int SetHoldAtLocationAddress1(const char* lpszHoldAtLocationAddress1);

Unicode (Windows)
LPWSTR GetHoldAtLocationAddress1();
INT SetHoldAtLocationAddress1(LPCWSTR lpszHoldAtLocationAddress1);

char* dshippingsdk_fedexship_getholdatlocationaddress1(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationaddress1(void* lpObj, const char* lpszHoldAtLocationAddress1);

QString GetHoldAtLocationAddress1();
int SetHoldAtLocationAddress1(QString qsHoldAtLocationAddress1);

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

Data Type

String

HoldAtLocationAddress2 Property (FedExShip Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationAddress2();
int SetHoldAtLocationAddress2(const char* lpszHoldAtLocationAddress2);

Unicode (Windows)
LPWSTR GetHoldAtLocationAddress2();
INT SetHoldAtLocationAddress2(LPCWSTR lpszHoldAtLocationAddress2);

char* dshippingsdk_fedexship_getholdatlocationaddress2(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationaddress2(void* lpObj, const char* lpszHoldAtLocationAddress2);

QString GetHoldAtLocationAddress2();
int SetHoldAtLocationAddress2(QString qsHoldAtLocationAddress2);

Default Value

""

Remarks

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

Data Type

String

HoldAtLocationCity Property (FedExShip Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationCity();
int SetHoldAtLocationCity(const char* lpszHoldAtLocationCity);

Unicode (Windows)
LPWSTR GetHoldAtLocationCity();
INT SetHoldAtLocationCity(LPCWSTR lpszHoldAtLocationCity);

char* dshippingsdk_fedexship_getholdatlocationcity(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcity(void* lpObj, const char* lpszHoldAtLocationCity);

QString GetHoldAtLocationCity();
int SetHoldAtLocationCity(QString qsHoldAtLocationCity);

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

HoldAtLocationCountryCode Property (FedExShip Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationCountryCode();
int SetHoldAtLocationCountryCode(const char* lpszHoldAtLocationCountryCode);

Unicode (Windows)
LPWSTR GetHoldAtLocationCountryCode();
INT SetHoldAtLocationCountryCode(LPCWSTR lpszHoldAtLocationCountryCode);

char* dshippingsdk_fedexship_getholdatlocationcountrycode(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcountrycode(void* lpObj, const char* lpszHoldAtLocationCountryCode);

QString GetHoldAtLocationCountryCode();
int SetHoldAtLocationCountryCode(QString qsHoldAtLocationCountryCode);

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

HoldAtLocationState Property (FedExShip Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationState();
int SetHoldAtLocationState(const char* lpszHoldAtLocationState);

Unicode (Windows)
LPWSTR GetHoldAtLocationState();
INT SetHoldAtLocationState(LPCWSTR lpszHoldAtLocationState);

char* dshippingsdk_fedexship_getholdatlocationstate(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationstate(void* lpObj, const char* lpszHoldAtLocationState);

QString GetHoldAtLocationState();
int SetHoldAtLocationState(QString qsHoldAtLocationState);

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

HoldAtLocationZipCode Property (FedExShip Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationZipCode();
int SetHoldAtLocationZipCode(const char* lpszHoldAtLocationZipCode);

Unicode (Windows)
LPWSTR GetHoldAtLocationZipCode();
INT SetHoldAtLocationZipCode(LPCWSTR lpszHoldAtLocationZipCode);

char* dshippingsdk_fedexship_getholdatlocationzipcode(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationzipcode(void* lpObj, const char* lpszHoldAtLocationZipCode);

QString GetHoldAtLocationZipCode();
int SetHoldAtLocationZipCode(QString qsHoldAtLocationZipCode);

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 HoldAtLocationCity and HoldAtLocationState are not present.

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

Data Type

String

HoldAtLocationContactCompany Property (FedExShip Class)

Identifies the contact person's company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationContactCompany();
int SetHoldAtLocationContactCompany(const char* lpszHoldAtLocationContactCompany);

Unicode (Windows)
LPWSTR GetHoldAtLocationContactCompany();
INT SetHoldAtLocationContactCompany(LPCWSTR lpszHoldAtLocationContactCompany);

char* dshippingsdk_fedexship_getholdatlocationcontactcompany(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcontactcompany(void* lpObj, const char* lpszHoldAtLocationContactCompany);

QString GetHoldAtLocationContactCompany();
int SetHoldAtLocationContactCompany(QString qsHoldAtLocationContactCompany);

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either HoldAtLocationContactFirstName and HoldAtLocationContactLastName or HoldAtLocationContactCompany are required to be provided.

Data Type

String

HoldAtLocationContactEmail Property (FedExShip Class)

Identifies the contact person's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationContactEmail();
int SetHoldAtLocationContactEmail(const char* lpszHoldAtLocationContactEmail);

Unicode (Windows)
LPWSTR GetHoldAtLocationContactEmail();
INT SetHoldAtLocationContactEmail(LPCWSTR lpszHoldAtLocationContactEmail);

char* dshippingsdk_fedexship_getholdatlocationcontactemail(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcontactemail(void* lpObj, const char* lpszHoldAtLocationContactEmail);

QString GetHoldAtLocationContactEmail();
int SetHoldAtLocationContactEmail(QString qsHoldAtLocationContactEmail);

Default Value

""

Remarks

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

Data Type

String

HoldAtLocationContactFax Property (FedExShip Class)

Recipient's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationContactFax();
int SetHoldAtLocationContactFax(const char* lpszHoldAtLocationContactFax);

Unicode (Windows)
LPWSTR GetHoldAtLocationContactFax();
INT SetHoldAtLocationContactFax(LPCWSTR lpszHoldAtLocationContactFax);

char* dshippingsdk_fedexship_getholdatlocationcontactfax(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcontactfax(void* lpObj, const char* lpszHoldAtLocationContactFax);

QString GetHoldAtLocationContactFax();
int SetHoldAtLocationContactFax(QString qsHoldAtLocationContactFax);

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

HoldAtLocationContactFirstName Property (FedExShip Class)

Sender's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationContactFirstName();
int SetHoldAtLocationContactFirstName(const char* lpszHoldAtLocationContactFirstName);

Unicode (Windows)
LPWSTR GetHoldAtLocationContactFirstName();
INT SetHoldAtLocationContactFirstName(LPCWSTR lpszHoldAtLocationContactFirstName);

char* dshippingsdk_fedexship_getholdatlocationcontactfirstname(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcontactfirstname(void* lpObj, const char* lpszHoldAtLocationContactFirstName);

QString GetHoldAtLocationContactFirstName();
int SetHoldAtLocationContactFirstName(QString qsHoldAtLocationContactFirstName);

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either HoldAtLocationContactFirstName and HoldAtLocationContactLastName or HoldAtLocationContactCompany must be sent.

Data Type

String

HoldAtLocationContactLastName Property (FedExShip Class)

Person's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationContactLastName();
int SetHoldAtLocationContactLastName(const char* lpszHoldAtLocationContactLastName);

Unicode (Windows)
LPWSTR GetHoldAtLocationContactLastName();
INT SetHoldAtLocationContactLastName(LPCWSTR lpszHoldAtLocationContactLastName);

char* dshippingsdk_fedexship_getholdatlocationcontactlastname(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcontactlastname(void* lpObj, const char* lpszHoldAtLocationContactLastName);

QString GetHoldAtLocationContactLastName();
int SetHoldAtLocationContactLastName(QString qsHoldAtLocationContactLastName);

Default Value

""

Remarks

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

Data Type

String

HoldAtLocationContactMiddleInitial Property (FedExShip Class)

Middle initial.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationContactMiddleInitial();
int SetHoldAtLocationContactMiddleInitial(const char* lpszHoldAtLocationContactMiddleInitial);

Unicode (Windows)
LPWSTR GetHoldAtLocationContactMiddleInitial();
INT SetHoldAtLocationContactMiddleInitial(LPCWSTR lpszHoldAtLocationContactMiddleInitial);

char* dshippingsdk_fedexship_getholdatlocationcontactmiddleinitial(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcontactmiddleinitial(void* lpObj, const char* lpszHoldAtLocationContactMiddleInitial);

QString GetHoldAtLocationContactMiddleInitial();
int SetHoldAtLocationContactMiddleInitial(QString qsHoldAtLocationContactMiddleInitial);

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

HoldAtLocationContactPhone Property (FedExShip Class)

Identifies the contact person's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationContactPhone();
int SetHoldAtLocationContactPhone(const char* lpszHoldAtLocationContactPhone);

Unicode (Windows)
LPWSTR GetHoldAtLocationContactPhone();
INT SetHoldAtLocationContactPhone(LPCWSTR lpszHoldAtLocationContactPhone);

char* dshippingsdk_fedexship_getholdatlocationcontactphone(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationcontactphone(void* lpObj, const char* lpszHoldAtLocationContactPhone);

QString GetHoldAtLocationContactPhone();
int SetHoldAtLocationContactPhone(QString qsHoldAtLocationContactPhone);

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

HoldAtLocationPhone Property (FedExShip Class)

Phone number of the FedEx location where the shipment will be hold at.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetHoldAtLocationPhone();
int SetHoldAtLocationPhone(const char* lpszHoldAtLocationPhone);

Unicode (Windows)
LPWSTR GetHoldAtLocationPhone();
INT SetHoldAtLocationPhone(LPCWSTR lpszHoldAtLocationPhone);

char* dshippingsdk_fedexship_getholdatlocationphone(void* lpObj);
int dshippingsdk_fedexship_setholdatlocationphone(void* lpObj, const char* lpszHoldAtLocationPhone);

QString GetHoldAtLocationPhone();
int SetHoldAtLocationPhone(QString qsHoldAtLocationPhone);

Default Value

""

Remarks

When your Hold at Location shipment is received at the designated FedEx station, you will be notified that your shipment is ready to be picked up. It is required to be provided in a HoldAtLocation request.

Data Type

String

HomeDeliveryDate Property (FedExShip Class)

Date for Ground Home Delivery service.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_gethomedeliverydate(void* lpObj);
int dshippingsdk_fedexship_sethomedeliverydate(void* lpObj, const char* lpszHomeDeliveryDate);

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

Default Value

""

Remarks

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

Format: YYYY-MM-DD.

Data Type

String

HomeDeliveryPhone Property (FedExShip Class)

The phone number of the delivery location.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_gethomedeliveryphone(void* lpObj);
int dshippingsdk_fedexship_sethomedeliveryphone(void* lpObj, const char* lpszHomeDeliveryPhone);

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

Default Value

""

Remarks

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

Data Type

String

HomeDeliveryType Property (FedExShip Class)

The type of Home Delivery Premium service being requested.

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_fedexship_gethomedeliverytype(void* lpObj);
int dshippingsdk_fedexship_sethomedeliverytype(void* lpObj, int iHomeDeliveryType);

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

Default Value

0

Remarks

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

Possible values are as follows:

Data Type

Integer

InsuredValue Property (FedExShip Class)

Total insured amount.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getinsuredvalue(void* lpObj);
int dshippingsdk_fedexship_setinsuredvalue(void* lpObj, const char* lpszInsuredValue);

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

Default Value

"0.00"

Remarks

This element is optional. This is just insurance on the whole shipment if it is lost or stolen. If not provided in the request, FedEx will assume the 0 USD value. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

Data Type

String

LabelImageType Property (FedExShip Class)

Type of image or printer commands the label is to be formatted in.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetLabelImageType();
int SetLabelImageType(int iLabelImageType);

Unicode (Windows)
INT GetLabelImageType();
INT SetLabelImageType(INT iLabelImageType);

FIT_PDF(0), 
FIT_PNG(1), 
FIT_ELTRON(2), 
FIT_ZEBRA(3), 
FIT_UNI_MARK(4)

int dshippingsdk_fedexship_getlabelimagetype(void* lpObj);
int dshippingsdk_fedexship_setlabelimagetype(void* lpObj, int iLabelImageType);

int GetLabelImageType();
int SetLabelImageType(int iLabelImageType);

Default Value

0

Remarks

This element is required to indicate the format that the shipping label should be printed in. This must be set when either GetPackageLabel or GetShipmentLabels are called. The values for the thermal printers indicate the type of printer that is being used.

Valid image types and their meanings with the corresponding usage are listed below:

There are two types of shipping labels supported:

• plain paper (to be used in laser printers only. In this case, possible values for the LabelImageType are PNG or PDF),
• thermal (to be used in thermal printers only. In this case, possible values for the LabelImageType are ELTRON, ZEBRA, or UNIMARK).

While the content of each of these labels is the same, using the correct image type for the work environment the application will be used in is essential.

You may use the LabelStockType config to specify the size of the label. By default, the class will request a 4x6 label.

Data Type

Integer

Location Property (FedExShip Class)

The FedEx location identifier that received the express dispatch request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetLocation();
int SetLocation(const char* lpszLocation);

Unicode (Windows)
LPWSTR GetLocation();
INT SetLocation(LPCWSTR lpszLocation);

char* dshippingsdk_fedexship_getlocation(void* lpObj);
int dshippingsdk_fedexship_setlocation(void* lpObj, const char* lpszLocation);

QString GetLocation();
int SetLocation(QString qsLocation);

Default Value

""

Remarks

This property is returned after a call to SchedulePickup and contains the Id of the FedEx location that is scheduled to pick up the package.

When calling CancelPickup, this property must be supplied for the cancel request to be successful.

Data Type

String

Manifest Property (FedExShip Class)

Image of the manifest for FedEx Ground shipment activity.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetManifest(char* &lpManifest, int &lenManifest);

Unicode (Windows)
INT GetManifest(LPSTR &lpManifest, INT &lenManifest);

int dshippingsdk_fedexship_getmanifest(void* lpObj, char** lpManifest, int* lenManifest);

QByteArray GetManifest();

Default Value

""

Remarks

This identifies the buffer containing the ASCII data contents of the manifest report for FedEx Ground shipments.

When the CloseGroundShipments method is called, the Manifest is returned when the CloseTrackingNumber is present in the request and Manifest indicates the manifest containing that tracking number, or when the CloseReportType is set to 1 (Manifest). In the last case, this will indicate all manifests from the last 3 days' Closes.

The report is generated in TXT format and saved to disk under CloseReportFile. The manifest is essential at the time of pickup.

This property is applicable for FedEx Ground services only.

This property is read-only.

Data Type

Binary String

MasterTrackingNumber Property (FedExShip Class)

Tracking number assigned to the whole MPS shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetMasterTrackingNumber();

Unicode (Windows)
LPWSTR GetMasterTrackingNumber();

char* dshippingsdk_fedexship_getmastertrackingnumber(void* lpObj);

QString GetMasterTrackingNumber();

Default Value

""

Remarks

This is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when either the GetPackageLabel or the GetShipmentLabels method is called.

This value is used as parameter when a cancel shipment request is sent (i.e., when the CancelShipment method is called). It can also be used when tracking a MPS.

This property is read-only.

Data Type

String

NotifyCount Property (FedExShip Class)

The number of records in the Notify arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyCount();
int SetNotifyCount(int iNotifyCount);

Unicode (Windows)
INT GetNotifyCount();
INT SetNotifyCount(INT iNotifyCount);

int dshippingsdk_fedexship_getnotifycount(void* lpObj);
int dshippingsdk_fedexship_setnotifycount(void* lpObj, int iNotifyCount);

int GetNotifyCount();
int SetNotifyCount(int iNotifyCount);

Default Value

0

Remarks

This property controls the size of the following arrays:

• NotifyAggregate
• NotifyEmail
• NotifyFlags
• NotifyMessage
• NotifyName
• NotifyType

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

This property is not available at design time.

Data Type

Integer

NotifyAggregate Property (FedExShip Class)

This can be used to set the entire aggregate xml for the recipient to be notified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyAggregate(int iNotifyIdx);
int SetNotifyAggregate(int iNotifyIdx, const char* lpszNotifyAggregate);

Unicode (Windows)
LPWSTR GetNotifyAggregate(INT iNotifyIdx);
INT SetNotifyAggregate(INT iNotifyIdx, LPCWSTR lpszNotifyAggregate);

char* dshippingsdk_fedexship_getnotifyaggregate(void* lpObj, int notifyidx);
int dshippingsdk_fedexship_setnotifyaggregate(void* lpObj, int notifyidx, const char* lpszNotifyAggregate);

QString GetNotifyAggregate(int iNotifyIdx);
int SetNotifyAggregate(int iNotifyIdx, QString qsNotifyAggregate);

Default Value

""

Remarks

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows: <EMailNotificationDetail> <PersonalMessage>personal_message</PersonalMessage> <Recipients> (this aggregate can be entered up to six times) <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType> <EMailAddress>recipient_email</EMailAddress> <NotifyOnShipment>true_or_false</NotifyOnShipment> <NotifyOnException>true_or_false</NotifyOnException> <NotifyOnDelivery>true_or_false</NotifyOnDelivery> <Format>format_type</Format> <Localization> <LanguageCode>language_code</LanguageCode> </Localization> </Recipients> </EMailNotificationDetail>

In this aggregate, you can specify:

• a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
• the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
• the recipient's email address (via the EMailAddress element). This is required.
• whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
• the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
• the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).

This setting is optional. If NotifyAggregate is not set it will be automatically created by the class.

UPS

For UPS, the following JSON format is valid: { "NotificationCode": "6", "EMail": { "EMailAddress": [ "recipient1_email", (up to five recipient emails) "recipient2_email" ], "UndeliverableEMailAddress": "undeliverable_email", "FromEMailAddress": "sender_email", "FromName": "sender_name", "Memo": "message" } }

In this aggregate, you can specify:

• a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
• the recipient's email address (via the EMailAddress element). This is required.
• the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
• the email address for the reply-to address. The From field of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
• an optional from name.
• a message text to be sent in the email notification (via the Memo element). This is optional.

Note that this property does not apply for USPS and CanadaPost.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyEmail Property (FedExShip Class)

Email address of the recipient to be notified.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyEmail(int iNotifyIdx);
int SetNotifyEmail(int iNotifyIdx, const char* lpszNotifyEmail);

Unicode (Windows)
LPWSTR GetNotifyEmail(INT iNotifyIdx);
INT SetNotifyEmail(INT iNotifyIdx, LPCWSTR lpszNotifyEmail);

char* dshippingsdk_fedexship_getnotifyemail(void* lpObj, int notifyidx);
int dshippingsdk_fedexship_setnotifyemail(void* lpObj, int notifyidx, const char* lpszNotifyEmail);

QString GetNotifyEmail(int iNotifyIdx);
int SetNotifyEmail(int iNotifyIdx, QString qsNotifyEmail);

Default Value

""

Remarks

Email address of the recipient to be notified. This is required to be provided for each recipient.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyMessage Property (FedExShip Class)

User defined text that will be included in the email to be sent to Email .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyMessage(int iNotifyIdx);
int SetNotifyMessage(int iNotifyIdx, const char* lpszNotifyMessage);

Unicode (Windows)
LPWSTR GetNotifyMessage(INT iNotifyIdx);
INT SetNotifyMessage(INT iNotifyIdx, LPCWSTR lpszNotifyMessage);

char* dshippingsdk_fedexship_getnotifymessage(void* lpObj, int notifyidx);
int dshippingsdk_fedexship_setnotifymessage(void* lpObj, int notifyidx, const char* lpszNotifyMessage);

QString GetNotifyMessage(int iNotifyIdx);
int SetNotifyMessage(int iNotifyIdx, QString qsNotifyMessage);

Default Value

""

Remarks

User defined text that will be included in the email to be sent to NotifyEmail. This is optional.

For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

This property is not used by USPS or Canada Post.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyName Property (FedExShip Class)

The name associated with the notification.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNotifyName(int iNotifyIdx);
int SetNotifyName(int iNotifyIdx, const char* lpszNotifyName);

Unicode (Windows)
LPWSTR GetNotifyName(INT iNotifyIdx);
INT SetNotifyName(INT iNotifyIdx, LPCWSTR lpszNotifyName);

char* dshippingsdk_fedexship_getnotifyname(void* lpObj, int notifyidx);
int dshippingsdk_fedexship_setnotifyname(void* lpObj, int notifyidx, const char* lpszNotifyName);

QString GetNotifyName(int iNotifyIdx);
int SetNotifyName(int iNotifyIdx, QString qsNotifyName);

Default Value

""

Remarks

The name associated with the notification.

For USPS, this name will appear in the text of the Signature Confirmation e-mail message.

This property is not applicable to FedEx, UPS, or Canada Post.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

String

NotifyFlags Property (FedExShip Class)

Identifies the type of notification requested.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyFlags(int iNotifyIdx);
int SetNotifyFlags(int iNotifyIdx, int iNotifyFlags);

Unicode (Windows)
INT GetNotifyFlags(INT iNotifyIdx);
INT SetNotifyFlags(INT iNotifyIdx, INT iNotifyFlags);

int dshippingsdk_fedexship_getnotifyflags(void* lpObj, int notifyidx);
int dshippingsdk_fedexship_setnotifyflags(void* lpObj, int notifyidx, int iNotifyFlags);

int GetNotifyFlags(int iNotifyIdx);
int SetNotifyFlags(int iNotifyIdx, int iNotifyFlags);

Default Value

0

Remarks

Identifies the type of notification requested. Valid values are:

For FedEx notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Tender
• On Estimated Delivery
• HTML
• Text

For UPS notifications, the following flags apply:

• On Shipment
• On Exception
• On Delivery
• On Return
• In Transit
• ADL
• UAP

For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.

This field is not used by USPS.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

Integer

NotifyType Property (FedExShip Class)

Identifies the set of valid email notification recipient types.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNotifyType(int iNotifyIdx);
int SetNotifyType(int iNotifyIdx, int iNotifyType);

Unicode (Windows)
INT GetNotifyType(INT iNotifyIdx);
INT SetNotifyType(INT iNotifyIdx, INT iNotifyType);

RT_UNSPECIFIED(0), 
RT_RECIPIENT(1), 
RT_SHIPPER(2), 
RT_BROKER(3), 
RT_OTHER(4), 
RT_THIRD_PARTY(5)

int dshippingsdk_fedexship_getnotifytype(void* lpObj, int notifyidx);
int dshippingsdk_fedexship_setnotifytype(void* lpObj, int notifyidx, int iNotifyType);

int GetNotifyType(int iNotifyIdx);
int SetNotifyType(int iNotifyIdx, int iNotifyType);

Default Value

0

Remarks

Identifies the set of valid email notification recipient types. Valid values are:

For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the NotifyEmail specified for these types will be ignored.

For USPS, only the rtShipper and rtRecipient are valid.

This property does not apply to UPS or Canada Post notifications.

The NotifyIdx parameter specifies the index of the item in the array. The size of the array is controlled by the NotifyCount property.

This property is not available at design time.

Data Type

Integer

OP950Certificate Property (FedExShip Class)

Image of the OP_950 certification report.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOP950Certificate(char* &lpOP950Certificate, int &lenOP950Certificate);

Unicode (Windows)
INT GetOP950Certificate(LPSTR &lpOP950Certificate, INT &lenOP950Certificate);

int dshippingsdk_fedexship_getop950certificate(void* lpObj, char** lpOP950Certificate, int* lenOP950Certificate);

QByteArray GetOP950Certificate();

Default Value

""

Remarks

This identifies the buffer containing the OP_950 certification report for FedEx Ground shipments.

When calling the CloseGroundShipments method, the OP950Certificate is returned when CloseReportType is set to 2 (OP950).

The report is generated in TXT format. The report will automatically be saved to disk in the file designated by CloseReportFile.

This property is applicable for FedEx Ground services only.

This property is read-only.

Data Type

Binary String

OriginAddress1 Property (FedExShip Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginAddress1();
int SetOriginAddress1(const char* lpszOriginAddress1);

Unicode (Windows)
LPWSTR GetOriginAddress1();
INT SetOriginAddress1(LPCWSTR lpszOriginAddress1);

char* dshippingsdk_fedexship_getoriginaddress1(void* lpObj);
int dshippingsdk_fedexship_setoriginaddress1(void* lpObj, const char* lpszOriginAddress1);

QString GetOriginAddress1();
int SetOriginAddress1(QString qsOriginAddress1);

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

Data Type

String

OriginAddress2 Property (FedExShip Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginAddress2();
int SetOriginAddress2(const char* lpszOriginAddress2);

Unicode (Windows)
LPWSTR GetOriginAddress2();
INT SetOriginAddress2(LPCWSTR lpszOriginAddress2);

char* dshippingsdk_fedexship_getoriginaddress2(void* lpObj);
int dshippingsdk_fedexship_setoriginaddress2(void* lpObj, const char* lpszOriginAddress2);

QString GetOriginAddress2();
int SetOriginAddress2(QString qsOriginAddress2);

Default Value

""

Remarks

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

Data Type

String

OriginAddressFlags Property (FedExShip Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOriginAddressFlags();
int SetOriginAddressFlags(int iOriginAddressFlags);

Unicode (Windows)
INT GetOriginAddressFlags();
INT SetOriginAddressFlags(INT iOriginAddressFlags);

int dshippingsdk_fedexship_getoriginaddressflags(void* lpObj);
int dshippingsdk_fedexship_setoriginaddressflags(void* lpObj, int iOriginAddressFlags);

int GetOriginAddressFlags();
int SetOriginAddressFlags(int iOriginAddressFlags);

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

OriginCity Property (FedExShip Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginCity();
int SetOriginCity(const char* lpszOriginCity);

Unicode (Windows)
LPWSTR GetOriginCity();
INT SetOriginCity(LPCWSTR lpszOriginCity);

char* dshippingsdk_fedexship_getorigincity(void* lpObj);
int dshippingsdk_fedexship_setorigincity(void* lpObj, const char* lpszOriginCity);

QString GetOriginCity();
int SetOriginCity(QString qsOriginCity);

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

OriginCountryCode Property (FedExShip Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginCountryCode();
int SetOriginCountryCode(const char* lpszOriginCountryCode);

Unicode (Windows)
LPWSTR GetOriginCountryCode();
INT SetOriginCountryCode(LPCWSTR lpszOriginCountryCode);

char* dshippingsdk_fedexship_getorigincountrycode(void* lpObj);
int dshippingsdk_fedexship_setorigincountrycode(void* lpObj, const char* lpszOriginCountryCode);

QString GetOriginCountryCode();
int SetOriginCountryCode(QString qsOriginCountryCode);

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

OriginState Property (FedExShip Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginState();
int SetOriginState(const char* lpszOriginState);

Unicode (Windows)
LPWSTR GetOriginState();
INT SetOriginState(LPCWSTR lpszOriginState);

char* dshippingsdk_fedexship_getoriginstate(void* lpObj);
int dshippingsdk_fedexship_setoriginstate(void* lpObj, const char* lpszOriginState);

QString GetOriginState();
int SetOriginState(QString qsOriginState);

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

OriginZipCode Property (FedExShip Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginZipCode();
int SetOriginZipCode(const char* lpszOriginZipCode);

Unicode (Windows)
LPWSTR GetOriginZipCode();
INT SetOriginZipCode(LPCWSTR lpszOriginZipCode);

char* dshippingsdk_fedexship_getoriginzipcode(void* lpObj);
int dshippingsdk_fedexship_setoriginzipcode(void* lpObj, const char* lpszOriginZipCode);

QString GetOriginZipCode();
int SetOriginZipCode(QString qsOriginZipCode);

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 OriginCity and OriginState are not present.

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

Data Type

String

OriginCompany Property (FedExShip Class)

Identifies the contact person's company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginCompany();
int SetOriginCompany(const char* lpszOriginCompany);

Unicode (Windows)
LPWSTR GetOriginCompany();
INT SetOriginCompany(LPCWSTR lpszOriginCompany);

char* dshippingsdk_fedexship_getorigincompany(void* lpObj);
int dshippingsdk_fedexship_setorigincompany(void* lpObj, const char* lpszOriginCompany);

QString GetOriginCompany();
int SetOriginCompany(QString qsOriginCompany);

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either OriginFirstName and OriginLastName or OriginCompany are required to be provided.

Data Type

String

OriginEmail Property (FedExShip Class)

Identifies the contact person's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginEmail();
int SetOriginEmail(const char* lpszOriginEmail);

Unicode (Windows)
LPWSTR GetOriginEmail();
INT SetOriginEmail(LPCWSTR lpszOriginEmail);

char* dshippingsdk_fedexship_getoriginemail(void* lpObj);
int dshippingsdk_fedexship_setoriginemail(void* lpObj, const char* lpszOriginEmail);

QString GetOriginEmail();
int SetOriginEmail(QString qsOriginEmail);

Default Value

""

Remarks

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

Data Type

String

OriginFax Property (FedExShip Class)

Recipient's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginFax();
int SetOriginFax(const char* lpszOriginFax);

Unicode (Windows)
LPWSTR GetOriginFax();
INT SetOriginFax(LPCWSTR lpszOriginFax);

char* dshippingsdk_fedexship_getoriginfax(void* lpObj);
int dshippingsdk_fedexship_setoriginfax(void* lpObj, const char* lpszOriginFax);

QString GetOriginFax();
int SetOriginFax(QString qsOriginFax);

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

OriginFirstName Property (FedExShip Class)

Sender's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginFirstName();
int SetOriginFirstName(const char* lpszOriginFirstName);

Unicode (Windows)
LPWSTR GetOriginFirstName();
INT SetOriginFirstName(LPCWSTR lpszOriginFirstName);

char* dshippingsdk_fedexship_getoriginfirstname(void* lpObj);
int dshippingsdk_fedexship_setoriginfirstname(void* lpObj, const char* lpszOriginFirstName);

QString GetOriginFirstName();
int SetOriginFirstName(QString qsOriginFirstName);

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either OriginFirstName and OriginLastName or OriginCompany must be sent.

Data Type

String

OriginLastName Property (FedExShip Class)

Person's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginLastName();
int SetOriginLastName(const char* lpszOriginLastName);

Unicode (Windows)
LPWSTR GetOriginLastName();
INT SetOriginLastName(LPCWSTR lpszOriginLastName);

char* dshippingsdk_fedexship_getoriginlastname(void* lpObj);
int dshippingsdk_fedexship_setoriginlastname(void* lpObj, const char* lpszOriginLastName);

QString GetOriginLastName();
int SetOriginLastName(QString qsOriginLastName);

Default Value

""

Remarks

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

Data Type

String

OriginMiddleInitial Property (FedExShip Class)

Middle initial.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginMiddleInitial();
int SetOriginMiddleInitial(const char* lpszOriginMiddleInitial);

Unicode (Windows)
LPWSTR GetOriginMiddleInitial();
INT SetOriginMiddleInitial(LPCWSTR lpszOriginMiddleInitial);

char* dshippingsdk_fedexship_getoriginmiddleinitial(void* lpObj);
int dshippingsdk_fedexship_setoriginmiddleinitial(void* lpObj, const char* lpszOriginMiddleInitial);

QString GetOriginMiddleInitial();
int SetOriginMiddleInitial(QString qsOriginMiddleInitial);

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

OriginPhone Property (FedExShip Class)

Identifies the contact person's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOriginPhone();
int SetOriginPhone(const char* lpszOriginPhone);

Unicode (Windows)
LPWSTR GetOriginPhone();
INT SetOriginPhone(LPCWSTR lpszOriginPhone);

char* dshippingsdk_fedexship_getoriginphone(void* lpObj);
int dshippingsdk_fedexship_setoriginphone(void* lpObj, const char* lpszOriginPhone);

QString GetOriginPhone();
int SetOriginPhone(QString qsOriginPhone);

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

PackageLocation Property (FedExShip Class)

The location of pickup.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageLocation();
int SetPackageLocation(int iPackageLocation);

Unicode (Windows)
INT GetPackageLocation();
INT SetPackageLocation(INT iPackageLocation);

PL_NONE(0), 
PL_FRONT(1), 
PL_SIDE(2), 
PL_REAR(3)

int dshippingsdk_fedexship_getpackagelocation(void* lpObj);
int dshippingsdk_fedexship_setpackagelocation(void* lpObj, int iPackageLocation);

int GetPackageLocation();
int SetPackageLocation(int iPackageLocation);

Default Value

0

Remarks

This property is optional when calling SchedulePickup. The allowed values to be selected are: None, Front, Side, or Rear.

Data Type

Integer

PackageCount Property (FedExShip Class)

The number of records in the Package arrays.

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_fedexship_getpackagecount(void* lpObj);
int dshippingsdk_fedexship_setpackagecount(void* lpObj, int iPackageCount);

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

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackageBaseCharge
• PackageCODAmount
• PackageCODFile
• PackageCODLabel
• PackageCODType
• PackageDangerousGoodsAccessible
• PackageDangerousGoodsOptions
• PackageDescription
• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageNetCharge
• PackageReference
• PackageShippingLabel
• PackageShippingLabelFile
• PackageSignatureType
• PackageSpecialServices
• PackageTotalDiscount
• PackageTotalSurcharges
• PackageTrackingNumber
• PackageType
• PackageWeight
• PackageWidth

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

This property is not available at design time.

Data Type

Integer

PackageBaseCharge Property (FedExShip Class)

Actual Base Charge applicable to this package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageBaseCharge(int iPackageIdx);

Unicode (Windows)
LPWSTR GetPackageBaseCharge(INT iPackageIdx);

char* dshippingsdk_fedexship_getpackagebasecharge(void* lpObj, int packageidx);

QString GetPackageBaseCharge(int iPackageIdx);

Default Value

""

Remarks

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the properties that store the rating information: PackageBaseCharge, PackageNetCharge, PackageTotalSurcharges, and PackageTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

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

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

Data Type

String

PackageCODAmount Property (FedExShip Class)

The COD monetary value for the package.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedexship_getpackagecodamount(void* lpObj, int packageidx);
int dshippingsdk_fedexship_setpackagecodamount(void* lpObj, int packageidx, const char* lpszPackageCODAmount);

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

Default Value

""

Remarks

The COD monetary value for the package.

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

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

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

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

This property is not applicable to USPS packages.

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

This is not applicable for Canada Post.

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

This property is not available at design time.

Data Type

String

PackageCODFile Property (FedExShip Class)

Filename and location to save the CODLabel of this package to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageCODFile(int iPackageIdx);
int SetPackageCODFile(int iPackageIdx, const char* lpszPackageCODFile);

Unicode (Windows)
LPWSTR GetPackageCODFile(INT iPackageIdx);
INT SetPackageCODFile(INT iPackageIdx, LPCWSTR lpszPackageCODFile);

char* dshippingsdk_fedexship_getpackagecodfile(void* lpObj, int packageidx);
int dshippingsdk_fedexship_setpackagecodfile(void* lpObj, int packageidx, const char* lpszPackageCODFile);

QString GetPackageCODFile(int iPackageIdx);
int SetPackageCODFile(int iPackageIdx, QString qsPackageCODFile);

Default Value

""

Remarks

Filename and location to save the PackageCODLabel of this package to. This is applicable for package(s) that use the COD service.

When the PackageCODFile is set to a valid path and filename, the contents of the PackageCODLabel are written to disk when either the GetPackageLabel or GetShipmentLabels method is called.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then PackageCODFile has to have .pdf extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

This property is only applicable to FedEx shipments.

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

This property is not available at design time.

Data Type

String

PackageCODLabel Property (FedExShip Class)

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCODLabel(int iPackageIdx, char* &lpPackageCODLabel, int &lenPackageCODLabel);

Unicode (Windows)
INT GetPackageCODLabel(INT iPackageIdx, LPSTR &lpPackageCODLabel, INT &lenPackageCODLabel);

int dshippingsdk_fedexship_getpackagecodlabel(void* lpObj, int packageidx, char** lpPackageCODLabel, int* lenPackageCODLabel);

QByteArray GetPackageCODLabel(int iPackageIdx);

Default Value

""

Remarks

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the PackageCODFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a PackageCODLabel return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This property is only applicable to FedEx.

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

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

Data Type

Binary String

PackageCODType Property (FedExShip Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_fedexship_getpackagecodtype(void* lpObj, int packageidx);
int dshippingsdk_fedexship_setpackagecodtype(void* lpObj, int packageidx, int iPackageCODType);

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

Default Value

0

Remarks

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

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

Valid values are:

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

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

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

This property is not available at design time.

Data Type

Integer

PackageDangerousGoodsAccessible Property (FedExShip Class)

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageDangerousGoodsAccessible(int iPackageIdx);
int SetPackageDangerousGoodsAccessible(int iPackageIdx, int bPackageDangerousGoodsAccessible);

Unicode (Windows)
BOOL GetPackageDangerousGoodsAccessible(INT iPackageIdx);
INT SetPackageDangerousGoodsAccessible(INT iPackageIdx, BOOL bPackageDangerousGoodsAccessible);

int dshippingsdk_fedexship_getpackagedangerousgoodsaccessible(void* lpObj, int packageidx);
int dshippingsdk_fedexship_setpackagedangerousgoodsaccessible(void* lpObj, int packageidx, int bPackageDangerousGoodsAccessible);

bool GetPackageDangerousGoodsAccessible(int iPackageIdx);
int SetPackageDangerousGoodsAccessible(int iPackageIdx, bool bPackageDangerousGoodsAccessible);

Default Value

FALSE

Remarks

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

This property is only applicable to FedEx shipments, and is required to be specified when the PackageSpecialServices contains the corresponding flag for Dangerous Goods.

There are two types of dangerous goods:

• Accessible, which may be shipped using: FedEx Priority Overnight, FedEx 1Day Freight, FedEx International Priority, FedEx International Priority Freight. The PackageDangerousGoodsAccessible should be set to True.
• Inaccessible, which may be shipped using: FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Express Saver, FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Priority, FedEx International Priority Freight. The PackageDangerousGoodsAccessible should be set to False.

Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates class by requesting rates for all available services.

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

This property is not available at design time.

Data Type

Boolean

PackageDangerousGoodsOptions Property (FedExShip Class)

Contains the collection of options will be used on the package level when using dangerous goods.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageDangerousGoodsOptions(int iPackageIdx);
int SetPackageDangerousGoodsOptions(int iPackageIdx, int iPackageDangerousGoodsOptions);

Unicode (Windows)
INT GetPackageDangerousGoodsOptions(INT iPackageIdx);
INT SetPackageDangerousGoodsOptions(INT iPackageIdx, INT iPackageDangerousGoodsOptions);

int dshippingsdk_fedexship_getpackagedangerousgoodsoptions(void* lpObj, int packageidx);
int dshippingsdk_fedexship_setpackagedangerousgoodsoptions(void* lpObj, int packageidx, int iPackageDangerousGoodsOptions);

int GetPackageDangerousGoodsOptions(int iPackageIdx);
int SetPackageDangerousGoodsOptions(int iPackageIdx, int iPackageDangerousGoodsOptions);

Default Value

0

Remarks

Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:

Note: This is only valid when using FedEx.

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

This property is not available at design time.

Data Type

Integer

PackageDescription Property (FedExShip Class)

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