UPSTrack Module

Properties   Methods   Events   Config Settings   Errors  

Provides up-to-the-minute status reports of shipments, domestic and international, from origin to delivery.

Syntax

DShippingSDK.Upstrack

Remarks

For a given UPS tracking or reference number, this tool identifies the package(s) and provides detailed information about each package, including the current shipping status and the time and location of each scan while in transit. Track class supports tracking by tracking number, shipment identification number, or reference number. Using this class, you can find out up-to-the-minute specific details on shipping status, including the time and location of each scan as the package moves toward its final destination. And, this tracking information can be displayed in a customized format.

This class provides several levels of information depending on the request:

• When tracking a package using a UPS tracking number as the request parameter, this class returns information such as current delivery status, including the time and location of the latest transit scan.
• When tracking a package using a reference number, this class returns information appropriate to the request. The request parameters are the reference number plus at least one of the following optional qualifiers: shipper number, pickup date range, destination postal code and/or destination country.

This class can return several kinds of initial responses:

• Multi-Piece summary - When multiple packages from a single shipment match the request, the delivered response contains the UPS tracking number, pickup date, delivery date and time (for delivery packages only), location where each package was left if the consignee was not available, UPS shipping service and total shipment weight.
• Package Detail - When a single package matches the request, the response contains the package weight, consignee city, state and country, the date, time and location of the latest scan while in transit, current delivery status and the name of the person who signed for the package.
• Package Progress - Lists the date, time, location, and status of each scan of the package during transit, from the point of origin to the current location.

You can request the multi-piece or package detail response as well as package progress information after you receive the initial response.

Multi-piece summary and package progress requests use the information in a package detail response to retrieve additional information about the package. For example, the class returns information regarding the shipment from a multi-piece summary request. It would also return the date, time, and status of every scan for the package from a package progress request.

When the TrackShipment method call of this class returns a response, it will either return a successful response document or an error document. An error may be returned at the top (response) level if there is a problem with the syntax of the request, or if a system error occurs.

In any of the above scenarios, if there is a problem with a specific identifier within the request, the response will raise an error that pertains to the specific identifier.

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

This class limits the data requested to ten (10) packages per transaction.

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.

Firewall Property (UPSTrack 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

IdentifierType Property (UPSTrack Module)

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

Syntax

• Swift
• Objective-C

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

public enum UpstrackIdentifierTypes: Int32 {
  case uitPackageTrackingNumber = 0
  case uitMasterTrackingNumber = 1
  case uitReferenceNumber = 2
  case uitShipmentBookmark = 3
}

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

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

Default Value

0

Remarks

This is required to be provided in a track request.

Possible values are as follows:

To limit the number of tracking replies for a specific reference, you can provide a date range (ShipDateStart and ShipDateEnd) in the request.

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.

Tracking by Tracking Number:

UPS uses tracking numbers to identify and track every package as it moves through the UPS system to its destination. You can use this tracking number to track, locate, and verify arrival of a package.

A successful query by tracking number returns the single package within a shipment identified by the tracking number. For example, if a shipment contained four packages, the query response would show a shipment containing the one package out of four with the associated tracking number.

Tracking numbers are available up to 18 months after delivery and UPS makes every effort to ensure that a tracking number uniquely identifies a package during this time period. However, it is possible that a tracking number may be reused within a shorter time period. If this occurs, a query by tracking number returns all packages matching the tracking number.

Tracking by Master Tracking Number:

The Master Tracking Number is the shipment tracking number and identifies that whole shipment.

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

Tracking by Reference Number:

The Reference Number identifies an individual package or the whole shipment (this must be alphanumeric). These are available up to 6 months after delivery.

The ability to track any UPS package by reference number gives you added flexibility and convenience. When you ship a package, you can assign a customized reference number that you use to coordinate with your billing or filing system. This reference number could be a purchase order number, job number, or a group of words identifying a shipment. You can assign a reference number to an individual package or to all packages in a shipment. A reference number contains any combination of letters and numbers up to 35 characters and is assigned by the customer when shipping data are uploaded electronically to UPS.

A successful query by reference number returns all of the packages within a shipment identified by the reference number. For example, if a shipment contained four packages, and two of the packages were tagged with the reference number "10 widgets", the query response would show a shipment containing those two packages. Since reference numbers are assigned by the customer, UPS cannot guarantee the uniqueness of a reference number across all packages shipped through the UPS system.

To resolve this ambiguity and to narrow down the search, the track request may contain any of the following optional qualifiers:

• Pickup date range via the ShipDateStart and ShipDateEnd; this way, you can narrow a search to the dates closer to a shipment. The default is 30 days before today's date.
• Shipper's UPS account number via the ShipperAccountNumber which distinguishes a shipment from other shipments.
• Destination postal and country code: via the RecipientAddressZipCode and RecipientAddressCountryCode.

Tracking by Candidate Bookmark:

During tracking by tracking numbers or reference numbers, it is possible that duplicate shipments will be found. If duplicate shipments are found, then a candidate summary with a corresponding bookmark for each of the shipments will be returned in the response (stored in the ShipmentBookmark. This value can be passed back to a separate track request to retrieve tracking information about the particular shipment of interest.

MasterTrackingNumber Property (UPSTrack Module)

UPS-assigned tracking number assigned to the whole shipment .

Syntax

• Swift
• Objective-C

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

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

- (NSString*)masterTrackingNumber;

Default Value

""

Remarks

If the shipment contains only one package (PackageCount = 1), the MasterTrackingNumber is the same as the first PackageTrackingNumber (where PackageIndex = 1). This property is returned in the server response for track requests other than tracking by Reference Number (i.e., IdentifierType is set to a value other than itReferenceNumber).

The MasterTrackingNumber uniquely identifies a shipment up to 18 months. However, it is possible that this number may be reused within a shorter time period. If this occurs, a query by Master Tracking Number returns all shipments (from the same ShipperAccountNumber) matching this number.

This is not available for freight shipments.

This property is read-only.

PackageCount Property (UPSTrack Module)

The number of packages returned for a given shipment id or reference number .

Syntax

• Swift
• Objective-C

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

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

- (int)packageCount;

Default Value

0

Remarks

When the idType is set to either 1 (Shipment Id) or 2 (Reference Number) when TrackShipment method is called, the PackageCount indicates the number of packages contained in the shipment being tracked.

When the idType is set to 0 (Package Tracking Number), then the PackageCount is set to 1 upon successful requests.

This property is read-only.

PackageIndex Property (UPSTrack Module)

The package index in a shipment returned for a given shipment id or reference number .

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 returned from the UPS Server after calling TrackShipment method where the idType is set to either 1 (Shipment Id) or 2 (Reference Number).

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.

PackageMessage Property (UPSTrack Module)

Message describing the shipping status in more details corresponding to the PackageIndex .

Syntax

• Swift
• Objective-C

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

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

- (NSString*)packageMessage;

Default Value

""

Remarks

This property may be returned in server response when the TrackShipment method is called. If the shipment contains multiple packages, the PackageMessage corresponds to each package being shipped as part of this shipment.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

PackageReferences Property (UPSTrack 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 csv string. A package can have 0 to many reference numbers assigned to it by the shipper when the shipping label was generated.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

PackageSignedBy Property (UPSTrack Module)

Name of the person signing for package delivery (if applicable) corresponding to the PackageIndex .

Syntax

• Swift
• Objective-C

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

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

- (NSString*)packageSignedBy;

Default Value

""

Remarks

To retrieve this property corresponding to each tracking event per package, the index should be set from 0 to TrackCount - 1 for each package (i.e., for each PackageIndex from 0 to PackageCount - 1).

This property is read-only.

PackageTrackingNumber Property (UPSTrack Module)

Package's tracking number corresponding to the PackageIndex .

Syntax

• Swift
• Objective-C

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

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

- (NSString*)packageTrackingNumber;

Default Value

""

Remarks

This is returned in the server's response when the TrackShipment method is called.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

PackageWeight Property (UPSTrack Module)

Package's weight corresponding to the PackageIndex .

Syntax

• Swift
• Objective-C

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

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

- (NSString*)packageWeight;

Default Value

""

Remarks

This property is returned by UPS Server when the TrackShipment method is called. If the shipment contains only one package (PackageCount=1), this is the same as PackageWeight. This is set to 0 for package type of letters.

To retrieve this property corresponding to each package, the PackageIndex should be set from 0 to PackageCount - 1.

This property is read-only.

Proxy Property (UPSTrack Module)

This property includes 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

RecipientAddress Property (UPSTrack Module)

Identifies the recipient's address.

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=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

ScheduledDeliveryDate Property (UPSTrack Module)

Date shipment was originally scheduled for delivery.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)scheduledDeliveryDate;

Default Value

""

Remarks

When the TrackShipment method is called, ScheduledDeliveryDate will be returned in the response (if available).

It is returned in this format: YYYY-MM-DD.

This property is read-only.

ScheduledDeliveryTime Property (UPSTrack Module)

Time shipment was originally scheduled for delivery.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)scheduledDeliveryTime;

Default Value

""

Remarks

When the TrackShipment method is called, ScheduledDeliveryTime will be returned in the response (if available).

It is returned in this format: hh:mm.

This property is read-only.

SenderAddress Property (UPSTrack Module)

Identifies the sender's address from which the shipment is originating.

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=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

ServiceTypeDescription Property (UPSTrack Module)

Description of a UPS service used to ship the package or shipment being tracked.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)serviceTypeDescription;

Default Value

""

Remarks

This property is populated when the TrackShipment method is called regardless the idType.

Possible values are UPS available services:

This property is read-only.

ShipDate Property (UPSTrack Module)

The date on which the package was tendered to UPS.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)shipDate;

Default Value

""

Remarks

This property is returned when the TrackShipment method is called.

This property is read-only.

ShipDateEnd Property (UPSTrack Module)

End of pickup date range used to narrow down the 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 is optional. However, this is considered in the request only if ShipDateStart is set as well. Otherwise, it will be disregarded.

Format: YYYYMMDD.

ShipDateStart Property (UPSTrack Module)

Start of pickup date range used to narrow down the 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 is optional. However, this is considered in the request only if ShipDateEnd is set as well. Otherwise, it will be disregarded.

Format to be entered in the request: YYYYMMDD.

ShipmentReference Property (UPSTrack Module)

Customer-defined number (that may or may not be unique) used to identify the whole shipment.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)shipmentReference;

Default Value

""

Remarks

When the TrackShipment method is called, and if issued at the time of shipping, this reference number (if any) will be returned in server's response.

This property is read-only.

ShipperAccountNumber Property (UPSTrack 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 UPSAccountAccountNumber, which is that of the party sending the request).

This can be provided in a track request to narrow down the search results. It can also be returned in the server response when the TrackShipment method is called.

SSLAcceptServerCertEncoded Property (UPSTrack 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 (UPSTrack 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 (UPSTrack 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 are designations of the most common User and Machine certificate stores in Windows:

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

SSLCertStorePassword Property (UPSTrack 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 (UPSTrack Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

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

public enum UpstrackSSLCertStoreTypes: 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 (UPSTrack 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 properites are set. When this property is set, a search is performed in the current certificate store certificate with matching subject.

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

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

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

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

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

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

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

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

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

public enum UpstrackSSLProviders: 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:

Additional Notes

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

Shipment's total 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 by UPS Server only if the shipment being tracked is a multi-piece shipment (PackageCount > 1) and not a single piece.

TotalWeight is set to 0 for shipment with packages of package type of letters.

This property is read-only.

TrackEvents Property (UPSTrack Module)

Collection of tracking details for all scanning events that occur during the shipping process (corresponding to the 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*)trackEventLocation:(int)trackEventIdx;

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

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

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

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

 

Default Value

""

Remarks

UPSAccount Property (UPSTrack Module)

Login information for UPS.

Syntax

• Swift
• Objective-C

public var upsAccount: UPSAccount {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=UPSAccessKey,setter=setUPSAccessKey:) NSString* UPSAccessKey;

- (NSString*)UPSAccessKey;
- (void)setUPSAccessKey :(NSString*)newUPSAccessKey;

@property (nonatomic,readwrite,assign,getter=UPSAccountNumber,setter=setUPSAccountNumber:) NSString* UPSAccountNumber;

- (NSString*)UPSAccountNumber;
- (void)setUPSAccountNumber :(NSString*)newUPSAccountNumber;

@property (nonatomic,readwrite,assign,getter=UPSPassword,setter=setUPSPassword:) NSString* UPSPassword;

- (NSString*)UPSPassword;
- (void)setUPSPassword :(NSString*)newUPSPassword;

@property (nonatomic,readwrite,assign,getter=UPSServer,setter=setUPSServer:) NSString* UPSServer;

- (NSString*)UPSServer;
- (void)setUPSServer :(NSString*)newUPSServer;

@property (nonatomic,readwrite,assign,getter=UPSUserId,setter=setUPSUserId:) NSString* UPSUserId;

- (NSString*)UPSUserId;
- (void)setUPSUserId :(NSString*)newUPSUserId;

 

Default Value

""

Remarks

Config Method (UPSTrack 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.

Reset Method (UPSTrack 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.

TrackShipment Method (UPSTrack 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, package reference etc.), while others apply to multiple packages or shipments (such as master tracking number, shipment reference, etc.) which they are part of. The idValue must be alphanumeric.

The following properties can be sent in the request:

• UPSAccountServer (required)
• UPSAccountAccessKey (required)
• UPSAccountPassword (required)
• UPSAccountUserId (required)
• UPSAccountAccountNumber (required)
• IdentifierType (required)
• ShipDateStart (optional)
• ShipDateEnd (optional)
• ShipperAccountNumber (optional)
• RecipientAddressCountryCode (optional)
• RecipientAddressZipCode (optional)

If UPS system does not locate any data for the requested idValue, an error message will be returned. The full server reply will be saved to RawResponse.

Upon successful response, the server will return tracking events for each package included in the shipment, and other values tied to that package. For example, if a shipment contained four packages, the query response would show all four packages.

The following properties may be populated upon method return:

• ServiceTypeDescription
• ShipDate
• ScheduledDeliveryDate
• ScheduledDeliveryTime
• MasterTrackingNumber
• ShipmentReference
• SenderAddress
• RecipientAddress
• ShipperAccountNumber
• Shipment weight information (TotalWeight, WeightUnit);
• Package(s) detailed information (PackageReferences, PackageTrackingNumber, PackageMessage, PackageWeight, PackageRescheduledDeliveryTime, PackageRescheduledDeliveryDate, PackageReturnAddress1, PackageReturnAddress2, PackageReturnCity, PackageReturnState, PackageReturnCountryCode, PackageReturnZipCode)
• Tracking details for each tracking event. Tracking details for each tracking event, which can be inspected via TrackEvents collection. This information consists of: TrackEventsLocation, TrackEventsAddress1, TrackEventsAddress2, TrackEventsCity, TrackEventsState, TrackEventsCountryCode, TrackEventsZipCode, TrackEventsDate, TrackEventsTime, and TrackEventsStatus. These are tied to each package included in the shipment for each PackageIndex from 0 to PackageCount - 1.

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

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

Error Event (UPSTrack 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 (UPSTrack 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 (UPSTrack 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

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

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

Remarks

The event is fired for informational and logging purposes only. Used to track 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()

Firewall Type

This is 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()

Proxy Type

This is 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

UPSAccount Type

Represents the details of a UPS account.

Remarks

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

Example: Setting the fields of an account UPSAccount account = new UPSAccount account.Server = "https://wwwcie.ups.com/"; account.AccessKey = "123451234512345"; account.AccountNumber = "12345"; account.Password = "my_password"; account.UserId = "my_username";

The properties contained by this type are listed below.

Fields

Constructors

public init()

Config Settings (UPSTrack Module)