UPSFreightShip Module

Properties   Methods   Events   Config Settings   Errors  

Provides UPS Freight Shipment service.

Syntax

DShippingSDK.Upsfreightship

Remarks

The UPSFreightShip class allows labels and documents to be generated for a freight shipment. To use the class, populate Documents to specify the type of documents requested. Specify the sender, recipient, commodity and UPS account information before calling GetShipmentDocuments. For instance:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)

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.

BillableWeight Property (UPSFreightShip Module)

Represents the billable weight associated with the shipment.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)billableWeight;

Default Value

""

Remarks

This property is read-only.

BOLID Property (UPSFreightShip Module)

The retrieval key for the stored BOL (Bill of Lading).

Syntax

• Swift
• Objective-C

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

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

- (NSString*)BOLID;

Default Value

""

Remarks

This property holds the retrieval key for the stored BOL (Bill of Lading) as returned by the server.

This property is read-only.

Charges Property (UPSFreightShip Module)

Collection of shipment charges.

Syntax

• Swift
• Objective-C

public var charges: Array<ChargeDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=chargeCount,setter=setChargeCount:) int chargeCount;

- (int)chargeCount;
- (void)setChargeCount :(int)newChargeCount;

- (NSString*)chargeType:(int)chargeIndex;
- (void)setChargeType:(int)chargeIndex :(NSString*)newChargeType;

- (NSString*)chargeDescription:(int)chargeIndex;
- (void)setChargeDescription:(int)chargeIndex :(NSString*)newChargeDescription;

- (NSString*)chargeValue:(int)chargeIndex;
- (void)setChargeValue:(int)chargeIndex :(NSString*)newChargeValue;

Default Value

""

Remarks

Freight shipments may include various charges. This collection holds information about each of the charges applied to this shipment.

CODPayorType Property (UPSFreightShip Module)

The type of payment that will be used for the COD payment.

Syntax

• Swift
• Objective-C

public var codPayorType: UpsfreightshipCODPayorTypes {
  get {...}
  set {...}
}

public enum UpsfreightshipCODPayorTypes: Int32 {
  case fcodptCollect = 0
  case fcodptPrepaid = 1
}

@property (nonatomic,readwrite,assign,getter=CODPayorType,setter=setCODPayorType:) int CODPayorType;

- (int)CODPayorType;
- (void)setCODPayorType :(int)newCODPayorType;

Default Value

0

Remarks

This property specifies the type of COD payment. Possible values are:

CODRemitToAddress Property (UPSFreightShip Module)

Specifies the contact address detail of the contact to whom to send COD funds. If not specified, sender address will be used.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=CODRemitToAddress1,setter=setCODRemitToAddress1:) NSString* CODRemitToAddress1;

- (NSString*)CODRemitToAddress1;
- (void)setCODRemitToAddress1 :(NSString*)newCODRemitToAddress1;

@property (nonatomic,readwrite,assign,getter=CODRemitToAddress2,setter=setCODRemitToAddress2:) NSString* CODRemitToAddress2;

- (NSString*)CODRemitToAddress2;
- (void)setCODRemitToAddress2 :(NSString*)newCODRemitToAddress2;

@property (nonatomic,readwrite,assign,getter=CODRemitToCity,setter=setCODRemitToCity:) NSString* CODRemitToCity;

- (NSString*)CODRemitToCity;
- (void)setCODRemitToCity :(NSString*)newCODRemitToCity;

@property (nonatomic,readwrite,assign,getter=CODRemitToState,setter=setCODRemitToState:) NSString* CODRemitToState;

- (NSString*)CODRemitToState;
- (void)setCODRemitToState :(NSString*)newCODRemitToState;

@property (nonatomic,readwrite,assign,getter=CODRemitToZipCode,setter=setCODRemitToZipCode:) NSString* CODRemitToZipCode;

- (NSString*)CODRemitToZipCode;
- (void)setCODRemitToZipCode :(NSString*)newCODRemitToZipCode;

 

Default Value

""

Remarks

CODRemitToContact Property (UPSFreightShip Module)

Specifies the contact detail of the contact to whom to send COD funds. If not specified, funds will be sent to the sender.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=CODRemitToCompany,setter=setCODRemitToCompany:) NSString* CODRemitToCompany;

- (NSString*)CODRemitToCompany;
- (void)setCODRemitToCompany :(NSString*)newCODRemitToCompany;

@property (nonatomic,readwrite,assign,getter=CODRemitToEmail,setter=setCODRemitToEmail:) NSString* CODRemitToEmail;

- (NSString*)CODRemitToEmail;
- (void)setCODRemitToEmail :(NSString*)newCODRemitToEmail;

@property (nonatomic,readwrite,assign,getter=CODRemitToFax,setter=setCODRemitToFax:) NSString* CODRemitToFax;

- (NSString*)CODRemitToFax;
- (void)setCODRemitToFax :(NSString*)newCODRemitToFax;

@property (nonatomic,readwrite,assign,getter=CODRemitToFirstName,setter=setCODRemitToFirstName:) NSString* CODRemitToFirstName;

- (NSString*)CODRemitToFirstName;
- (void)setCODRemitToFirstName :(NSString*)newCODRemitToFirstName;

@property (nonatomic,readwrite,assign,getter=CODRemitToLastName,setter=setCODRemitToLastName:) NSString* CODRemitToLastName;

- (NSString*)CODRemitToLastName;
- (void)setCODRemitToLastName :(NSString*)newCODRemitToLastName;

@property (nonatomic,readwrite,assign,getter=CODRemitToMiddleInitial,setter=setCODRemitToMiddleInitial:) NSString* CODRemitToMiddleInitial;

- (NSString*)CODRemitToMiddleInitial;
- (void)setCODRemitToMiddleInitial :(NSString*)newCODRemitToMiddleInitial;

@property (nonatomic,readwrite,assign,getter=CODRemitToPhone,setter=setCODRemitToPhone:) NSString* CODRemitToPhone;

- (NSString*)CODRemitToPhone;
- (void)setCODRemitToPhone :(NSString*)newCODRemitToPhone;

 

Default Value

""

Remarks

CODTotalAmount Property (UPSFreightShip Module)

The total amount of additional fees.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=CODTotalAmount,setter=setCODTotalAmount:) NSString* CODTotalAmount;

- (NSString*)CODTotalAmount;
- (void)setCODTotalAmount :(NSString*)newCODTotalAmount;

Default Value

""

Remarks

UPS Freight handles your payment collections upon delivery and sends the payment to you (if applicable) for an additional charge.

CODType Property (UPSFreightShip Module)

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

Syntax

• Swift
• Objective-C

public var codType: UpsfreightshipCODTypes {
  get {...}
  set {...}
}

public enum UpsfreightshipCODTypes: Int32 {
  case fcodtsCertifiedCheck = 0
  case fcodtsCash = 1
  case fcodtsCompanyCheck = 2
}

@property (nonatomic,readwrite,assign,getter=CODType,setter=setCODType:) int CODType;

- (int)CODType;
- (void)setCODType :(int)newCODType;

Default Value

0

Remarks

This property specifies the type of COD requested. Possible values are:

Commodities Property (UPSFreightShip Module)

Collection of commodity items of the shipment.

Syntax

• Swift
• Objective-C

public var commodities: Array<CommodityDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=commodityCount,setter=setCommodityCount:) int commodityCount;

- (int)commodityCount;
- (void)setCommodityCount :(int)newCommodityCount;

- (NSString*)commodityDescription:(int)commodityIndex;
- (void)setCommodityDescription:(int)commodityIndex :(NSString*)newCommodityDescription;

- (NSString*)commodityFreightClass:(int)commodityIndex;
- (void)setCommodityFreightClass:(int)commodityIndex :(NSString*)newCommodityFreightClass;

- (BOOL)commodityFreightIsHazardous:(int)commodityIndex;
- (void)setCommodityFreightIsHazardous:(int)commodityIndex :(BOOL)newCommodityFreightIsHazardous;

- (NSString*)commodityFreightNMFC:(int)commodityIndex;
- (void)setCommodityFreightNMFC:(int)commodityIndex :(NSString*)newCommodityFreightNMFC;

- (NSString*)commodityFreightNMFCSub:(int)commodityIndex;
- (void)setCommodityFreightNMFCSub:(int)commodityIndex :(NSString*)newCommodityFreightNMFCSub;

- (int)commodityFreightPackagingType:(int)commodityIndex;
- (void)setCommodityFreightPackagingType:(int)commodityIndex :(int)newCommodityFreightPackagingType;

- (int)commodityNumberOfPieces:(int)commodityIndex;
- (void)setCommodityNumberOfPieces:(int)commodityIndex :(int)newCommodityNumberOfPieces;

- (NSString*)commodityValue:(int)commodityIndex;
- (void)setCommodityValue:(int)commodityIndex :(NSString*)newCommodityValue;

- (NSString*)commodityWeight:(int)commodityIndex;
- (void)setCommodityWeight:(int)commodityIndex :(NSString*)newCommodityWeight;

Default Value

""

Remarks

This collection contains details of the commodities associated with the shipment. At least one commodity must be added for international shipments.

For each idx = 0 to CommodityCount - 1, this must be set to an instance of the CommodityDetail type, which will contain specific information about a commodity item contained in the shipment. See the CommodityDetail type for more information.

The following properties are applicable for each commodity item:

Note: The WeightUnit configuration setting may be set to specify KGS instead of LBS for the weight unit.

For instance, to add a commodity: = 1500 = "92.5" = "116030" = "1" = 1 = "Test Items"

DimensionalWeight Property (UPSFreightShip Module)

Represents the dimensional weight associated with the shipment.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)dimensionalWeight;

Default Value

""

Remarks

The dimensional weight as calculated by the server and returned in the response.

This property is read-only.

Documents Property (UPSFreightShip Module)

Collection of information about each of the requested documents.

Syntax

• Swift
• Objective-C

public var documents: Array<DocumentInfo> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=documentCount,setter=setDocumentCount:) int documentCount;

- (int)documentCount;
- (void)setDocumentCount :(int)newDocumentCount;

- (int)documentType:(int)documentIndex;
- (void)setDocumentType:(int)documentIndex :(int)newDocumentType;

- (NSString*)documentFile:(int)documentIndex;

- (NSData*)documentFileB:(int)documentIndex;
- (NSString*)documentFileName:(int)documentIndex;
- (void)setDocumentFileName:(int)documentIndex :(NSString*)newDocumentFileName;

- (int)documentLabelsPerPage:(int)documentIndex;
- (void)setDocumentLabelsPerPage:(int)documentIndex :(int)newDocumentLabelsPerPage;

- (int)documentPrintFormat:(int)documentIndex;
- (void)setDocumentPrintFormat:(int)documentIndex :(int)newDocumentPrintFormat;

- (int)documentPrintSize:(int)documentIndex;
- (void)setDocumentPrintSize:(int)documentIndex :(int)newDocumentPrintSize;

Default Value

""

Remarks

This collection contains information about the requested documents. Populate this collection to request specific documents such as labels, packing lists, etc. This must be set before calling GetShipmentDocuments. For example:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)

Firewall Property (UPSFreightShip 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.

HandlingUnit Property (UPSFreightShip Module)

Describe the Handling Units (Movable Pieces) in this Shipment.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=handlingUnit,setter=setHandlingUnit:) NSString* handlingUnit;

- (NSString*)handlingUnit;
- (void)setHandlingUnit :(NSString*)newHandlingUnit;

Default Value

""

Remarks

HazMatContactName Property (UPSFreightShip Module)

Identifies the contact name for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=hazMatContactName,setter=setHazMatContactName:) NSString* hazMatContactName;

- (NSString*)hazMatContactName;
- (void)setHazMatContactName :(NSString*)newHazMatContactName;

Default Value

""

Remarks

This property hold the name of the person who can be contacted with questions regarding the dangerous goods in the shipment. This must be set if the shipment contains hazardous materials and CommoditiesFreightIsHazardous is true.

HazMatContactPhone Property (UPSFreightShip Module)

Identifies the contact phone for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=hazMatContactPhone,setter=setHazMatContactPhone:) NSString* hazMatContactPhone;

- (NSString*)hazMatContactPhone;
- (void)setHazMatContactPhone :(NSString*)newHazMatContactPhone;

Default Value

""

Remarks

This property hold the phone number of the person who can be contacted with questions regarding the dangerous goods in the shipment. This must be set if the shipment contains hazardous materials and CommoditiesFreightIsHazardous is true.

Notify Property (UPSFreightShip Module)

Collection of e-mail notifications to be sent.

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;

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

Default Value

""

Remarks

The Notify is optional to be provided in a ship request. This should be set only if the shipper wants to send e-mail notifications on shipment status, exceptions, and/or delivery status. Up to 3 notification requests can be made within a ship request.

For each idx = 0 to NotifyCount - 1 (where NotifyCount<=2), this must be set to an instance of the NotifyDetail type, which will contain specific information about the notification to be e-mailed. See the NotifyDetail type for more information.

Each notification has a: (required), (required), (optional) tied to it.

For instance, if only one notification is requested to be sent:

class.(0) = "test@test.com" class.(0) = 0x00000001 // On Shipment class.(0) = "test"

OverSeasLeg Property (UPSFreightShip Module)

Identifies the OverSeasLeg detail. Required when origin or destination is Hawaii, Alaska, and Puerto Rico.

Syntax

• Swift
• Objective-C

public var overSeasLeg: OverSeasLegDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overSeasLegHeight,setter=setOverSeasLegHeight:) int overSeasLegHeight;

- (int)overSeasLegHeight;
- (void)setOverSeasLegHeight :(int)newOverSeasLegHeight;

@property (nonatomic,readwrite,assign,getter=overSeasLegLength,setter=setOverSeasLegLength:) int overSeasLegLength;

- (int)overSeasLegLength;
- (void)setOverSeasLegLength :(int)newOverSeasLegLength;

@property (nonatomic,readwrite,assign,getter=overSeasLegPricePerCubicFoot,setter=setOverSeasLegPricePerCubicFoot:) NSString* overSeasLegPricePerCubicFoot;

- (NSString*)overSeasLegPricePerCubicFoot;
- (void)setOverSeasLegPricePerCubicFoot :(NSString*)newOverSeasLegPricePerCubicFoot;

@property (nonatomic,readwrite,assign,getter=overSeasLegPricePerCWT,setter=setOverSeasLegPricePerCWT:) NSString* overSeasLegPricePerCWT;

- (NSString*)overSeasLegPricePerCWT;
- (void)setOverSeasLegPricePerCWT :(NSString*)newOverSeasLegPricePerCWT;

@property (nonatomic,readwrite,assign,getter=overSeasLegTotalCubicFeet,setter=setOverSeasLegTotalCubicFeet:) NSString* overSeasLegTotalCubicFeet;

- (NSString*)overSeasLegTotalCubicFeet;
- (void)setOverSeasLegTotalCubicFeet :(NSString*)newOverSeasLegTotalCubicFeet;

@property (nonatomic,readwrite,assign,getter=overSeasLegWidth,setter=setOverSeasLegWidth:) int overSeasLegWidth;

- (int)overSeasLegWidth;
- (void)setOverSeasLegWidth :(int)newOverSeasLegWidth;

 

Default Value

""

Remarks

This must be set to an instance of the OverSeasLegDetail type, which will contain the ShipmentWidth, ShipmentLength and ShipmentHeight etc. See the OverSeasLegDetail type for more information.

Payor Property (UPSFreightShip Module)

Identifies the payor of transportation charges for the shipment.

Syntax

• Swift
• Objective-C

public var payor: PayorDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=payorAddress1,setter=setPayorAddress1:) NSString* payorAddress1;

- (NSString*)payorAddress1;
- (void)setPayorAddress1 :(NSString*)newPayorAddress1;

@property (nonatomic,readwrite,assign,getter=payorAddress2,setter=setPayorAddress2:) NSString* payorAddress2;

- (NSString*)payorAddress2;
- (void)setPayorAddress2 :(NSString*)newPayorAddress2;

@property (nonatomic,readwrite,assign,getter=payorCity,setter=setPayorCity:) NSString* payorCity;

- (NSString*)payorCity;
- (void)setPayorCity :(NSString*)newPayorCity;

@property (nonatomic,readwrite,assign,getter=payorCountryCode,setter=setPayorCountryCode:) NSString* payorCountryCode;

- (NSString*)payorCountryCode;
- (void)setPayorCountryCode :(NSString*)newPayorCountryCode;

@property (nonatomic,readwrite,assign,getter=payorName,setter=setPayorName:) NSString* payorName;

- (NSString*)payorName;
- (void)setPayorName :(NSString*)newPayorName;

@property (nonatomic,readwrite,assign,getter=payorType,setter=setPayorType:) int payorType;

- (int)payorType;
- (void)setPayorType :(int)newPayorType;

@property (nonatomic,readwrite,assign,getter=payorState,setter=setPayorState:) NSString* payorState;

- (NSString*)payorState;
- (void)setPayorState :(NSString*)newPayorState;

@property (nonatomic,readwrite,assign,getter=payorZipCode,setter=setPayorZipCode:) NSString* payorZipCode;

- (NSString*)payorZipCode;
- (void)setPayorZipCode :(NSString*)newPayorZipCode;

 

Default Value

""

Remarks

The Payor is required to be provided in a ship request. This must be set to an instance of the PayorDetail type, which will contain the payor details. See the PayorDetail type for more information.

PickupRequester Property (UPSFreightShip Module)

Identifies the pickup requester's contact info. Used with the EarliestPickupTime and LatestPickupTime configuration settings.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=pickupRequesterCompany,setter=setPickupRequesterCompany:) NSString* pickupRequesterCompany;

- (NSString*)pickupRequesterCompany;
- (void)setPickupRequesterCompany :(NSString*)newPickupRequesterCompany;

@property (nonatomic,readwrite,assign,getter=pickupRequesterEmail,setter=setPickupRequesterEmail:) NSString* pickupRequesterEmail;

- (NSString*)pickupRequesterEmail;
- (void)setPickupRequesterEmail :(NSString*)newPickupRequesterEmail;

@property (nonatomic,readwrite,assign,getter=pickupRequesterFax,setter=setPickupRequesterFax:) NSString* pickupRequesterFax;

- (NSString*)pickupRequesterFax;
- (void)setPickupRequesterFax :(NSString*)newPickupRequesterFax;

@property (nonatomic,readwrite,assign,getter=pickupRequesterFirstName,setter=setPickupRequesterFirstName:) NSString* pickupRequesterFirstName;

- (NSString*)pickupRequesterFirstName;
- (void)setPickupRequesterFirstName :(NSString*)newPickupRequesterFirstName;

@property (nonatomic,readwrite,assign,getter=pickupRequesterLastName,setter=setPickupRequesterLastName:) NSString* pickupRequesterLastName;

- (NSString*)pickupRequesterLastName;
- (void)setPickupRequesterLastName :(NSString*)newPickupRequesterLastName;

@property (nonatomic,readwrite,assign,getter=pickupRequesterMiddleInitial,setter=setPickupRequesterMiddleInitial:) NSString* pickupRequesterMiddleInitial;

- (NSString*)pickupRequesterMiddleInitial;
- (void)setPickupRequesterMiddleInitial :(NSString*)newPickupRequesterMiddleInitial;

@property (nonatomic,readwrite,assign,getter=pickupRequesterPhone,setter=setPickupRequesterPhone:) NSString* pickupRequesterPhone;

- (NSString*)pickupRequesterPhone;
- (void)setPickupRequesterPhone :(NSString*)newPickupRequesterPhone;

 

Default Value

""

Remarks

The PickupRequester is required only if a pickup is requested.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the pickup requester. See the ContactDetail type for more information.

Proxy Property (UPSFreightShip 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.

RecipientAddress Property (UPSFreightShip 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=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

The RecipientAddress is required to be provided in a ship request.

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

RecipientContact Property (UPSFreightShip Module)

Identifies the recipient's contact info.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=recipientCompany,setter=setRecipientCompany:) NSString* recipientCompany;

- (NSString*)recipientCompany;
- (void)setRecipientCompany :(NSString*)newRecipientCompany;

@property (nonatomic,readwrite,assign,getter=recipientEmail,setter=setRecipientEmail:) NSString* recipientEmail;

- (NSString*)recipientEmail;
- (void)setRecipientEmail :(NSString*)newRecipientEmail;

@property (nonatomic,readwrite,assign,getter=recipientFax,setter=setRecipientFax:) NSString* recipientFax;

- (NSString*)recipientFax;
- (void)setRecipientFax :(NSString*)newRecipientFax;

@property (nonatomic,readwrite,assign,getter=recipientFirstName,setter=setRecipientFirstName:) NSString* recipientFirstName;

- (NSString*)recipientFirstName;
- (void)setRecipientFirstName :(NSString*)newRecipientFirstName;

@property (nonatomic,readwrite,assign,getter=recipientLastName,setter=setRecipientLastName:) NSString* recipientLastName;

- (NSString*)recipientLastName;
- (void)setRecipientLastName :(NSString*)newRecipientLastName;

@property (nonatomic,readwrite,assign,getter=recipientMiddleInitial,setter=setRecipientMiddleInitial:) NSString* recipientMiddleInitial;

- (NSString*)recipientMiddleInitial;
- (void)setRecipientMiddleInitial :(NSString*)newRecipientMiddleInitial;

@property (nonatomic,readwrite,assign,getter=recipientPhone,setter=setRecipientPhone:) NSString* recipientPhone;

- (NSString*)recipientPhone;
- (void)setRecipientPhone :(NSString*)newRecipientPhone;

 

Default Value

""

Remarks

The RecipientContact is required to be provided in a ship request.

The RecipientContactCompany is required to be provided in the request. In domestic shipments: the RecipientContactFirstName and RecipientContactLastName are required when using UPS Next Day Air Early A.M. service. In international shipments: the RecipientContactFirstName and RecipientContactLastName are required when the RecipientAddressCountryCode is different than SenderAddressCountryCode, and if Commercial Invoice international form is requested.

The RecipientContact must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact recipient. See the ContactDetail type for more information.

References Property (UPSFreightShip Module)

Collection of reference numbers for the shipment.

Syntax

• Swift
• Objective-C

public var references: Array<ReferenceDetail> {
  get {...}
}

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

- (int)referenceCount;

- (NSString*)referenceNumber:(int)referenceIndex;

- (int)referenceNumberOfCartons:(int)referenceIndex;

- (int)referenceType:(int)referenceIndex;

- (NSString*)referenceWeight:(int)referenceIndex;

Default Value

""

Remarks

This collection holds the reference numbers that identify the shipment. See for a complete list of possible types of reference numbers returned.

SenderAddress Property (UPSFreightShip Module)

Identifies the sender's address.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=senderAddress1,setter=setSenderAddress1:) NSString* senderAddress1;

- (NSString*)senderAddress1;
- (void)setSenderAddress1 :(NSString*)newSenderAddress1;

@property (nonatomic,readwrite,assign,getter=senderAddress2,setter=setSenderAddress2:) NSString* senderAddress2;

- (NSString*)senderAddress2;
- (void)setSenderAddress2 :(NSString*)newSenderAddress2;

@property (nonatomic,readwrite,assign,getter=senderCity,setter=setSenderCity:) NSString* senderCity;

- (NSString*)senderCity;
- (void)setSenderCity :(NSString*)newSenderCity;

@property (nonatomic,readwrite,assign,getter=senderCountryCode,setter=setSenderCountryCode:) NSString* senderCountryCode;

- (NSString*)senderCountryCode;
- (void)setSenderCountryCode :(NSString*)newSenderCountryCode;

@property (nonatomic,readwrite,assign,getter=senderState,setter=setSenderState:) NSString* senderState;

- (NSString*)senderState;
- (void)setSenderState :(NSString*)newSenderState;

@property (nonatomic,readwrite,assign,getter=senderZipCode,setter=setSenderZipCode:) NSString* senderZipCode;

- (NSString*)senderZipCode;
- (void)setSenderZipCode :(NSString*)newSenderZipCode;

 

Default Value

""

Remarks

The SenderAddress is required to be provided in a ship request when the GetShipmentLabels method is called.

This must be set to an instance of the AddressDetail type, which will contain shipper's address details. See the AddressDetail type for more information.

SenderContact Property (UPSFreightShip Module)

Identifies the sender's contact info.

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 a ship request, when the GetShipmentLabels method is called.

This must be set to an instance of the ContactDetail type, which will contain specific contact information about the point-of-contact sender. See the ContactDetail type for more information.

ServiceType Property (UPSFreightShip Module)

The service selected for the shipment.

Syntax

• Swift
• Objective-C

public var serviceType: UpsfreightshipServiceTypes {
  get {...}
  set {...}
}

public enum UpsfreightshipServiceTypes: Int32 {
  case stUPSFreight = 0
  case stUPSFreightGuaranteed = 1
}

@property (nonatomic,readwrite,assign,getter=serviceType,setter=setServiceType:) int serviceType;

- (int)serviceType;
- (void)setServiceType :(int)newServiceType;

Default Value

0

Remarks

Specifies the service to be used for the shipment.

Valid values for UPS Freight are:

ShipmentNumber Property (UPSFreightShip Module)

The shipment number assigned to the shipment.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)shipmentNumber;

Default Value

""

Remarks

This property contains a 9 character shipment number returned in the response.

This property is read-only.

SSLAcceptServerCertEncoded Property (UPSFreightShip 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 (UPSFreightShip 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 (UPSFreightShip 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 (UPSFreightShip 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 (UPSFreightShip Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

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

public enum UpsfreightshipSSLCertStoreTypes: 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 (UPSFreightShip 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 (UPSFreightShip Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

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

public enum UpsfreightshipSSLProviders: 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 (UPSFreightShip 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 (UPSFreightShip 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.

TotalCharge Property (UPSFreightShip Module)

Represents the total shipment charge.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)totalCharge;

Default Value

""

Remarks

This property holds the total charge associated with the shipment. The value is represented in dollars and cents with two decimal places. For instance "1500.25".

This property is read-only.

UPSAccount Property (UPSFreightShip Module)

Login information for UPS.

Syntax

• Swift
• Objective-C

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

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

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

@property (nonatomic,readwrite,assign,getter=UPSAuthorizationToken,setter=setUPSAuthorizationToken:) NSString* UPSAuthorizationToken;

- (NSString*)UPSAuthorizationToken;
- (void)setUPSAuthorizationToken :(NSString*)newUPSAuthorizationToken;

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

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

 

Default Value

""

Remarks

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

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

GetShipmentDocuments Method (UPSFreightShip Module)

Generates a shipping label using one of domestic UPS services.

Syntax

• Swift
• Objective-C

public func getShipmentDocuments() throws -> Void

- (void)getShipmentDocuments;

Remarks

The following properties must be set before calling this method:

• UPSAccountServer (required)
• UPSAccountAuthorizationToken (required)
• UPSAccountAccountNumber (required)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• DocumentsFileName
• DocumentsLabelsPerPage
• DocumentsPrintFormat
• DocumentsPrintSize
• DocumentsDocumentType (required)
• CommoditiesDescription (required)
• CommoditiesFreightClass (required for ground shipments)
• CommoditiesFreightIsHazardous
• CommoditiesFreightNMFC
• CommoditiesFreightNMFCSub
• CommoditiesNumberOfPieces (required)
• CommoditiesFreightPackagingType (required)
• CommoditiesValue (required)
• CommoditiesWeight (required)
• WeightUnit (required; defaults to LBS)

Upon successful response, the following properties will be populated:

• BOLID
• ShipmentNumber
• BillableWeight
• ChargesChargeType
• ChargesDescription
• ChargesValue
• TotalCharge

Code example:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)

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

Error Event (UPSFreightShip 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 (UPSFreightShip 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 (UPSFreightShip 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 (UPSFreightShip 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()

ChargeDetail Type

Represents a shipment charge returned on a successful response.

Remarks

Fields

Constructors

public init()

CommodityDetail Type

Represents a single commodity line item.

Remarks

This type contains specific information about a commodity line item included in the shipment. It is used in the international shipping components when either the GetPackageLabel or GetShipmentLabels method is called. For UPS, it is applicable if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.

Example: Setting the fields for a commodity line item CommodityDetail commodity = new CommodityDetail(); commodity.Description = "Computer software" commodity.Manufacturer = "US" commodity.Weight = "1.0" commodity.QuantityUnit = "EA" commodity.UnitPrice = "99.99" commodity.HarmonizedCode = "9031.80.90"

Note: The following fields are applicable to UPS Freight services.

The fields contained by this type are listed below.

Fields

Constructors

public init()

public init(description: , manufacturer: , harmonizedCode: , scheduleBCode: , weight: , quantity: , quantityUnit: , unitPrice: , numberOfPieces: )

public init(description: , manufacturer: , harmonizedCode: , scheduleBCode: , weight: , quantity: , quantityUnit: , unitPrice: )

public init(description: , manufacturer: , harmonizedCode: , scheduleBCode: , quantity: , quantityUnit: , unitPrice: )

public init(description: , manufacturer: , harmonizedCode: , quantity: , quantityUnit: , unitPrice: )

public init(description: , manufacturer: , weight: )

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

DocumentInfo Type

Specifies the information of the requested document.

Remarks

This type specifies the information of the document to be requested. This include the type of document, the printing options, and the location on disk where the file will be written. This must be set before calling GetShipmentDocuments. For example:

component.UPSAccount.Server = "https://wwwcie.ups.com/api/freight/" component.UPSAuthorizationToken = "Bearer token..." component.UPSAccountNumber = "000000" component.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)

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

OverSeasLegDetail Type

Represents the detail information of the OverSeasLeg.

Remarks

Fields

Constructors

public init()

PayorDetail Type

Represents the payor details responsible for payment.

Remarks

This type contains data of the responsible party for payment of shipping charges, or duties and taxes. This is used in a ship request.

Example: Setting the fields PayorDetail payor = new PayorDetail payor.Type = PT_RECIPIENT payor.AccountNumber = "123456789" payor.CountryCode = "US"

The fields contained by this type are listed below.

Fields

Constructors

public init()

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

ReferenceDetail Type

Represents a reference for the shipment.

Remarks

Fields

Constructors

public init()

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.AuthorizationToken = "Bearer token..." account.Server = "https://wwwcie.ups.com/api/"; account.AccountNumber = "12345";

The properties contained by this type are listed below.

Fields

Constructors

public init()

Config Settings (UPSFreightShip Module)

UPSFreightShip Config Settings