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 CountryCode and ZipCode (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 AccountNumber. You should also have already obtained a ClientId and ClientSecret; uniquely assigned to your account by FedEx.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

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

FedExAccount Property (FedExTrack Class)

Login information for FedEx.

Syntax

• C++
• C
• Qt

DShippingSDKFedExAccount* GetFedExAccount();
int SetFedExAccount(DShippingSDKFedExAccount* val);

char* dshippingsdk_fedextrack_getfedexaccountnumber(void* lpObj);
int dshippingsdk_fedextrack_setfedexaccountnumber(void* lpObj, const char* lpszFedExAccountNumber);

char* dshippingsdk_fedextrack_getfedexauthorizationtoken(void* lpObj);
int dshippingsdk_fedextrack_setfedexauthorizationtoken(void* lpObj, const char* lpszFedExAuthorizationToken);

char* dshippingsdk_fedextrack_getfedexlanguagecode(void* lpObj);
int dshippingsdk_fedextrack_setfedexlanguagecode(void* lpObj, const char* lpszFedExLanguageCode);

char* dshippingsdk_fedextrack_getfedexlocalecode(void* lpObj);
int dshippingsdk_fedextrack_setfedexlocalecode(void* lpObj, const char* lpszFedExLocaleCode);

char* dshippingsdk_fedextrack_getfedexserver(void* lpObj);
int dshippingsdk_fedextrack_setfedexserver(void* lpObj, const char* lpszFedExServer);

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

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

QString GetFedExLanguageCode();
int SetFedExLanguageCode(QString qsFedExLanguageCode);

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

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

Remarks

This property must be set when connecting to FedEx server. It contains server and login information.

Data Type

DShippingSDKFedExAccount

Firewall Property (FedExTrack Class)

A set of properties related to firewall access.

Syntax

• C++
• C
• Qt

DShippingSDKFirewall* GetFirewall();
int SetFirewall(DShippingSDKFirewall* val);

int dshippingsdk_fedextrack_getfirewallautodetect(void* lpObj);
int dshippingsdk_fedextrack_setfirewallautodetect(void* lpObj, int bFirewallAutoDetect);

int dshippingsdk_fedextrack_getfirewalltype(void* lpObj);
int dshippingsdk_fedextrack_setfirewalltype(void* lpObj, int iFirewallType);

char* dshippingsdk_fedextrack_getfirewallhost(void* lpObj);
int dshippingsdk_fedextrack_setfirewallhost(void* lpObj, const char* lpszFirewallHost);

char* dshippingsdk_fedextrack_getfirewallpassword(void* lpObj);
int dshippingsdk_fedextrack_setfirewallpassword(void* lpObj, const char* lpszFirewallPassword);

int dshippingsdk_fedextrack_getfirewallport(void* lpObj);
int dshippingsdk_fedextrack_setfirewallport(void* lpObj, int iFirewallPort);

char* dshippingsdk_fedextrack_getfirewalluser(void* lpObj);
int dshippingsdk_fedextrack_setfirewalluser(void* lpObj, const char* lpszFirewallUser);

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

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

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

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

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

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

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the class will attempt to connect.

Data Type

DShippingSDKFirewall

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 CountryCode and ZipCode (where applicable) are required to be provided in the request.

Data Type

Integer

Notify Property (FedExTrack Class)

Collection of recipients to get notified.

Syntax

• C++
• C
• Qt

DShippingSDKList<DShippingSDKNotifyDetail>* GetNotify();
int SetNotify(DShippingSDKList<DShippingSDKNotifyDetail>* val);

int dshippingsdk_fedextrack_getnotifycount(void* lpObj);
int dshippingsdk_fedextrack_setnotifycount(void* lpObj, int iNotifyCount);

char* dshippingsdk_fedextrack_getnotifyaggregate(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_setnotifyaggregate(void* lpObj, int notifyidx, const char* lpszNotifyAggregate);

char* dshippingsdk_fedextrack_getnotifyemail(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_setnotifyemail(void* lpObj, int notifyidx, const char* lpszNotifyEmail);

char* dshippingsdk_fedextrack_getnotifymessage(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_setnotifymessage(void* lpObj, int notifyidx, const char* lpszNotifyMessage);

char* dshippingsdk_fedextrack_getnotifyname(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_setnotifyname(void* lpObj, int notifyidx, const char* lpszNotifyName);

int dshippingsdk_fedextrack_getnotifyflags(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_setnotifyflags(void* lpObj, int notifyidx, int iNotifyFlags);

int dshippingsdk_fedextrack_getnotifytype(void* lpObj, int notifyidx);
int dshippingsdk_fedextrack_setnotifytype(void* lpObj, int notifyidx, int iNotifyType);

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

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

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

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

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

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

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

Remarks

The Notify property is required to be provided in requests for:

• shipment status (notification(s) to be sent via e-mail) - when the RequestEmailNotification method is called.

In the first scenario, When a request will be made for e-mail notifications:

For each idx = 0 to NotifyCount - 1, this must be set to an instance of the NotifyDetail type, which will contain specific information about the recipient to be notified via email, before calling the RequestEmailNotification method. See the NotifyDetail type for more information.

Each recipient to receive an e-mail notification has an Email (required), RecipientType (optional), and NotificationFlags (optional) tied to it.

For instance, if the e-mail recipients' list consists of one recipient:

class.Email(0) = "test@test.com" class.RecipientType(0) = RT_SHIPPER

This property is not available at design time.

Data Type

DShippingSDKNotifyDetail

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

PackageDeliveryAncAction Property (FedExTrack Class)

Delivery ancillary action recommended for customer to resolve the delivery issue for the package at PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDeliveryAncAction();

Unicode (Windows)
LPWSTR GetPackageDeliveryAncAction();

char* dshippingsdk_fedextrack_getpackagedeliveryancaction(void* lpObj);

QString GetPackageDeliveryAncAction();

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called.

This property is read-only.

Data Type

String

PackageDeliveryAncActionDesc Property (FedExTrack Class)

Delivery ancillary action description. Field which holds recommended action description to resolve delivery issue for the package at PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDeliveryAncActionDesc();

Unicode (Windows)
LPWSTR GetPackageDeliveryAncActionDesc();

char* dshippingsdk_fedextrack_getpackagedeliveryancactiondesc(void* lpObj);

QString GetPackageDeliveryAncActionDesc();

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called.

Example: "Customer not Available or Business Closed"

This property is read-only.

Data Type

String

PackageDeliveryAncReasonDesc Property (FedExTrack Class)

Delivery ancillary reason description. Field which holds reason description associated to the status of the package at PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageDeliveryAncReasonDesc();

Unicode (Windows)
LPWSTR GetPackageDeliveryAncReasonDesc();

char* dshippingsdk_fedextrack_getpackagedeliveryancreasondesc(void* lpObj);

QString GetPackageDeliveryAncReasonDesc();

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called.

Example: "Customer not Available or Business Closed"

This property is read-only.

Data Type

String

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

PackageErrorMessage Property (FedExTrack Class)

The error message corresponding to the PackageIndex .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackageErrorMessage();

Unicode (Windows)
LPWSTR GetPackageErrorMessage();

char* dshippingsdk_fedextrack_getpackageerrormessage(void* lpObj);

QString GetPackageErrorMessage();

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called.

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

Proxy Property (FedExTrack Class)

A set of properties related to proxy access.

Syntax

• C++
• C
• Qt

DShippingSDKProxy* GetProxy();
int SetProxy(DShippingSDKProxy* val);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Data Type

DShippingSDKProxy

RecipientAddress Property (FedExTrack Class)

Identifies the recipient's address to which the shipment is destined.

Syntax

• C++
• C
• Qt

DShippingSDKAddressDetail* GetRecipientAddress();
int SetRecipientAddress(DShippingSDKAddressDetail* val);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

If you choose to track by IdentifierType other than Tracking Number, when calling TrackShipment method, you must either provide the ShipperAccountNumber for the packages to be tracked, or the ZipCode (if the CountryCode supports postal codes) and CountryCode to further identify the packages you want to track. Otherwise the CountryCode and ZipCode are optional, but recommended to be provided in the track request to narrow the search.

The RecipientAddress is returned when the TrackShipment or RequestEmailNotification methods are called.

This is set to an instance of the AddressDetail type, which will contain recipient's address info. See the AddressDetail type for more information.

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

Data Type

DShippingSDKAddressDetail

SenderAddress Property (FedExTrack Class)

Identifies the sender's address.

Syntax

• C++
• C
• Qt

DShippingSDKAddressDetail* GetSenderAddress();

char* dshippingsdk_fedextrack_getsenderaddress1(void* lpObj);

char* dshippingsdk_fedextrack_getsenderaddress2(void* lpObj);

int dshippingsdk_fedextrack_getsenderaddressflags(void* lpObj);

char* dshippingsdk_fedextrack_getsendercity(void* lpObj);

char* dshippingsdk_fedextrack_getsendercountrycode(void* lpObj);

char* dshippingsdk_fedextrack_getsenderstate(void* lpObj);

char* dshippingsdk_fedextrack_getsenderzipcode(void* lpObj);

QString GetSenderAddress1();

QString GetSenderAddress2();

int GetSenderAddressFlags();

QString GetSenderCity();

QString GetSenderCountryCode();

QString GetSenderState();

QString GetSenderZipCode();

Remarks

The SenderAddress is returned in the server response when TrackShipment is called.

This is set to an instance of the AddressDetail type, , which will contain sender's address info. See the AddressDetail type for more information.

This property is read-only.

Data Type

DShippingSDKAddressDetail

SenderContact Property (FedExTrack Class)

Identifies the sender that requests an email notification.

Syntax

• C++
• C
• Qt

DShippingSDKContactDetail* GetSenderContact();
int SetSenderContact(DShippingSDKContactDetail* val);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Remarks

The SenderContact is required to be provided in requests made for:

• shipment status (notification(s) to be sent via e-mail) - when the RequestEmailNotification method is called.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the sender of requests for e-mail notification(s). See the ContactDetail type for more information.

Data Type

DShippingSDKContactDetail

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 AccountNumber, 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 CountryCode and ZipCode (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

SSLAcceptServerCert Property (FedExTrack Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax

• C++
• C
• Qt

DShippingSDKCertificate* GetSSLAcceptServerCert();
int SetSSLAcceptServerCert(DShippingSDKCertificate* val);

char* dshippingsdk_fedextrack_getsslacceptservercerteffectivedate(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertexpirationdate(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertextendedkeyusage(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertfingerprint(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertfingerprintsha1(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertfingerprintsha256(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertissuer(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertprivatekey(void* lpObj);

int dshippingsdk_fedextrack_getsslacceptservercertprivatekeyavailable(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertprivatekeycontainer(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertpublickey(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertpublickeyalgorithm(void* lpObj);

int dshippingsdk_fedextrack_getsslacceptservercertpublickeylength(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertserialnumber(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertsignaturealgorithm(void* lpObj);

int dshippingsdk_fedextrack_getsslacceptservercertstore(void* lpObj, char** lpSSLAcceptServerCertStore, int* lenSSLAcceptServerCertStore);
int dshippingsdk_fedextrack_setsslacceptservercertstore(void* lpObj, const char* lpSSLAcceptServerCertStore, int lenSSLAcceptServerCertStore);

char* dshippingsdk_fedextrack_getsslacceptservercertstorepassword(void* lpObj);
int dshippingsdk_fedextrack_setsslacceptservercertstorepassword(void* lpObj, const char* lpszSSLAcceptServerCertStorePassword);

int dshippingsdk_fedextrack_getsslacceptservercertstoretype(void* lpObj);
int dshippingsdk_fedextrack_setsslacceptservercertstoretype(void* lpObj, int iSSLAcceptServerCertStoreType);

char* dshippingsdk_fedextrack_getsslacceptservercertsubjectaltnames(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertthumbprintmd5(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertthumbprintsha1(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertthumbprintsha256(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertusage(void* lpObj);

int dshippingsdk_fedextrack_getsslacceptservercertusageflags(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertversion(void* lpObj);

char* dshippingsdk_fedextrack_getsslacceptservercertsubject(void* lpObj);
int dshippingsdk_fedextrack_setsslacceptservercertsubject(void* lpObj, const char* lpszSSLAcceptServerCertSubject);

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

QString GetSSLAcceptServerCertEffectiveDate();

QString GetSSLAcceptServerCertExpirationDate();

QString GetSSLAcceptServerCertExtendedKeyUsage();

QString GetSSLAcceptServerCertFingerprint();

QString GetSSLAcceptServerCertFingerprintSHA1();

QString GetSSLAcceptServerCertFingerprintSHA256();

QString GetSSLAcceptServerCertIssuer();

QString GetSSLAcceptServerCertPrivateKey();

bool GetSSLAcceptServerCertPrivateKeyAvailable();

QString GetSSLAcceptServerCertPrivateKeyContainer();

QString GetSSLAcceptServerCertPublicKey();

QString GetSSLAcceptServerCertPublicKeyAlgorithm();

int GetSSLAcceptServerCertPublicKeyLength();

QString GetSSLAcceptServerCertSerialNumber();

QString GetSSLAcceptServerCertSignatureAlgorithm();

QByteArray GetSSLAcceptServerCertStore();
int SetSSLAcceptServerCertStore(QByteArray qbaSSLAcceptServerCertStore);

QString GetSSLAcceptServerCertStorePassword();
int SetSSLAcceptServerCertStorePassword(QString qsSSLAcceptServerCertStorePassword);

int GetSSLAcceptServerCertStoreType();
int SetSSLAcceptServerCertStoreType(int iSSLAcceptServerCertStoreType);

QString GetSSLAcceptServerCertSubjectAltNames();

QString GetSSLAcceptServerCertThumbprintMD5();

QString GetSSLAcceptServerCertThumbprintSHA1();

QString GetSSLAcceptServerCertThumbprintSHA256();

QString GetSSLAcceptServerCertUsage();

int GetSSLAcceptServerCertUsageFlags();

QString GetSSLAcceptServerCertVersion();

QString GetSSLAcceptServerCertSubject();
int SetSSLAcceptServerCertSubject(QString qsSSLAcceptServerCertSubject);

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

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Note: This functionality is provided only for cases in which you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Data Type

DShippingSDKCertificate

SSLCert Property (FedExTrack Class)

The certificate to be used during Secure Sockets Layer (SSL) negotiation.

Syntax

• C++
• C
• Qt

DShippingSDKCertificate* GetSSLCert();
int SetSSLCert(DShippingSDKCertificate* val);

char* dshippingsdk_fedextrack_getsslcerteffectivedate(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertexpirationdate(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertextendedkeyusage(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertfingerprint(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertfingerprintsha1(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertfingerprintsha256(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertissuer(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertprivatekey(void* lpObj);

int dshippingsdk_fedextrack_getsslcertprivatekeyavailable(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertprivatekeycontainer(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertpublickey(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertpublickeyalgorithm(void* lpObj);

int dshippingsdk_fedextrack_getsslcertpublickeylength(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertserialnumber(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertsignaturealgorithm(void* lpObj);

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

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

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

char* dshippingsdk_fedextrack_getsslcertsubjectaltnames(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertthumbprintmd5(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertthumbprintsha1(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertthumbprintsha256(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertusage(void* lpObj);

int dshippingsdk_fedextrack_getsslcertusageflags(void* lpObj);

char* dshippingsdk_fedextrack_getsslcertversion(void* lpObj);

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

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

QString GetSSLCertEffectiveDate();

QString GetSSLCertExpirationDate();

QString GetSSLCertExtendedKeyUsage();

QString GetSSLCertFingerprint();

QString GetSSLCertFingerprintSHA1();

QString GetSSLCertFingerprintSHA256();

QString GetSSLCertIssuer();

QString GetSSLCertPrivateKey();

bool GetSSLCertPrivateKeyAvailable();

QString GetSSLCertPrivateKeyContainer();

QString GetSSLCertPublicKey();

QString GetSSLCertPublicKeyAlgorithm();

int GetSSLCertPublicKeyLength();

QString GetSSLCertSerialNumber();

QString GetSSLCertSignatureAlgorithm();

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

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

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

QString GetSSLCertSubjectAltNames();

QString GetSSLCertThumbprintMD5();

QString GetSSLCertThumbprintSHA1();

QString GetSSLCertThumbprintSHA256();

QString GetSSLCertUsage();

int GetSSLCertUsageFlags();

QString GetSSLCertVersion();

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

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

Remarks

This property includes the digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Data Type

DShippingSDKCertificate

SSLProvider Property (FedExTrack Class)

The Secure Sockets Layer/Transport Layer Security (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 as follows:

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

SSLServerCert Property (FedExTrack Class)

The server certificate for the last established connection.

Syntax

• C++
• C
• Qt

DShippingSDKCertificate* GetSSLServerCert();

char* dshippingsdk_fedextrack_getsslservercerteffectivedate(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertexpirationdate(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertextendedkeyusage(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertfingerprint(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertfingerprintsha1(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertfingerprintsha256(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertissuer(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertprivatekey(void* lpObj);

int dshippingsdk_fedextrack_getsslservercertprivatekeyavailable(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertprivatekeycontainer(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertpublickey(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertpublickeyalgorithm(void* lpObj);

int dshippingsdk_fedextrack_getsslservercertpublickeylength(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertserialnumber(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertsignaturealgorithm(void* lpObj);

int dshippingsdk_fedextrack_getsslservercertstore(void* lpObj, char** lpSSLServerCertStore, int* lenSSLServerCertStore);

char* dshippingsdk_fedextrack_getsslservercertstorepassword(void* lpObj);

int dshippingsdk_fedextrack_getsslservercertstoretype(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertsubjectaltnames(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertthumbprintmd5(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertthumbprintsha1(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertthumbprintsha256(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertusage(void* lpObj);

int dshippingsdk_fedextrack_getsslservercertusageflags(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertversion(void* lpObj);

char* dshippingsdk_fedextrack_getsslservercertsubject(void* lpObj);

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

QString GetSSLServerCertEffectiveDate();

QString GetSSLServerCertExpirationDate();

QString GetSSLServerCertExtendedKeyUsage();

QString GetSSLServerCertFingerprint();

QString GetSSLServerCertFingerprintSHA1();

QString GetSSLServerCertFingerprintSHA256();

QString GetSSLServerCertIssuer();

QString GetSSLServerCertPrivateKey();

bool GetSSLServerCertPrivateKeyAvailable();

QString GetSSLServerCertPrivateKeyContainer();

QString GetSSLServerCertPublicKey();

QString GetSSLServerCertPublicKeyAlgorithm();

int GetSSLServerCertPublicKeyLength();

QString GetSSLServerCertSerialNumber();

QString GetSSLServerCertSignatureAlgorithm();

QByteArray GetSSLServerCertStore();

QString GetSSLServerCertStorePassword();

int GetSSLServerCertStoreType();

QString GetSSLServerCertSubjectAltNames();

QString GetSSLServerCertThumbprintMD5();

QString GetSSLServerCertThumbprintSHA1();

QString GetSSLServerCertThumbprintSHA256();

QString GetSSLServerCertUsage();

int GetSSLServerCertUsageFlags();

QString GetSSLServerCertVersion();

QString GetSSLServerCertSubject();

QByteArray GetSSLServerCertEncoded();

Remarks

This property contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Data Type

DShippingSDKCertificate

Timeout Property (FedExTrack Class)

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

Note: By default, all timeouts are inactivity timeouts, that is, 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

TrackEvents Property (FedExTrack Class)

Collection of tracking details for all scanning events that occur during the shipping process of the package at PackageIndex .

Syntax

• C++
• C
• Qt

DShippingSDKList<DShippingSDKTrackDetail>* GetTrackEvents();

int dshippingsdk_fedextrack_gettrackeventcount(void* lpObj);

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

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

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

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

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

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

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

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

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

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

int GetTrackEventCount();

QString GetTrackEventAddress1(int iTrackEventIdx);

QString GetTrackEventAddress2(int iTrackEventIdx);

QString GetTrackEventCity(int iTrackEventIdx);

QString GetTrackEventCountryCode(int iTrackEventIdx);

QString GetTrackEventDate(int iTrackEventIdx);

QString GetTrackEventException(int iTrackEventIdx);

QString GetTrackEventState(int iTrackEventIdx);

QString GetTrackEventStatus(int iTrackEventIdx);

QString GetTrackEventTime(int iTrackEventIdx);

QString GetTrackEventZipCode(int iTrackEventIdx);

Remarks

It should be inspected after a call to the TrackShipment method (for each idx = 0 to TrackEventCount - 1).

Each tracking event has a Date, Time, Address1, Address2, City, State, CountryCode, Exception, and Status tied to it.

For instance, if the response contains only one tracking event:

m_date = class.Date(0) m_time = class.Time(0) m_status = class.Status(0) m_city = class.City(0) m_state = class.State(0) m_country = class.CountryCode(0)

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

Data Type

DShippingSDKTrackDetail

Config Method (FedExTrack Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* dshippingsdk_fedextrack_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetProofOfDelivery Method (FedExTrack Class)

Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProofOfDelivery(const char* lpsztrackingNumber, int *lpSize = NULL);

Unicode (Windows)
LPSTR GetProofOfDelivery(LPCWSTR lpsztrackingNumber, LPINT lpSize = NULL);

char* dshippingsdk_fedextrack_getproofofdelivery(void* lpObj, const char* lpsztrackingNumber, int *lpSize);

QByteArray GetProofOfDelivery(const QString& qstrackingNumber);

Remarks

The trackingNumber parameter identifies the shipment the SPOD will be requested for. Via this method, you can receive the SPOD (when applicable) in .pdf format.

The following properties can be set when this method is called:

• AuthorizationToken (required)
• Server (optional)
• AccountNumber (required)
• ShipDate (required)
• ShipperAccountNumber (optional)

This method will return the image of the SPOD. This is the decoded binary image file of the Signature Proof of Delivery (SPOD), stored in memory.

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.

Error Handling (C++)

This method returns a Binary String value (with length lpSize); after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

RequestEmailNotification Method (FedExTrack Class)

Request email notification for a specified trackingNumber to a specified Recipients list.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int RequestEmailNotification(const char* lpsztrackingNumber);

Unicode (Windows)
INT RequestEmailNotification(LPCWSTR lpsztrackingNumber);

int dshippingsdk_fedextrack_requestemailnotification(void* lpObj, const char* lpsztrackingNumber);

int RequestEmailNotification(const QString& qstrackingNumber);

Remarks

The trackingNumber parameter identifies the shipment the notification will be requested for. Via this method, you send notification of package state to up to four e-mail addresses.

The following properties can be set when this method is called:

• AuthorizationToken (required)
• Server (optional)
• AccountNumber (required)
• ShipDateStart (required)
• ShipDateEnd (required)
• SenderContact (by specifying FirstName, LastName, and Email - required)
• Notify (required)
• Message (optional)

Notification allows you to request that e-mail exception and delivery notifications be sent to you, your recipient, and up to 2 other e-mail addresses (by specifying the Notify). A personal message can also be included via the Message property.

FedEx services offering this feature are FedEx Express (FDXE), FedEx Ground (FDXG), FedEx Cargo (FDXC), FedEx Custom Critical (FXCC), and FedEx Freight (FXFR). FedEx SmartPost shipments are not included in this feature.

There are three notification options:

• Shipment notification. In this case, the ntOnShipment flag should be set in the NotificationFlags field for that recipient;
• Exception notification (such as if an exception occurs during scanning and the package may be delayed, for example, or if an address correction is required. In this case, the ntOnException flag should be set in the NotificationFlags field for that recipient; or
• Delivery notification. In this case, the ntOnDelivery flag should be set in the NotificationFlags field for that recipient;

You must choose between these delivery types: wireless (to a cell phone), text only e-mail, and HTML e-mail by setting the NotificationFlags to any of the desired options.

A personal message, which can be included in the request via the Message, up to 120 characters) is allowed for e-mail notifications only. This is not applicable for wireless notifications.

If there is a problem with the trackingNumber, or recipients' information, the response will raise an error that pertains to that element. For more details on errors codes and descriptions, please refer to the Error Codes section.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (FedExTrack Class)

Resets the internal state of the class and all properties to their default values.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int dshippingsdk_fedextrack_reset(void* lpObj);

int Reset();

Remarks

The Reset method does not have any parameters and does not return any value.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SaveProofOfDelivery Method (FedExTrack Class)

Request Signature Proof of Delivery (SPOD) for a specified trackingNumber .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveProofOfDelivery(const char* lpsztrackingNumber, const char* lpszfilename);

Unicode (Windows)
INT SaveProofOfDelivery(LPCWSTR lpsztrackingNumber, LPCWSTR lpszfilename);

int dshippingsdk_fedextrack_saveproofofdelivery(void* lpObj, const char* lpsztrackingNumber, const char* lpszfilename);

int SaveProofOfDelivery(const QString& qstrackingNumber, const QString& qsfilename);

Remarks

The trackingNumber parameter identifies the shipment the SPOD will be requested for. Via this method, you can receive the SPOD (when applicable) in .pdf format.

The following properties can be set when this method is called:

• AuthorizationToken (required)
• Server (optional)
• AccountNumber (required)
• ShipDate (required)
• ShipperAccountNumber (optional)

The filename parameter describes the location on disk to write the returned image of the SPOD to. This filename should have the .pdf extension.

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting. The default value of this config is True.

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

TrackShipment Method (FedExTrack Class)

Returns tracking data for requested idValue of IdentifierType type.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int TrackShipment(const char* lpszidValue);

Unicode (Windows)
INT TrackShipment(LPCWSTR lpszidValue);

int dshippingsdk_fedextrack_trackshipment(void* lpObj, const char* lpszidValue);

int TrackShipment(const QString& qsidValue);

Remarks

The idValue parameter identifies the shipment. This identifier can be of IdentifierType type. Some identifiers apply to a single package (such as Package Tracking Number), while others apply to multiple packages or shipments of which they are part of. The idValue must be alphanumeric.

FedEx uses shipment identification numbers and types to identify and trace every shipment as it goes through the FedEx system to its destination. You can use this shipment identification number and type to track, locate, and verify arrival of a shipment.

When sending a tracking request to the FedEx Server, there is information that the server requires before it will process the request. The following properties can be sent in the request in order to track by tracking number or by any other identifier:

• AuthorizationToken (required)
• Server (optional)
• AccountNumber (required)
• ShipDateStart (optional)
• ShipDateEnd (optional)
• ShipperAccountNumber (optional)
• CountryCode (optional)
• ZipCode (optional)

A successful query returns all of the packages within a shipment. For example, if a shipment contained four packages, the query response would show all four packages.

If FedEx system doesn't locate any data for the requested identifier, the transaction will be considered successful and the Warning will contain the 'No data...' message. The full server reply will be saved to RawResponse.

The following properties may be populated upon method return:

• CarrierCodeDescription
• ShipDate
• PackageTrackingNumber
• PackageServiceTypeDescription
• PackagePackagingType
• PackageDeliveryStatus
• PackageDeliveryEstimate
• PackageDeliveryDate
• PackageDeliveryLocation
• PackageErrorMessage
• PackageSignedBy
• SenderAddress
• RecipientAddress
• TotalWeight and WeightUnit;
• Tracking details for each tracking event, which can be inspected via TrackEvents collection. This information consists of: Address1, Address2, City, State, CountryCode, ZipCode, Date, Time, Status and Exception.

If there is a problem with a specific identifier within the request, the response will raise an error that pertains to the specific idValue of a IdentifierType type.

For more details on errors codes and descriptions, please refer to the Error Codes section.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (FedExTrack Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(FedExTrackErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} FedExTrackErrorEventParams;


Unicode (Windows)
virtual INT FireError(FedExTrackErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} FedExTrackErrorEventParams;

#define EID_FEDEXTRACK_ERROR 1

virtual INT DSHIPPINGSDK_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class FedExTrackErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(FedExTrackErrorEventParams *e);

// Or, subclass FedExTrack and override this emitter function.
virtual int FireError(FedExTrackErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Notification Event (FedExTrack Class)

Notification returned by the server upon successful request (if applicable).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireNotification(FedExTrackNotificationEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FedExTrackNotificationEventParams;


Unicode (Windows)
virtual INT FireNotification(FedExTrackNotificationEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FedExTrackNotificationEventParams;

#define EID_FEDEXTRACK_NOTIFICATION 2

virtual INT DSHIPPINGSDK_CALL FireNotification(LPSTR &lpszMessage);

class FedExTrackNotificationEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Notification(FedExTrackNotificationEventParams *e);

// Or, subclass FedExTrack and override this emitter function.
virtual int FireNotification(FedExTrackNotificationEventParams *e) {...}

Remarks

When sending a request, the server may return with a successful reply or an error. However, even when a transaction is successful, a warning or a note might still be returned by the server. In such cases, the Notification event is fired.

Notifications returned through this event are non-fatal and shipments will still be processes, labels will still be printable, rates are still returned, etc. These notifications should be treated as informational only.

SSLServerAuthentication Event (FedExTrack Class)

Fired after the server presents its certificate to the client.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLServerAuthentication(FedExTrackSSLServerAuthenticationEventParams *e);

typedef struct {
  const char *CertEncoded;
  int lenCertEncoded;
  const char *CertSubject;
  const char *CertIssuer;
  const char *Status;
  int Accept;
  int reserved;
} FedExTrackSSLServerAuthenticationEventParams;


Unicode (Windows)
virtual INT FireSSLServerAuthentication(FedExTrackSSLServerAuthenticationEventParams *e);

typedef struct {
  LPCSTR CertEncoded;
  INT lenCertEncoded;
  LPCWSTR CertSubject;
  LPCWSTR CertIssuer;
  LPCWSTR Status;
  BOOL Accept;
  INT reserved;
} FedExTrackSSLServerAuthenticationEventParams;

#define EID_FEDEXTRACK_SSLSERVERAUTHENTICATION 3

virtual INT DSHIPPINGSDK_CALL FireSSLServerAuthentication(LPSTR &lpCertEncoded, INT &lenCertEncoded, LPSTR &lpszCertSubject, LPSTR &lpszCertIssuer, LPSTR &lpszStatus, BOOL &bAccept);

class FedExTrackSSLServerAuthenticationEventParams {
public:
  const QByteArray &CertEncoded();

  const QString &CertSubject();

  const QString &CertIssuer();

  const QString &Status();

  bool Accept();
  void SetAccept(bool bAccept);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLServerAuthentication(FedExTrackSSLServerAuthenticationEventParams *e);

// Or, subclass FedExTrack and override this emitter function.
virtual int FireSSLServerAuthentication(FedExTrackSSLServerAuthenticationEventParams *e) {...}

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (FedExTrack Class)

Fired when secure connection progress messages are available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSSLStatus(FedExTrackSSLStatusEventParams *e);

typedef struct {
  const char *Message;
  int reserved;
} FedExTrackSSLStatusEventParams;


Unicode (Windows)
virtual INT FireSSLStatus(FedExTrackSSLStatusEventParams *e);

typedef struct {
  LPCWSTR Message;
  INT reserved;
} FedExTrackSSLStatusEventParams;

#define EID_FEDEXTRACK_SSLSTATUS 4

virtual INT DSHIPPINGSDK_CALL FireSSLStatus(LPSTR &lpszMessage);

class FedExTrackSSLStatusEventParams {
public:
  const QString &Message();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SSLStatus(FedExTrackSSLStatusEventParams *e);

// Or, subclass FedExTrack and override this emitter function.
virtual int FireSSLStatus(FedExTrackSSLStatusEventParams *e) {...}

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

AddressDetail Type

Represents the address details of a sender or recipient.

Syntax

DShippingSDKAddressDetail (declared in dshippingsdk.h)

Remarks

This type contains descriptive data of physical location of a sender or recipient.

Example: Setting the fields of a sender SenderAddress addr = new SenderAddress addr.Address1 = "100 Somewhere St." addr.Address2 = "Ste 100" addr.City = "Raleigh" addr.State = "NC" addr.ZipCode = "27154" addr.CountryCode = "US"

The fields contained by this type are listed below.

• Address1
• Address2
• AddressFlags
• City
• CountryCode
• State
• ZipCode

Fields

Constructors

AddressDetail()

Certificate Type

This is the digital certificate being used.

Syntax

DShippingSDKCertificate (declared in dshippingsdk.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

Certificate()

Certificate(const char* lpEncoded, int lenEncoded)

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

ContactDetail Type

Represents the contact information.

Syntax

DShippingSDKContactDetail (declared in dshippingsdk.h)

Remarks

This type contains descriptive data identifying the point-of-contact person (such as sender, recipient, broker, etc.).

Example: Setting the fields of the sender ContactDetail senderContact = new ContactDetail senderContact.Company = "Anything Anywhere" senderContact.FirstName = "John" senderContact.LastName = "Doe" senderContact.Phone = "1234567890" senderContact.Email = "test@test.com"

The fields contained by this type are listed below.

• Company
• Email
• Fax
• FirstName
• LastName
• MiddleInitial
• Phone

Fields

Constructors

ContactDetail()

ContactDetail(const char* lpszFirstName, const char* lpszLastName, const char* lpszPhone)

ContactDetail(const char* lpszFirstName, const char* lpszLastName, const char* lpszPhone, const char* lpszEmail)

ContactDetail(const char* lpszFirstName, const char* lpszLastName, const char* lpszPhone, const char* lpszEmail, const char* lpszCompany)

FedExAccount Type

Represents the details of a FedEx account.

Syntax

DShippingSDKFedExAccount (declared in dshippingsdk.h)

Remarks

This type contains data describing the FedEx server and login information.

Example: Setting the fields of an account FedExAccount account = new FedExAccount account.AccountNumber = "1234567" account.AuthorizationToken = "bearer_token_value" account.Server = "https://test.fedex.com"

The fields contained by this type are listed below.

• AccountNumber
• AuthorizationToken
• LanguageCode
• LocaleCode
• Server

Fields

Constructors

FedExAccount()

Firewall Type

The firewall the component will connect through.

Syntax

DShippingSDKFirewall (declared in dshippingsdk.h)

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

• AutoDetect
• FirewallType
• Host
• Password
• Port
• User

Fields

Constructors

Firewall()

NotifyDetail Type

Represents a single recipient to be notified via email.

Syntax

DShippingSDKNotifyDetail (declared in dshippingsdk.h)

Remarks

This type contains specific information about a recipient to be notified via email on shipment, exception and/or delivery status.

The fields contained by this type are listed below.

• Aggregate
• Email
• Message
• Name
• NotificationFlags
• RecipientType

Fields

Constructors

NotifyDetail()

NotifyDetail(int iNotificationFlags, const char* lpszEmail, const char* lpszMessage)

NotifyDetail(int iNotificationFlags, const char* lpszEmail)

NotifyDetail(int iNotificationFlags, int iRecipientType, const char* lpszEmail)

NotifyDetail(const char* lpszName)

Proxy Type

The proxy the component will connect to.

Syntax

DShippingSDKProxy (declared in dshippingsdk.h)

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

• AuthScheme
• AutoDetect
• Password
• Port
• Server
• SSL
• User

Fields

Constructors

Proxy()

Proxy(const char* lpszServer, int iPort)

Proxy(const char* lpszServer, int iPort, const char* lpszUser, const char* lpszPassword)

TrackDetail Type

Indicates the tracking details.

Syntax

DShippingSDKTrackDetail (declared in dshippingsdk.h)

Remarks

This type contains the results of a tracking search made after a call to the TrackShipment method. The fields contained by this type are listed below.

• Address1
• Address2
• City
• Company
• CountryCode
• Date
• Exception
• Location
• Other
• State
• Status
• Time
• ZipCode

Fields

DShippingSDKList Type

Syntax

DShippingSDKList<T> (declared in dshippingsdk.h)

Remarks

DShippingSDKList is a generic class that is used to hold a collection of objects of type T, where T is one of the custom types supported by the FedExTrack class.

int GetCount() {}

int SetCount(int count) {}

T* Get(int index) {}

T* Set(int index, T* value) {}

Config Settings (FedExTrack Class)

FedExTrack Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----