FedExTrack Module

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

DShippingSDK.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 RecipientAddressCountryCode and RecipientAddressZipCode (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 FedExAccountAccountNumber. 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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

CarrierCodeDescription Property (FedExTrack Module)

FedEx carrier code description used for shipment.

Syntax

• Swift
• Objective-C

public var carrierCodeDescription: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=carrierCodeDescription) NSString* carrierCodeDescription;

- (NSString*)carrierCodeDescription;

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.

EstimatedPickupDate Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var estimatedPickupDate: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=estimatedPickupDate) NSString* estimatedPickupDate;

- (NSString*)estimatedPickupDate;

Default Value

""

Remarks

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

Format: YYYY-MM-DD.

This property is read-only.

FedExAccount Property (FedExTrack Module)

Login information for FedEx.

Syntax

• Swift
• Objective-C

public var fedExAccount: FedExAccount {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=fedExAccountNumber,setter=setFedExAccountNumber:) NSString* fedExAccountNumber;

- (NSString*)fedExAccountNumber;
- (void)setFedExAccountNumber :(NSString*)newFedExAccountNumber;

@property (nonatomic,readwrite,assign,getter=fedExAuthorizationToken,setter=setFedExAuthorizationToken:) NSString* fedExAuthorizationToken;

- (NSString*)fedExAuthorizationToken;
- (void)setFedExAuthorizationToken :(NSString*)newFedExAuthorizationToken;

@property (nonatomic,readwrite,assign,getter=fedExLanguageCode,setter=setFedExLanguageCode:) NSString* fedExLanguageCode;

- (NSString*)fedExLanguageCode;
- (void)setFedExLanguageCode :(NSString*)newFedExLanguageCode;

@property (nonatomic,readwrite,assign,getter=fedExLocaleCode,setter=setFedExLocaleCode:) NSString* fedExLocaleCode;

- (NSString*)fedExLocaleCode;
- (void)setFedExLocaleCode :(NSString*)newFedExLocaleCode;

@property (nonatomic,readwrite,assign,getter=fedExServer,setter=setFedExServer:) NSString* fedExServer;

- (NSString*)fedExServer;
- (void)setFedExServer :(NSString*)newFedExServer;

 

Default Value

""

Remarks

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

This property is read-only.

Firewall Property (FedExTrack Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

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

This property is read-only.

IdentifierType Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var identifierType: FedextrackIdentifierTypes {
  get {...}
  set {...}
}

public enum FedextrackIdentifierTypes: Int32 {
  case fitTrackingNumberOrDoorTag = 0
  case fitBillOfLading = 1
  case fitCODReturnTrackingNumber = 2
  case fitCustomerAuthorizationNumber = 3
  case fitCustomerReference = 4
  case fitDepartment = 5
  case fitFreeFormReference = 6
  case fitGroundShipmentId = 7
  case fitGroundMPS = 8
  case fitInvoiceNumber = 9
  case fitPartnerCarrierNumber = 10
  case fitPartNumber = 11
  case fitPONumber = 12
  case fitRMANumber = 13
  case fitTrackingControlNumber = 14
  case fitShipperReference = 15
  case fitStandardMPS = 16
}

@property (nonatomic,readwrite,assign,getter=identifierType,setter=setIdentifierType:) int identifierType;

- (int)identifierType;
- (void)setIdentifierType :(int)newIdentifierType;

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

Notify Property (FedExTrack Module)

Collection of recipients to get notified.

Syntax

• Swift
• Objective-C

public var notify: Array<NotifyDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=notifyCount,setter=setNotifyCount:) int notifyCount;

- (int)notifyCount;
- (void)setNotifyCount :(int)newNotifyCount;

- (NSString*)notifyAggregate:(int)notifyIdx;
- (void)setNotifyAggregate:(int)notifyIdx :(NSString*)newNotifyAggregate;

- (NSString*)notifyEmail:(int)notifyIdx;
- (void)setNotifyEmail:(int)notifyIdx :(NSString*)newNotifyEmail;

- (NSString*)notifyMessage:(int)notifyIdx;
- (void)setNotifyMessage:(int)notifyIdx :(NSString*)newNotifyMessage;

- (NSString*)notifyName:(int)notifyIdx;
- (void)setNotifyName:(int)notifyIdx :(NSString*)newNotifyName;

- (int)notifyFlags:(int)notifyIdx;
- (void)setNotifyFlags:(int)notifyIdx :(int)newNotifyFlags;

- (int)notifyType:(int)notifyIdx;
- (void)setNotifyType:(int)notifyIdx :(int)newNotifyType;

Default Value

""

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 (required), (optional), and (optional) tied to it.

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

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

This property is read-only.

PackageCount Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageCount) int packageCount;

- (int)packageCount;

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.

PackageDeliveryAncAction Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageDeliveryAncAction: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageDeliveryAncAction) NSString* packageDeliveryAncAction;

- (NSString*)packageDeliveryAncAction;

Default Value

""

Remarks

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

This property is read-only.

PackageDeliveryAncActionDesc Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageDeliveryAncActionDesc: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageDeliveryAncActionDesc) NSString* packageDeliveryAncActionDesc;

- (NSString*)packageDeliveryAncActionDesc;

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.

PackageDeliveryAncReasonDesc Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageDeliveryAncReasonDesc: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageDeliveryAncReasonDesc) NSString* packageDeliveryAncReasonDesc;

- (NSString*)packageDeliveryAncReasonDesc;

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.

PackageDeliveryDate Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageDeliveryDate: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageDeliveryDate) NSString* packageDeliveryDate;

- (NSString*)packageDeliveryDate;

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.

PackageDeliveryEstimate Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageDeliveryEstimate: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageDeliveryEstimate) NSString* packageDeliveryEstimate;

- (NSString*)packageDeliveryEstimate;

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.

PackageDeliveryLocation Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageDeliveryLocation: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageDeliveryLocation) NSString* packageDeliveryLocation;

- (NSString*)packageDeliveryLocation;

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.

PackageDeliveryStatus Property (FedExTrack Module)

Delivery status description of the package at PackageIndex .

Syntax

• Swift
• Objective-C

public var packageDeliveryStatus: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageDeliveryStatus) NSString* packageDeliveryStatus;

- (NSString*)packageDeliveryStatus;

Default Value

""

Remarks

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

This property is read-only.

PackageErrorMessage Property (FedExTrack Module)

The error message corresponding to the PackageIndex .

Syntax

• Swift
• Objective-C

public var packageErrorMessage: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageErrorMessage) NSString* packageErrorMessage;

- (NSString*)packageErrorMessage;

Default Value

""

Remarks

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

This property is read-only.

PackageIndex Property (FedExTrack Module)

The package index in a shipment being tracked.

Syntax

• Swift
• Objective-C

public var packageIndex: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=packageIndex,setter=setPackageIndex:) int packageIndex;

- (int)packageIndex;
- (void)setPackageIndex :(int)newPackageIndex;

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.

PackagePackagingType Property (FedExTrack Module)

Description of packaging type of the package at PackageIndex .

Syntax

• Swift
• Objective-C

public var packagePackagingType: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packagePackagingType) NSString* packagePackagingType;

- (NSString*)packagePackagingType;

Default Value

""

Remarks

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

This property is read-only.

PackageReceivedBy Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageReceivedBy: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageReceivedBy) NSString* packageReceivedBy;

- (NSString*)packageReceivedBy;

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.

PackageReferences Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageReferences: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageReferences) NSString* packageReferences;

- (NSString*)packageReferences;

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.

PackageServiceTypeDescription Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var packageServiceTypeDescription: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageServiceTypeDescription) NSString* packageServiceTypeDescription;

- (NSString*)packageServiceTypeDescription;

Default Value

""

Remarks

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

This property is read-only.

PackageSignedBy Property (FedExTrack Module)

Signature of person who signed for package at PackageIndex .

Syntax

• Swift
• Objective-C

public var packageSignedBy: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageSignedBy) NSString* packageSignedBy;

- (NSString*)packageSignedBy;

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.

PackageTrackingNumber Property (FedExTrack Module)

Tracking number for the package at PackageIndex .

Syntax

• Swift
• Objective-C

public var packageTrackingNumber: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageTrackingNumber) NSString* packageTrackingNumber;

- (NSString*)packageTrackingNumber;

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.

PackageWeight Property (FedExTrack Module)

Weight of the package at PackageIndex .

Syntax

• Swift
• Objective-C

public var packageWeight: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packageWeight) NSString* packageWeight;

- (NSString*)packageWeight;

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.

Proxy Property (FedExTrack Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

 

Default Value

""

Remarks

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

This property is read-only.

RecipientAddress Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var recipientAddress: AddressDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recipientAddress1,setter=setRecipientAddress1:) NSString* recipientAddress1;

- (NSString*)recipientAddress1;
- (void)setRecipientAddress1 :(NSString*)newRecipientAddress1;

@property (nonatomic,readwrite,assign,getter=recipientAddress2,setter=setRecipientAddress2:) NSString* recipientAddress2;

- (NSString*)recipientAddress2;
- (void)setRecipientAddress2 :(NSString*)newRecipientAddress2;

@property (nonatomic,readwrite,assign,getter=recipientAddressFlags,setter=setRecipientAddressFlags:) int recipientAddressFlags;

- (int)recipientAddressFlags;
- (void)setRecipientAddressFlags :(int)newRecipientAddressFlags;

@property (nonatomic,readwrite,assign,getter=recipientCity,setter=setRecipientCity:) NSString* recipientCity;

- (NSString*)recipientCity;
- (void)setRecipientCity :(NSString*)newRecipientCity;

@property (nonatomic,readwrite,assign,getter=recipientCountryCode,setter=setRecipientCountryCode:) NSString* recipientCountryCode;

- (NSString*)recipientCountryCode;
- (void)setRecipientCountryCode :(NSString*)newRecipientCountryCode;

@property (nonatomic,readwrite,assign,getter=recipientState,setter=setRecipientState:) NSString* recipientState;

- (NSString*)recipientState;
- (void)setRecipientState :(NSString*)newRecipientState;

@property (nonatomic,readwrite,assign,getter=recipientZipCode,setter=setRecipientZipCode:) NSString* recipientZipCode;

- (NSString*)recipientZipCode;
- (void)setRecipientZipCode :(NSString*)newRecipientZipCode;

 

Default Value

""

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 (if the supports postal codes) and to further identify the packages you want to track. Otherwise the and 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.

This property is read-only.

SenderAddress Property (FedExTrack Module)

Identifies the sender's address.

Syntax

• Swift
• Objective-C

public var senderAddress: AddressDetail {
  get {...}
}

@property (nonatomic,readonly,assign,getter=senderAddress1) NSString* senderAddress1;

- (NSString*)senderAddress1;

@property (nonatomic,readonly,assign,getter=senderAddress2) NSString* senderAddress2;

- (NSString*)senderAddress2;

@property (nonatomic,readonly,assign,getter=senderAddressFlags) int senderAddressFlags;

- (int)senderAddressFlags;

@property (nonatomic,readonly,assign,getter=senderCity) NSString* senderCity;

- (NSString*)senderCity;

@property (nonatomic,readonly,assign,getter=senderCountryCode) NSString* senderCountryCode;

- (NSString*)senderCountryCode;

@property (nonatomic,readonly,assign,getter=senderState) NSString* senderState;

- (NSString*)senderState;

@property (nonatomic,readonly,assign,getter=senderZipCode) NSString* senderZipCode;

- (NSString*)senderZipCode;

 

Default Value

""

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.

SenderContact Property (FedExTrack Module)

Identifies the sender that requests an email notification.

Syntax

• Swift
• Objective-C

public var senderContact: ContactDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=senderCompany,setter=setSenderCompany:) NSString* senderCompany;

- (NSString*)senderCompany;
- (void)setSenderCompany :(NSString*)newSenderCompany;

@property (nonatomic,readwrite,assign,getter=senderEmail,setter=setSenderEmail:) NSString* senderEmail;

- (NSString*)senderEmail;
- (void)setSenderEmail :(NSString*)newSenderEmail;

@property (nonatomic,readwrite,assign,getter=senderFax,setter=setSenderFax:) NSString* senderFax;

- (NSString*)senderFax;
- (void)setSenderFax :(NSString*)newSenderFax;

@property (nonatomic,readwrite,assign,getter=senderFirstName,setter=setSenderFirstName:) NSString* senderFirstName;

- (NSString*)senderFirstName;
- (void)setSenderFirstName :(NSString*)newSenderFirstName;

@property (nonatomic,readwrite,assign,getter=senderLastName,setter=setSenderLastName:) NSString* senderLastName;

- (NSString*)senderLastName;
- (void)setSenderLastName :(NSString*)newSenderLastName;

@property (nonatomic,readwrite,assign,getter=senderMiddleInitial,setter=setSenderMiddleInitial:) NSString* senderMiddleInitial;

- (NSString*)senderMiddleInitial;
- (void)setSenderMiddleInitial :(NSString*)newSenderMiddleInitial;

@property (nonatomic,readwrite,assign,getter=senderPhone,setter=setSenderPhone:) NSString* senderPhone;

- (NSString*)senderPhone;
- (void)setSenderPhone :(NSString*)newSenderPhone;

 

Default Value

""

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.

This property is read-only.

ShipDate Property (FedExTrack Module)

The date on which the package was tendered to FedEx.

Syntax

• Swift
• Objective-C

public var shipDate: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipDate,setter=setShipDate:) NSString* shipDate;

- (NSString*)shipDate;
- (void)setShipDate :(NSString*)newShipDate;

Default Value

""

Remarks

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

Format: YYYY-MM-DD.

ShipDateEnd Property (FedExTrack Module)

End of ship date range used to narrow search.

Syntax

• Swift
• Objective-C

public var shipDateEnd: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipDateEnd,setter=setShipDateEnd:) NSString* shipDateEnd;

- (NSString*)shipDateEnd;
- (void)setShipDateEnd :(NSString*)newShipDateEnd;

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.

ShipDateStart Property (FedExTrack Module)

Start of ship date range used to narrow search.

Syntax

• Swift
• Objective-C

public var shipDateStart: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipDateStart,setter=setShipDateStart:) NSString* shipDateStart;

- (NSString*)shipDateStart;
- (void)setShipDateStart :(NSString*)newShipDateStart;

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.

ShipperAccountNumber Property (FedExTrack Module)

Account number associated with shipment.

Syntax

• Swift
• Objective-C

public var shipperAccountNumber: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipperAccountNumber,setter=setShipperAccountNumber:) NSString* shipperAccountNumber;

- (NSString*)shipperAccountNumber;
- (void)setShipperAccountNumber :(NSString*)newShipperAccountNumber;

Default Value

""

Remarks

This indicates the account number associated with shipment (as opposed to the FedExAccountAccountNumber, 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 RecipientAddressCountryCode and RecipientAddressZipCode (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.

SSLAcceptServerCertEncoded Property (FedExTrack Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslAcceptServerCertEncoded: String {
  get {...}
  set {...}
}

public var sslAcceptServerCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncoded,setter=setSSLAcceptServerCertEncoded:) NSString* SSLAcceptServerCertEncoded;

- (NSString*)SSLAcceptServerCertEncoded;
- (void)setSSLAcceptServerCertEncoded :(NSString*)newSSLAcceptServerCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLAcceptServerCertEncodedB,setter=setSSLAcceptServerCertEncodedB:) NSData* SSLAcceptServerCertEncodedB;

- (NSData*)SSLAcceptServerCertEncodedB;
- (void)setSSLAcceptServerCertEncodedB :(NSData*)newSSLAcceptServerCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLAcceptServerCertEncodedB(sslAcceptServerCertEncoded: Data) throws
public func setSSLAcceptServerCertEncoded(sslAcceptServerCertEncoded: String) throws

SSLCertEncoded Property (FedExTrack Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

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 designations are 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., PKCS#12 certificate store).

SSLCertStorePassword Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (FedExTrack Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: FedextrackSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum FedextrackSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

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:

SSLCertSubject Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

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 as follows:

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (FedExTrack Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: FedextrackSSLProviders {
  get {...}
  set {...}
}

public enum FedextrackSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

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 the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (FedExTrack Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

public var sslServerCertEncoded: String {
  get {...}
}

public var sslServerCertEncodedB: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=SSLServerCertEncoded) NSString* SSLServerCertEncoded;

- (NSString*)SSLServerCertEncoded;

@property (nonatomic,readonly,assign,getter=SSLServerCertEncodedB) NSData* SSLServerCertEncodedB;

- (NSData*)SSLServerCertEncodedB;

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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLServerCertEncodedB(sslServerCertEncoded: Data) throws
public func setSSLServerCertEncoded(sslServerCertEncoded: String) throws

Timeout Property (FedExTrack Module)

A timeout for the module.

Syntax

• Swift
• Objective-C

public var timeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=timeout,setter=setTimeout:) int timeout;

- (int)timeout;
- (void)setTimeout :(int)newTimeout;

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 .

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.

TotalWeight Property (FedExTrack Module)

Total shipment weight.

Syntax

• Swift
• Objective-C

public var totalWeight: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=totalWeight) NSString* totalWeight;

- (NSString*)totalWeight;

Default Value

""

Remarks

This property is returned when the TrackShipment method is called.

This property is read-only.

TrackEvents Property (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public var trackEvents: Array<TrackDetail> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=trackEventCount) int trackEventCount;

- (int)trackEventCount;

- (NSString*)trackEventAddress1:(int)trackEventIdx;

- (NSString*)trackEventAddress2:(int)trackEventIdx;

- (NSString*)trackEventCity:(int)trackEventIdx;

- (NSString*)trackEventCountryCode:(int)trackEventIdx;

- (NSString*)trackEventDate:(int)trackEventIdx;

- (NSString*)trackEventException:(int)trackEventIdx;

- (NSString*)trackEventState:(int)trackEventIdx;

- (NSString*)trackEventStatus:(int)trackEventIdx;

- (NSString*)trackEventTime:(int)trackEventIdx;

- (NSString*)trackEventZipCode:(int)trackEventIdx;

Default Value

""

Remarks

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

Each tracking event has a , , , , , , , , and tied to it.

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

m_date = class.(0) m_time = class.(0) m_status = class.(0) m_city = class.(0) m_state = class.(0) m_country = class.(0)

This property is read-only.

Config Method (FedExTrack Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

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.

GetProofOfDelivery Method (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public func getProofOfDelivery(trackingNumber: String) throws -> Data

- (NSData*)getProofOfDelivery:(NSString*)trackingNumber;

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:

• FedExAccountAuthorizationToken (required)
• FedExAccountServer (optional)
• FedExAccountAccountNumber (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.

RequestEmailNotification Method (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public func requestEmailNotification(trackingNumber: String) throws -> Void

- (void)requestEmailNotification:(NSString*)trackingNumber;

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:

• FedExAccountAuthorizationToken (required)
• FedExAccountServer (optional)
• FedExAccountAccountNumber (required)
• ShipDateStart (required)
• ShipDateEnd (required)
• SenderContact (by specifying SenderContactFirstName, SenderContactLastName, and SenderContactEmail - 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 NotifyNotificationFlags property 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 NotifyNotificationFlags property for that recipient; or
• Delivery notification. In this case, the ntOnDelivery flag should be set in the NotifyNotificationFlags property 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 NotifyNotificationFlags 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.

Reset Method (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

SaveProofOfDelivery Method (FedExTrack Module)

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

Syntax

• Swift
• Objective-C

public func saveProofOfDelivery(trackingNumber: String, filename: String) throws -> Void

- (void)saveProofOfDelivery:(NSString*)trackingNumber :(NSString*)filename;

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:

• FedExAccountAuthorizationToken (required)
• FedExAccountServer (optional)
• FedExAccountAccountNumber (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.

TrackShipment Method (FedExTrack Module)

Returns tracking data for requested idValue of IdentifierType type.

Syntax

• Swift
• Objective-C

public func trackShipment(idValue: String) throws -> Void

- (void)trackShipment:(NSString*)idValue;

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:

• FedExAccountAuthorizationToken (required)
• FedExAccountServer (optional)
• FedExAccountAccountNumber (required)
• ShipDateStart (optional)
• ShipDateEnd (optional)
• ShipperAccountNumber (optional)
• RecipientAddressCountryCode (optional)
• RecipientAddressZipCode (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: TrackEventsAddress1, TrackEventsAddress2, TrackEventsCity, TrackEventsState, TrackEventsCountryCode, TrackEventsZipCode, TrackEventsDate, TrackEventsTime, TrackEventsStatus and TrackEventsException.

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 Event (FedExTrack Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

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

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

Syntax

• Swift
• Objective-C

func onNotification(message: String)

- (void)onNotification:(NSString*)message;

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

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication:(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

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

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus:(NSString*)message;

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.

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 properties contained by this type are listed below.

Fields

Constructors

public init()

ContactDetail Type

Represents the contact information.

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.

Fields

Constructors

public init()

public init(firstName: , lastName: , phone: )

public init(firstName: , lastName: , phone: , email: )

public init(firstName: , lastName: , phone: , email: , company: )

FedExAccount Type

Represents the details of a FedEx account.

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 properties contained by this type are listed below.

Fields

Constructors

public init()

Firewall Type

The firewall the component will connect through.

Remarks

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

Fields

Constructors

public init()

NotifyDetail Type

Represents a single recipient to be notified via email.

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.

Fields

Constructors

public init()

public init(notificationFlags: , email: , message: )

public init(notificationFlags: , email: )

public init(name: )

Proxy Type

The proxy the component will connect to.

Remarks

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

Fields

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

TrackDetail Type

Indicates the tracking details.

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.

Fields

Config Settings (FedExTrack Module)

FedExTrack Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

Socket Config Settings

Base Config Settings

Trappable Errors (FedExTrack Module)

FedExTrack Errors