FedExTrack Class

Properties   Methods   Events   Config Settings   Errors  

Provides tracking information, SPOD, and notification for a given tracking number or other shipment identifier.

Syntax

FedExTrack

Remarks

This class provides Tracking, Signature Proof of Delivery (SPOD), and Notification services:

• Tracking Service: to obtain real-time tracking information for FedEx Express, FedEx Ground, FedEx Home Delivery, FedEx Express Freight, and FedEx Custom Critical shipments.
• Signature Proof of Delivery (SPOD): to request a proof of delivery letter that includes a graphic image of your recipient's signature after your shipment has been delivered.
• Notification to have FedEx automatically notify you and/or your customer and/or another third party by e-mail, fax, or wireless of significant shipment events, such as clearance delays, delivery attempts, releases, consolidated proofs of delivery, and pre-alerts.

The available options for Tracking service are:

Track by Tracking Number

On Single Piece Shipments, the tracking number represents the package's tracking number. This option applies to Express, Ground, Freight and Custom Critical shipments. You can track any package shipped by FedEx using TrackShipment method by providing this number as the value of idValue parameter. No extra qualifiers (date range, etc.) are required in such case, but are recommended. It is also recommended that you provide the Carrier Code to ensure the desired results for your request. This class handles tracking numbers individually, not in batch.

On Multiple Package Shipments (MPS), the tracking number represents either the master tracking number or one of the associated sequential tracking numbers for child packages. This option is available for: Express and Ground (Domestic and International) multiple-package shipments, Express and Ground (Domestic and International) C.O.D. multiple-package shipments.

Tracking by the master tracking number returns tracking data for all child tracking numbers associated with the master.

Tracking by the child tracking number returns tracking data on the specific shipment associated with that tracking number.

Track by other identifier

This identifier can be a:

• Reference Number This option applies to Express, Ground, Freight, and Custom Critical shipments. You can track packages by a reference number entered during the shipping transaction. Track by Reference Number can use any of the following sources: Shipper/Customer Reference, Invoice Number, Purchase Order (PO), Department, Part Number, Returns Material Authorization (RMA), Transportation Control Number (TCN), Bill of Lading (BOL).
• Door Tag Number This option is available for Express and Ground U.S. and Canadian shipments. This option allows you to track by a FedEx Door Tag number. A Door Tag is left at the recipient's shipping address if the recipient is not there to receive the package. A Door Tag number is linked at FedEx with the package's original tracking number. This tracking functionality allows you to track using only the Door Tag number without requiring the associated tracking number. No additional search elements are required to track by Door Tag. You may request tracking scan information for any packages shipped by FedEx by providing a valid Door Tag Number.

To track by identifiers other than tracking number, the TrackShipment method should be called by providing an idValue and the IdentifierType, as well as other required values described in detail in this method description depending on the identifier type.

When the track request has been made for an identifier of type other than Tracking Number, either the ShipperAccountNumber or the RecipientCountryCode and RecipientZipCode (where applicable) are required to be provided in the request.

Upon successful request, the user will receive the current shipment status with a detailed tracking activity.

To confirm a shipment has been received and signed for, you can call the GetProofOfDelivery or SaveProofOfDelivery methods. With this feature, you can request a letter that includes a graphic of the recipient's signature for FedEx Express and FedEx Ground shipments. The SPOD is returned in PDF format and may be printed, browsed, or e-mailed. There is no charge for Signature Proof of Delivery.

You can use Tracking service to check the status of your shipment at any time during delivery and up to 18 months after delivery. You can use SPOD service to obtain an image of the recipient's signature (if the signature is available) once the shipment has been delivered.

SPOD is available for FedEx Express and FedEx Ground shipments, that were delivered to destinations worldwide (where available), up to 18 months from the ship date. This includes the signature image and associated shipment data.

If the ShipperAccountNumber is not provided in the SPOD request, the SPOD letter that you will obtain will contain summary information only. The letter will show only the city, state/province, and country information for the shipper and recipient.

If the ShipperAccountNumber is provided in the SPOD request, and if this account number matches the shipper or payer of the shipment, the SPOD letter will contain detailed SPOD information, and you will be able to view complete contact name, company name, street address, city, state/province, postal code, and country information for both the shipper and recipient (if available).

In the scenarios above, the signature image and additional recipient information may not be available for display in all countries and will be indicated on the SPOD where applicable.

Signatures can take up to five days to process. Even if no signature is available, you can receive the available proof of delivery information. You can also check again later for the signature. If no signature is available after seven business days, call 1.800.GoFedEx. Note that the signature may be unavailable if it was released (the sender or recipient signed a signature release agreement).

SPOD requests cannot be batch processed. If you need multiple SPOD documents, you must create multiple request transactions.

To use this class, you must have a FedEx FedExAccountNumber. You should also have already obtained a FedExDeveloperKey, FedExPassword and a FedExMeterNumber uniquely assigned to your account by FedEx after registration for Web Services.

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.

CarrierCodeDescription Property (FedExTrack Class)

FedEx carrier code description used for shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetCarrierCodeDescription();

Unicode (Windows)
LPWSTR GetCarrierCodeDescription();

char* dshippingsdk_fedextrack_getcarriercodedescription(void* lpObj);

QString GetCarrierCodeDescription();

Default Value

""

Remarks

Specifies the particular carrier used to ship the packages being tracked.

Upon successful request, this is always returned when the TrackShipment and RequestEmailNotification methods are called.

This property is read-only.

Data Type

String

EstimatedPickupDate Property (FedExTrack Class)

Estimated package pickup date for shipments that haven't been picked up yet.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEstimatedPickupDate();

Unicode (Windows)
LPWSTR GetEstimatedPickupDate();

char* dshippingsdk_fedextrack_getestimatedpickupdate(void* lpObj);

QString GetEstimatedPickupDate();

Default Value

""

Remarks

This property is returned in the server response only if applicable.

Format: YYYY-MM-DD.

This property is read-only.

Data Type

String

FedExAccountNumber Property (FedExTrack 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_fedextrack_getfedexaccountnumber(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexauthorizationtoken(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexcspproductid(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexcspproductversion(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexcspuserkey(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexcspuserpassword(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexdeveloperkey(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexlanguagecode(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexlocalecode(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexmeternumber(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexpassword(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfedexserver(void* lpObj);
int dshippingsdk_fedextrack_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 is required to be provided on each transaction request sent to FedEx along with FedExAccountNumber and FedExMeterNumber.

The full URL (including the URL scheme normally https://) should be supplied. All test requests are sent over SSL.

The server URL for the production will be provided to you by FedEx after your application has been approved/certified by FedEx Web Integration Solutions team.

Data Type

String

FirewallAutoDetect Property (FedExTrack 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_fedextrack_getfirewallautodetect(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfirewalltype(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfirewallhost(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfirewallpassword(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfirewallport(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getfirewalluser(void* lpObj);
int dshippingsdk_fedextrack_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

IdentifierType Property (FedExTrack Class)

Type of shipment identifier by which the shipment is to be tracked.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetIdentifierType();
int SetIdentifierType(int iIdentifierType);

Unicode (Windows)
INT GetIdentifierType();
INT SetIdentifierType(INT iIdentifierType);

FIT_TRACKING_NUMBER_OR_DOOR_TAG(0), 
FIT_BILL_OF_LADING(1), 
FIT_CODRETURN_TRACKING_NUMBER(2), 
FIT_CUSTOMER_AUTHORIZATION_NUMBER(3), 
FIT_CUSTOMER_REFERENCE(4), 
FIT_DEPARTMENT(5), 
FIT_FREE_FORM_REFERENCE(6), 
FIT_GROUND_SHIPMENT_ID(7), 
FIT_GROUND_MPS(8), 
FIT_INVOICE_NUMBER(9), 
FIT_PARTNER_CARRIER_NUMBER(10), 
FIT_PART_NUMBER(11), 
FIT_PONUMBER(12), 
FIT_RMANUMBER(13), 
FIT_TRACKING_CONTROL_NUMBER(14), 
FIT_SHIPPER_REFERENCE(15), 
FIT_STANDARD_MPS(16)

int dshippingsdk_fedextrack_getidentifiertype(void* lpObj);
int dshippingsdk_fedextrack_setidentifiertype(void* lpObj, int iIdentifierType);

int GetIdentifierType();
int SetIdentifierType(int iIdentifierType);

Default Value

0

Remarks

This is required if the track request will be made for an identifier other than Tracking Number.

Possible values are as follows:

To limit the number of tracking replies for a specific reference, you can enter a date range (ShipDateStart and ShipDateEnd) for this search.

When the track request has been made for an identifier of type other than Tracking Number, either the ShipperAccountNumber or the RecipientCountryCode and RecipientZipCode (where applicable) are required to be provided in the request.

Data Type

Integer

NotifyCount Property (FedExTrack 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_fedextrack_getnotifycount(void* lpObj);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getnotifyaggregate(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getnotifyemail(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getnotifymessage(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getnotifyname(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getnotifyflags(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_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 (FedExTrack 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_fedextrack_getnotifytype(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_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

PackageCount Property (FedExTrack Class)

The number of packages returned for a given tracking number or any other shipment identifier.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageCount();

Unicode (Windows)
INT GetPackageCount();

int dshippingsdk_fedextrack_getpackagecount(void* lpObj);

int GetPackageCount();

Default Value

1

Remarks

This property contains the number of packages returned from the FedEx Server after calling the TrackShipment.

This property is read-only.

Data Type

Integer

PackageDeliveryDate Property (FedExTrack Class)

Actual date when the package at PackageIndex was delivered at destination (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDeliveryDate();

Unicode (Windows)
LPWSTR GetPackageDeliveryDate();

char* dshippingsdk_fedextrack_getpackagedeliverydate(void* lpObj);

QString GetPackageDeliveryDate();

Default Value

""

Remarks

When the TrackShipment method is called, PackageDeliveryDate is returned in the response only if the package has been delivered.

Format: YYYY-MM-DD.

This property is read-only.

Data Type

String

PackageDeliveryEstimate Property (FedExTrack Class)

Projected delivery date for the package at PackageIndex based on the ship date, service and destination address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDeliveryEstimate();

Unicode (Windows)
LPWSTR GetPackageDeliveryEstimate();

char* dshippingsdk_fedextrack_getpackagedeliveryestimate(void* lpObj);

QString GetPackageDeliveryEstimate();

Default Value

""

Remarks

When the TrackShipment method is called, the PackageDeliveryEstimate is populated only if delivery has not already occurred.

Format: YYYY-MM-DD.

This property is read-only.

Data Type

String

PackageDeliveryLocation Property (FedExTrack Class)

Relative location at which package at PackageIndex was left (if package delivered).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDeliveryLocation();

Unicode (Windows)
LPWSTR GetPackageDeliveryLocation();

char* dshippingsdk_fedextrack_getpackagedeliverylocation(void* lpObj);

QString GetPackageDeliveryLocation();

Default Value

""

Remarks

When the TrackShipment method is called, PackageDeliveryLocation is returned in the response only if this package has been delivered.

This might be such as Front Desk, Back Door, etc. It is applicable for Express services only.

This property is read-only.

Data Type

String

PackageDeliveryStatus Property (FedExTrack Class)

Delivery status description of the package at PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDeliveryStatus();

Unicode (Windows)
LPWSTR GetPackageDeliveryStatus();

char* dshippingsdk_fedextrack_getpackagedeliverystatus(void* lpObj);

QString GetPackageDeliveryStatus();

Default Value

""

Remarks

This is applicable for Express services only. Maximum length: 25.

This property is read-only.

Data Type

String

PackageIndex Property (FedExTrack Class)

The package index in a shipment being tracked.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackageIndex();
int SetPackageIndex(int iPackageIndex);

Unicode (Windows)
INT GetPackageIndex();
INT SetPackageIndex(INT iPackageIndex);

int dshippingsdk_fedextrack_getpackageindex(void* lpObj);
int dshippingsdk_fedextrack_setpackageindex(void* lpObj, int iPackageIndex);

int GetPackageIndex();
int SetPackageIndex(int iPackageIndex);

Default Value

0

Remarks

This property contains the index of a package contained in the shipment.

The PackageCount will contain the number of packages included in a shipment and the PackageIndex will contain the package index in the list of packages.

To retrieve all attributes corresponding to a package, the PackageIndex should be set from 0 to PackageCount - 1.

Data Type

Integer

PackagePackagingType Property (FedExTrack Class)

Description of packaging type of the package at PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackagePackagingType();

Unicode (Windows)
LPWSTR GetPackagePackagingType();

char* dshippingsdk_fedextrack_getpackagepackagingtype(void* lpObj);

QString GetPackagePackagingType();

Default Value

""

Remarks

This is returned for Express services only. Possible values are: 'FedEx Envelope', 'FedEx Box', etc.

This property is read-only.

Data Type

String

PackageReceivedBy Property (FedExTrack Class)

The name of the person who received the package at delivery (if applicable) corresponding to the PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageReceivedBy();

Unicode (Windows)
LPWSTR GetPackageReceivedBy();

char* dshippingsdk_fedextrack_getpackagereceivedby(void* lpObj);

QString GetPackageReceivedBy();

Default Value

""

Remarks

This corresponds to the package at PackageIndex and is returned only if this package has already been delivered. To retrieve this property, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Data Type

String

PackageReferences Property (FedExTrack Class)

References (other than tracking number) assigned to the package at PackageIndex by either shipper or customer.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageReferences();

Unicode (Windows)
LPWSTR GetPackageReferences();

char* dshippingsdk_fedextrack_getpackagereferences(void* lpObj);

QString GetPackageReferences();

Default Value

""

Remarks

This should be inspected after a call to the TrackShipment method. When populated, it is a string in this format: "Reference Type: Reference Value" pairs (separated by ';' if more than one reference is found).

Reference Type can be any of the following values:

This property is read-only.

Data Type

String

PackageServiceTypeDescription Property (FedExTrack Class)

String describing the service type used to ship the package at PackageIndex being tracked.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageServiceTypeDescription();

Unicode (Windows)
LPWSTR GetPackageServiceTypeDescription();

char* dshippingsdk_fedextrack_getpackageservicetypedescription(void* lpObj);

QString GetPackageServiceTypeDescription();

Default Value

""

Remarks

This might be one of FedEx available services, such as 'Priority Pack', 'Standard Overnight', etc.

This property is read-only.

Data Type

String

PackageSignedBy Property (FedExTrack Class)

Signature of person who signed for package at PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageSignedBy();

Unicode (Windows)
LPWSTR GetPackageSignedBy();

char* dshippingsdk_fedextrack_getpackagesignedby(void* lpObj);

QString GetPackageSignedBy();

Default Value

""

Remarks

This corresponds to the package at PackageIndex and is returned only if this package has already been delivered. If the signature confirmation is not selected when the shipping label was generated, the PackageSignedBy might also be a relative location at which package was left, such as Front Desk or Back Door.

This property is read-only.

Data Type

String

PackageTrackingNumber Property (FedExTrack Class)

Tracking number for the package at PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageTrackingNumber();

Unicode (Windows)
LPWSTR GetPackageTrackingNumber();

char* dshippingsdk_fedextrack_getpackagetrackingnumber(void* lpObj);

QString GetPackageTrackingNumber();

Default Value

""

Remarks

This indicates tracking number assigned by FedEx when the shipping label was generated. Maximum length: 20.

Note: Door Tag will never be returned in the response.

This property is read-only.

Data Type

String

PackageWeight Property (FedExTrack Class)

Weight of the package at PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageWeight();

Unicode (Windows)
LPWSTR GetPackageWeight();

char* dshippingsdk_fedextrack_getpackageweight(void* lpObj);

QString GetPackageWeight();

Default Value

""

Remarks

This corresponds to the package at PackageIndex position in the list of packages contained in the shipment.

This property is read-only.

Data Type

String

ProxyAuthScheme Property (FedExTrack Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_fedextrack_getproxyauthscheme(void* lpObj);
int dshippingsdk_fedextrack_setproxyauthscheme(void* lpObj, int iProxyAuthScheme);

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

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (FedExTrack Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_fedextrack_getproxyautodetect(void* lpObj);
int dshippingsdk_fedextrack_setproxyautodetect(void* lpObj, int bProxyAutoDetect);

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

Default Value

FALSE

Remarks

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

Data Type

Boolean

ProxyPassword Property (FedExTrack Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getproxypassword(void* lpObj);
int dshippingsdk_fedextrack_setproxypassword(void* lpObj, const char* lpszProxyPassword);

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

Default Value

""

Remarks

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

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (FedExTrack Class)

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

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_fedextrack_getproxyport(void* lpObj);
int dshippingsdk_fedextrack_setproxyport(void* lpObj, int iProxyPort);

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

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (FedExTrack Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getproxyserver(void* lpObj);
int dshippingsdk_fedextrack_setproxyserver(void* lpObj, const char* lpszProxyServer);

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

Default Value

""

Remarks

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

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (FedExTrack Class)

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

Syntax

• C++
• C
• Qt

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

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

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

int dshippingsdk_fedextrack_getproxyssl(void* lpObj);
int dshippingsdk_fedextrack_setproxyssl(void* lpObj, int iProxySSL);

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

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (FedExTrack Class)

This property contains a user name, if authentication is to be used for the proxy.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getproxyuser(void* lpObj);
int dshippingsdk_fedextrack_setproxyuser(void* lpObj, const char* lpszProxyUser);

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

Default Value

""

Remarks

This property contains a user name, if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

RecipientAddress1 Property (FedExTrack Class)

Street name.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getrecipientaddress1(void* lpObj);
int dshippingsdk_fedextrack_setrecipientaddress1(void* lpObj, const char* lpszRecipientAddress1);

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

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS RecipientAddress1 should not exceed 35 characters.

Data Type

String

RecipientAddress2 Property (FedExTrack Class)

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

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getrecipientaddress2(void* lpObj);
int dshippingsdk_fedextrack_setrecipientaddress2(void* lpObj, const char* lpszRecipientAddress2);

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

Default Value

""

Remarks

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

Data Type

String

RecipientAddressFlags Property (FedExTrack Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

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

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

int dshippingsdk_fedextrack_getrecipientaddressflags(void* lpObj);
int dshippingsdk_fedextrack_setrecipientaddressflags(void* lpObj, int iRecipientAddressFlags);

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

Default Value

0

Remarks

Various flags that denote information about the address.

Data Type

Integer

RecipientCity Property (FedExTrack Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getrecipientcity(void* lpObj);
int dshippingsdk_fedextrack_setrecipientcity(void* lpObj, const char* lpszRecipientCity);

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

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

Data Type

String

RecipientCountryCode Property (FedExTrack Class)

Country code.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getrecipientcountrycode(void* lpObj);
int dshippingsdk_fedextrack_setrecipientcountrycode(void* lpObj, const char* lpszRecipientCountryCode);

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

Default Value

"US"

Remarks

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered. Note that with USPS you can also specify the full country name here.

* Not supported by USPS

** Has multiple values, the values used for USPS are below

Data Type

String

RecipientState Property (FedExTrack Class)

State or province code.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getrecipientstate(void* lpObj);
int dshippingsdk_fedextrack_setrecipientstate(void* lpObj, const char* lpszRecipientState);

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

Default Value

""

Remarks

State or province code. This is the identifying abbreviation for US state, Canada province, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

Data Type

String

RecipientZipCode Property (FedExTrack Class)

Postal code.

Syntax

• C++
• C
• Qt

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

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

char* dshippingsdk_fedextrack_getrecipientzipcode(void* lpObj);
int dshippingsdk_fedextrack_setrecipientzipcode(void* lpObj, const char* lpszRecipientZipCode);

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

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both RecipientCity and RecipientState are not present.

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

Data Type

String

SenderAddress1 Property (FedExTrack Class)

Street name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderAddress1();

Unicode (Windows)
LPWSTR GetSenderAddress1();

char* dshippingsdk_fedextrack_getsenderaddress1(void* lpObj);

QString GetSenderAddress1();

Default Value

""

Remarks

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address. For UPS SenderAddress1 should not exceed 35 characters.

This property is read-only.

Data Type

String

SenderAddress2 Property (FedExTrack Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderAddress2();

Unicode (Windows)
LPWSTR GetSenderAddress2();

char* dshippingsdk_fedextrack_getsenderaddress2(void* lpObj);

QString GetSenderAddress2();

Default Value

""

Remarks

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

This property is read-only.

Data Type

String

SenderAddressFlags Property (FedExTrack Class)

Various flags that denote information about the address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSenderAddressFlags();

Unicode (Windows)
INT GetSenderAddressFlags();

int dshippingsdk_fedextrack_getsenderaddressflags(void* lpObj);

int GetSenderAddressFlags();

Default Value

0

Remarks

Various flags that denote information about the address.

This property is read-only.

Data Type

Integer

SenderCity Property (FedExTrack Class)

Name of city, town, etc.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderCity();

Unicode (Windows)
LPWSTR GetSenderCity();

char* dshippingsdk_fedextrack_getsendercity(void* lpObj);

QString GetSenderCity();

Default Value

""

Remarks

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

This property is read-only.

Data Type

String

SenderCountryCode Property (FedExTrack Class)

Country code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderCountryCode();

Unicode (Windows)
LPWSTR GetSenderCountryCode();

char* dshippingsdk_fedextrack_getsendercountrycode(void* lpObj);

QString GetSenderCountryCode();

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

This property is read-only.

Data Type

String

SenderState Property (FedExTrack Class)

State or province code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderState();

Unicode (Windows)
LPWSTR GetSenderState();

char* dshippingsdk_fedextrack_getsenderstate(void* lpObj);

QString GetSenderState();

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.

This property is read-only.

Data Type

String

SenderZipCode Property (FedExTrack Class)

Postal code.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderZipCode();

Unicode (Windows)
LPWSTR GetSenderZipCode();

char* dshippingsdk_fedextrack_getsenderzipcode(void* lpObj);

QString GetSenderZipCode();

Default Value

""

Remarks

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both SenderCity and SenderState are not present.

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

This property is read-only.

Data Type

String

SenderCompany Property (FedExTrack Class)

Identifies the contact person's company name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderCompany();
int SetSenderCompany(const char* lpszSenderCompany);

Unicode (Windows)
LPWSTR GetSenderCompany();
INT SetSenderCompany(LPCWSTR lpszSenderCompany);

char* dshippingsdk_fedextrack_getsendercompany(void* lpObj);
int dshippingsdk_fedextrack_setsendercompany(void* lpObj, const char* lpszSenderCompany);

QString GetSenderCompany();
int SetSenderCompany(QString qsSenderCompany);

Default Value

""

Remarks

Identifies the contact person's company name. In a ship request, either SenderFirstName and SenderLastName or SenderCompany are required to be provided.

Data Type

String

SenderEmail Property (FedExTrack Class)

Identifies the contact person's email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderEmail();
int SetSenderEmail(const char* lpszSenderEmail);

Unicode (Windows)
LPWSTR GetSenderEmail();
INT SetSenderEmail(LPCWSTR lpszSenderEmail);

char* dshippingsdk_fedextrack_getsenderemail(void* lpObj);
int dshippingsdk_fedextrack_setsenderemail(void* lpObj, const char* lpszSenderEmail);

QString GetSenderEmail();
int SetSenderEmail(QString qsSenderEmail);

Default Value

""

Remarks

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

Data Type

String

SenderFax Property (FedExTrack Class)

Recipient's fax number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderFax();
int SetSenderFax(const char* lpszSenderFax);

Unicode (Windows)
LPWSTR GetSenderFax();
INT SetSenderFax(LPCWSTR lpszSenderFax);

char* dshippingsdk_fedextrack_getsenderfax(void* lpObj);
int dshippingsdk_fedextrack_setsenderfax(void* lpObj, const char* lpszSenderFax);

QString GetSenderFax();
int SetSenderFax(QString qsSenderFax);

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

SenderFirstName Property (FedExTrack Class)

Sender's first name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderFirstName();
int SetSenderFirstName(const char* lpszSenderFirstName);

Unicode (Windows)
LPWSTR GetSenderFirstName();
INT SetSenderFirstName(LPCWSTR lpszSenderFirstName);

char* dshippingsdk_fedextrack_getsenderfirstname(void* lpObj);
int dshippingsdk_fedextrack_setsenderfirstname(void* lpObj, const char* lpszSenderFirstName);

QString GetSenderFirstName();
int SetSenderFirstName(QString qsSenderFirstName);

Default Value

""

Remarks

Sender's first name. The value of this property is required. Values for either SenderFirstName and SenderLastName or SenderCompany must be sent.

Data Type

String

SenderLastName Property (FedExTrack Class)

Person's last name.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderLastName();
int SetSenderLastName(const char* lpszSenderLastName);

Unicode (Windows)
LPWSTR GetSenderLastName();
INT SetSenderLastName(LPCWSTR lpszSenderLastName);

char* dshippingsdk_fedextrack_getsenderlastname(void* lpObj);
int dshippingsdk_fedextrack_setsenderlastname(void* lpObj, const char* lpszSenderLastName);

QString GetSenderLastName();
int SetSenderLastName(QString qsSenderLastName);

Default Value

""

Remarks

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

Data Type

String

SenderMiddleInitial Property (FedExTrack Class)

Middle initial.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderMiddleInitial();
int SetSenderMiddleInitial(const char* lpszSenderMiddleInitial);

Unicode (Windows)
LPWSTR GetSenderMiddleInitial();
INT SetSenderMiddleInitial(LPCWSTR lpszSenderMiddleInitial);

char* dshippingsdk_fedextrack_getsendermiddleinitial(void* lpObj);
int dshippingsdk_fedextrack_setsendermiddleinitial(void* lpObj, const char* lpszSenderMiddleInitial);

QString GetSenderMiddleInitial();
int SetSenderMiddleInitial(QString qsSenderMiddleInitial);

Default Value

""

Remarks

Middle initial. The value of this property is optional.

Data Type

String

SenderPhone Property (FedExTrack Class)

Identifies the contact person's phone number.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSenderPhone();
int SetSenderPhone(const char* lpszSenderPhone);

Unicode (Windows)
LPWSTR GetSenderPhone();
INT SetSenderPhone(LPCWSTR lpszSenderPhone);

char* dshippingsdk_fedextrack_getsenderphone(void* lpObj);
int dshippingsdk_fedextrack_setsenderphone(void* lpObj, const char* lpszSenderPhone);

QString GetSenderPhone();
int SetSenderPhone(QString qsSenderPhone);

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

ShipDate Property (FedExTrack Class)

The date on which the package was tendered to FedEx.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipDate();
int SetShipDate(const char* lpszShipDate);

Unicode (Windows)
LPWSTR GetShipDate();
INT SetShipDate(LPCWSTR lpszShipDate);

char* dshippingsdk_fedextrack_getshipdate(void* lpObj);
int dshippingsdk_fedextrack_setshipdate(void* lpObj, const char* lpszShipDate);

QString GetShipDate();
int SetShipDate(QString qsShipDate);

Default Value

""

Remarks

Upon successful request, this is always returned when the TrackShipment and RequestEmailNotification methods are called.

Format: YYYY-MM-DD.

Data Type

String

ShipDateEnd Property (FedExTrack Class)

End of ship date range used to narrow search.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipDateEnd();
int SetShipDateEnd(const char* lpszShipDateEnd);

Unicode (Windows)
LPWSTR GetShipDateEnd();
INT SetShipDateEnd(LPCWSTR lpszShipDateEnd);

char* dshippingsdk_fedextrack_getshipdateend(void* lpObj);
int dshippingsdk_fedextrack_setshipdateend(void* lpObj, const char* lpszShipDateEnd);

QString GetShipDateEnd();
int SetShipDateEnd(QString qsShipDateEnd);

Default Value

""

Remarks

This property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateStart is required.

This is required though to be provided in an email notification request (when the RequestEmailNotification method is called).

Format: YYYY-MM-DD.

Data Type

String

ShipDateStart Property (FedExTrack Class)

Start of ship date range used to narrow search.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipDateStart();
int SetShipDateStart(const char* lpszShipDateStart);

Unicode (Windows)
LPWSTR GetShipDateStart();
INT SetShipDateStart(LPCWSTR lpszShipDateStart);

char* dshippingsdk_fedextrack_getshipdatestart(void* lpObj);
int dshippingsdk_fedextrack_setshipdatestart(void* lpObj, const char* lpszShipDateStart);

QString GetShipDateStart();
int SetShipDateStart(QString qsShipDateStart);

Default Value

""

Remarks

This property value is optional to be entered in a track request (when the TrackShipment is called), but recommended as limits the results to this range. If not provided, results may vary. In this case, FedEx will default to a range that may not be useful for the search. If provided, ShipDateEnd is required.

This is required though to be provided in a email notification request (when the RequestEmailNotification method is called).

Format: YYYY-MM-DD.

Data Type

String

ShipperAccountNumber Property (FedExTrack Class)

Account number associated with shipment.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetShipperAccountNumber();
int SetShipperAccountNumber(const char* lpszShipperAccountNumber);

Unicode (Windows)
LPWSTR GetShipperAccountNumber();
INT SetShipperAccountNumber(LPCWSTR lpszShipperAccountNumber);

char* dshippingsdk_fedextrack_getshipperaccountnumber(void* lpObj);
int dshippingsdk_fedextrack_setshipperaccountnumber(void* lpObj, const char* lpszShipperAccountNumber);

QString GetShipperAccountNumber();
int SetShipperAccountNumber(QString qsShipperAccountNumber);

Default Value

""

Remarks

This indicates the account number associated with shipment (as opposed to the FedExAccountNumber, which is that of the party sending the request).

This property is optional and applicable in 2 types of track services:

• Tracking request made for an identifier of IdentifierType other than Tracking Number; or
• Signature Proof of Delivery (SPOD) request;

In tracking request: When providing the ShipperAccountNumber, the server will return all packages matching the search criteria and associated with this account. If account is not specified, then the RecipientCountryCode and RecipientZipCode (applicable countries) are required. The Reply data may be restricted if ShipperAccountNumber is not provided.

In the SPOD request transaction: To view detailed SPOD information, include the 9-digit ShipperAccountNumber when the GetProofOfDelivery or SaveProofOfDelivery methods are called. If this is not provided, or if it does not match the shipper's or payor's FedEx account number, then summary SPOD information will be provided. Otherwise, the detailed SPOD (sender's and recipient's address details) will be included in the SPOD.

Data Type

String

SSLAcceptServerCertEncoded Property (FedExTrack Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLAcceptServerCertEncoded(char* &lpSSLAcceptServerCertEncoded, int &lenSSLAcceptServerCertEncoded);
int SetSSLAcceptServerCertEncoded(const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

Unicode (Windows)
INT GetSSLAcceptServerCertEncoded(LPSTR &lpSSLAcceptServerCertEncoded, INT &lenSSLAcceptServerCertEncoded);
INT SetSSLAcceptServerCertEncoded(LPCSTR lpSSLAcceptServerCertEncoded, INT lenSSLAcceptServerCertEncoded);

int dshippingsdk_fedextrack_getsslacceptservercertencoded(void* lpObj, char** lpSSLAcceptServerCertEncoded, int* lenSSLAcceptServerCertEncoded);
int dshippingsdk_fedextrack_setsslacceptservercertencoded(void* lpObj, const char* lpSSLAcceptServerCertEncoded, int lenSSLAcceptServerCertEncoded);

QByteArray GetSSLAcceptServerCertEncoded();
int SetSSLAcceptServerCertEncoded(QByteArray qbaSSLAcceptServerCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (FedExTrack Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertEncoded(char* &lpSSLCertEncoded, int &lenSSLCertEncoded);
int SetSSLCertEncoded(const char* lpSSLCertEncoded, int lenSSLCertEncoded);

Unicode (Windows)
INT GetSSLCertEncoded(LPSTR &lpSSLCertEncoded, INT &lenSSLCertEncoded);
INT SetSSLCertEncoded(LPCSTR lpSSLCertEncoded, INT lenSSLCertEncoded);

int dshippingsdk_fedextrack_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int dshippingsdk_fedextrack_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (FedExTrack Class)

This is the name of the certificate store for the client certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStore(char* &lpSSLCertStore, int &lenSSLCertStore);
int SetSSLCertStore(const char* lpSSLCertStore, int lenSSLCertStore);

Unicode (Windows)
INT GetSSLCertStore(LPSTR &lpSSLCertStore, INT &lenSSLCertStore);
INT SetSSLCertStore(LPCSTR lpSSLCertStore, INT lenSSLCertStore);

int dshippingsdk_fedextrack_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int dshippingsdk_fedextrack_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (FedExTrack Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertStorePassword();
int SetSSLCertStorePassword(const char* lpszSSLCertStorePassword);

Unicode (Windows)
LPWSTR GetSSLCertStorePassword();
INT SetSSLCertStorePassword(LPCWSTR lpszSSLCertStorePassword);

char* dshippingsdk_fedextrack_getsslcertstorepassword(void* lpObj);
int dshippingsdk_fedextrack_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (FedExTrack Class)

This is the type of certificate store for this certificate.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Unicode (Windows)
INT GetSSLCertStoreType();
INT SetSSLCertStoreType(INT iSSLCertStoreType);

CST_USER(0), 
CST_MACHINE(1), 
CST_PFXFILE(2), 
CST_PFXBLOB(3), 
CST_JKSFILE(4), 
CST_JKSBLOB(5), 
CST_PEMKEY_FILE(6), 
CST_PEMKEY_BLOB(7), 
CST_PUBLIC_KEY_FILE(8), 
CST_PUBLIC_KEY_BLOB(9), 
CST_SSHPUBLIC_KEY_BLOB(10), 
CST_P7BFILE(11), 
CST_P7BBLOB(12), 
CST_SSHPUBLIC_KEY_FILE(13), 
CST_PPKFILE(14), 
CST_PPKBLOB(15), 
CST_XMLFILE(16), 
CST_XMLBLOB(17), 
CST_JWKFILE(18), 
CST_JWKBLOB(19), 
CST_SECURITY_KEY(20), 
CST_BCFKSFILE(21), 
CST_BCFKSBLOB(22), 
CST_PKCS11(23), 
CST_AUTO(99)

int dshippingsdk_fedextrack_getsslcertstoretype(void* lpObj);
int dshippingsdk_fedextrack_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (FedExTrack Class)

This is the subject of the certificate used for client authentication.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetSSLCertSubject();
int SetSSLCertSubject(const char* lpszSSLCertSubject);

Unicode (Windows)
LPWSTR GetSSLCertSubject();
INT SetSSLCertSubject(LPCWSTR lpszSSLCertSubject);

char* dshippingsdk_fedextrack_getsslcertsubject(void* lpObj);
int dshippingsdk_fedextrack_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are displayed below.

If a field value contains a comma it must be quoted.

Data Type

String

SSLProvider Property (FedExTrack Class)

This specifies the SSL/TLS implementation to use.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Unicode (Windows)
INT GetSSLProvider();
INT SetSSLProvider(INT iSSLProvider);

SSLP_AUTOMATIC(0), 
SSLP_PLATFORM(1), 
SSLP_INTERNAL(2)

int dshippingsdk_fedextrack_getsslprovider(void* lpObj);
int dshippingsdk_fedextrack_setsslprovider(void* lpObj, int iSSLProvider);

int GetSSLProvider();
int SetSSLProvider(int iSSLProvider);

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (FedExTrack Class)

This is the certificate (PEM/base64 encoded).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetSSLServerCertEncoded(char* &lpSSLServerCertEncoded, int &lenSSLServerCertEncoded);

Unicode (Windows)
INT GetSSLServerCertEncoded(LPSTR &lpSSLServerCertEncoded, INT &lenSSLServerCertEncoded);

int dshippingsdk_fedextrack_getsslservercertencoded(void* lpObj, char** lpSSLServerCertEncoded, int* lenSSLServerCertEncoded);

QByteArray GetSSLServerCertEncoded();

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

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

Data Type

Binary String

Timeout Property (FedExTrack Class)

A timeout for the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTimeout();
int SetTimeout(int iTimeout);

Unicode (Windows)
INT GetTimeout();
INT SetTimeout(INT iTimeout);

int dshippingsdk_fedextrack_gettimeout(void* lpObj);
int dshippingsdk_fedextrack_settimeout(void* lpObj, int iTimeout);

int GetTimeout();
int SetTimeout(int iTimeout);

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TotalWeight Property (FedExTrack Class)

Total shipment weight.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTotalWeight();

Unicode (Windows)
LPWSTR GetTotalWeight();

char* dshippingsdk_fedextrack_gettotalweight(void* lpObj);

QString GetTotalWeight();

Default Value

""

Remarks

This property is returned when the TrackShipment method is called.

This property is read-only.

Data Type

String

TrackEventCount Property (FedExTrack Class)

The number of records in the TrackEvent arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetTrackEventCount();

Unicode (Windows)
INT GetTrackEventCount();

int dshippingsdk_fedextrack_gettrackeventcount(void* lpObj);

int GetTrackEventCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrackEventAddress1
• TrackEventAddress2
• TrackEventCity
• TrackEventCountryCode
• TrackEventDate
• TrackEventException
• TrackEventState
• TrackEventStatus
• TrackEventTime
• TrackEventZipCode

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

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

Data Type

Integer

TrackEventAddress1 Property (FedExTrack Class)

Line 1 in the location address where a tracking event occurred (by package).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventAddress1(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventAddress1(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventaddress1(void* lpObj, int trackeventidx);

QString GetTrackEventAddress1(int iTrackEventIdx);

Default Value

""

Remarks

Line 1 in the location address where a tracking event occurred (by package). This contains street prefix, street name, street type.

This is not available for USPS tracking requests.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventAddress2 Property (FedExTrack Class)

Line 2 in the location address where a tracking event occurred (by package).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventAddress2(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventAddress2(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventaddress2(void* lpObj, int trackeventidx);

QString GetTrackEventAddress2(int iTrackEventIdx);

Default Value

""

Remarks

Line 2 in the location address where a tracking event occurred (by package). This contains building, floor, room, suite and PO Box Number.

This is not available for USPS tracking requests.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventCity Property (FedExTrack Class)

Name of the city where the tracking event occurred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventCity(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventCity(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventcity(void* lpObj, int trackeventidx);

QString GetTrackEventCity(int iTrackEventIdx);

Default Value

""

Remarks

Name of the city where the tracking event occurred. This is returned in the server reply for each tracking event.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventCountryCode Property (FedExTrack Class)

Country code where the tracking event happened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventCountryCode(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventCountryCode(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventcountrycode(void* lpObj, int trackeventidx);

QString GetTrackEventCountryCode(int iTrackEventIdx);

Default Value

""

Remarks

Country code where the tracking event happened.

For FedEx, this is returned if the country, where the scanning activity happened, is US or CA (for Canada).

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventDate Property (FedExTrack Class)

Date the tracking event happened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventDate(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventDate(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventdate(void* lpObj, int trackeventidx);

QString GetTrackEventDate(int iTrackEventIdx);

Default Value

""

Remarks

Date the tracking event happened.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventException Property (FedExTrack Class)

The most recent status exception for the tracking event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventException(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventException(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventexception(void* lpObj, int trackeventidx);

QString GetTrackEventException(int iTrackEventIdx);

Default Value

""

Remarks

The most recent status exception for the tracking event. This is only available for FedEx, and is applicable for Express services only.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventState Property (FedExTrack Class)

State or province code where the tracking event occurred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventState(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventState(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventstate(void* lpObj, int trackeventidx);

QString GetTrackEventState(int iTrackEventIdx);

Default Value

""

Remarks

State or province code where the tracking event occurred. This is a two-letter standard abbreviation.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventStatus Property (FedExTrack Class)

Literal description of the tracking event.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventStatus(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventStatus(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventstatus(void* lpObj, int trackeventidx);

QString GetTrackEventStatus(int iTrackEventIdx);

Default Value

""

Remarks

Literal description of the tracking event.

For UPS, possible values are:

For USPS, if RequestType is set to rtSummary, this will contain a description of the current status of the package being tracked. In this case, TrackEventStatus will contain the entire summary and none of the other properties will be populated. For example, this property might contain: "Your item was delivered at 8:10 am on June 1 in Wilmington DE 19801."

If there is a problem with a specific TrackingNumber within the request, the response will raise an error which will be returned in the TrackEventStatus property that pertains to the specific TrackingNumber.

When RequestType is set to rtDetail however, this property will contain a description of the event type for the current tracking event. For example, "ENROUTE", "DELIVERED", "ACCEPTANCE", etc. The rest of the fields will be populated with more details of the event.

When using Endicia as your postage provider, Status will be the only field populated and may contain the status, the timestamp, and the location of the tracking event.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventTime Property (FedExTrack Class)

Time the tracking event occurred.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventTime(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventTime(INT iTrackEventIdx);

char* dshippingsdk_fedextrack_gettrackeventtime(void* lpObj, int trackeventidx);

QString GetTrackEventTime(int iTrackEventIdx);

Default Value

""

Remarks

Time the tracking event occurred.

The TrackEventIdx parameter specifies the index of the item in the array. The size of the array is controlled by the TrackEventCount property.

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

Data Type

String

TrackEventZipCode Property (FedExTrack Class)

Postal code where the tracking event happened.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTrackEventZipCode(int iTrackEventIdx);

Unicode (Windows)
LPWSTR GetTrackEventZipCode(INT iTrackEventIdx);