UPSShipIntl Module

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a UPS shipping label for any of UPS international services complete with addresses and barcode, cancel shipments.

Syntax

DShippingSDK.Upsshipintl

Remarks

Generating a shipping label can be done by calling the GetShipmentLabels method. You will have to specify the package information, UPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery), and any other specific information on international shipments (such as Commercial Invoice, international forms required by Customs, etc.). It also supports many valued added services for shipments, including collect on delivery (COD), declared value, delivery confirmation, and automatic notification of delivery status.

This class also allows you to delete packages included in the daily shipping log that have not already been tendered to UPS. This can be done by calling CancelShipment or CancelPackage, where the MasterTrackingNumber parameter identifies the shipment.

To use this class, you must have a UPS UPSAccountAccountNumber. You should also have already obtained a "Client ID" and "Client Secret" uniquely assigned to your account by UPS after registration for UPS OnLine Tools.

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.

AccountAddress Property (UPSShipIntl Module)

Identifies the UPS AccountNumber holder's address, if different from the sender's address.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=accountAddress1,setter=setAccountAddress1:) NSString* accountAddress1;

- (NSString*)accountAddress1;
- (void)setAccountAddress1 :(NSString*)newAccountAddress1;

@property (nonatomic,readwrite,assign,getter=accountAddress2,setter=setAccountAddress2:) NSString* accountAddress2;

- (NSString*)accountAddress2;
- (void)setAccountAddress2 :(NSString*)newAccountAddress2;

@property (nonatomic,readwrite,assign,getter=accountCity,setter=setAccountCity:) NSString* accountCity;

- (NSString*)accountCity;
- (void)setAccountCity :(NSString*)newAccountCity;

@property (nonatomic,readwrite,assign,getter=accountCountryCode,setter=setAccountCountryCode:) NSString* accountCountryCode;

- (NSString*)accountCountryCode;
- (void)setAccountCountryCode :(NSString*)newAccountCountryCode;

@property (nonatomic,readwrite,assign,getter=accountState,setter=setAccountState:) NSString* accountState;

- (NSString*)accountState;
- (void)setAccountState :(NSString*)newAccountState;

@property (nonatomic,readwrite,assign,getter=accountZipCode,setter=setAccountZipCode:) NSString* accountZipCode;

- (NSString*)accountZipCode;
- (void)setAccountZipCode :(NSString*)newAccountZipCode;

 

Default Value

""

Remarks

The AccountAddress is required to be provided in a ship request only if the SenderAddress is different from the billing address of the UPSAccountAccountNumber. Otherwise, it defaults to SenderAddress. For international shipments, even when account address is different from sender's address, the AccountAddressCountryCode should be the same as SenderAddressCountryCode.

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

AccountContact Property (UPSShipIntl Module)

Identifies the UPS AccountNumber holder's contact info if different from SenderContact .

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=accountCompany,setter=setAccountCompany:) NSString* accountCompany;

- (NSString*)accountCompany;
- (void)setAccountCompany :(NSString*)newAccountCompany;

@property (nonatomic,readwrite,assign,getter=accountEmail,setter=setAccountEmail:) NSString* accountEmail;

- (NSString*)accountEmail;
- (void)setAccountEmail :(NSString*)newAccountEmail;

@property (nonatomic,readwrite,assign,getter=accountFax,setter=setAccountFax:) NSString* accountFax;

- (NSString*)accountFax;
- (void)setAccountFax :(NSString*)newAccountFax;

@property (nonatomic,readwrite,assign,getter=accountFirstName,setter=setAccountFirstName:) NSString* accountFirstName;

- (NSString*)accountFirstName;
- (void)setAccountFirstName :(NSString*)newAccountFirstName;

@property (nonatomic,readwrite,assign,getter=accountLastName,setter=setAccountLastName:) NSString* accountLastName;

- (NSString*)accountLastName;
- (void)setAccountLastName :(NSString*)newAccountLastName;

@property (nonatomic,readwrite,assign,getter=accountMiddleInitial,setter=setAccountMiddleInitial:) NSString* accountMiddleInitial;

- (NSString*)accountMiddleInitial;
- (void)setAccountMiddleInitial :(NSString*)newAccountMiddleInitial;

@property (nonatomic,readwrite,assign,getter=accountPhone,setter=setAccountPhone:) NSString* accountPhone;

- (NSString*)accountPhone;
- (void)setAccountPhone :(NSString*)newAccountPhone;

 

Default Value

""

Remarks

If different from SenderContact, the AccountContact is required to be provided in a ship request. Otherwise, it defaults to SenderContact.

If the RecipientAddressCountryCode is international, or if Commercial Invoice and other International forms are requested, the AccountContactFirstName and AccountContactLastName are required to be provided in the request.

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

CODReport Property (UPSShipIntl Module)

Image of a COD Turn In Page.

Syntax

• Swift
• Objective-C

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

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

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

- (NSString*)CODReport;

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

- (NSData*)CODReportB;

Default Value

""

Remarks

This applies only to shipments within the European Union (EU) countries. It is the decoded binary image file of the COD report, stored in memory upon successful ship response. The report is generated in HTML format and it will automatically be saved to disk in the file designated by CODReportFile (if this is set to a valid path and filename).

This property is read-only.

CODReportFile Property (UPSShipIntl Module)

Filename and location to save the CODReport to.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=CODReportFile,setter=setCODReportFile:) NSString* CODReportFile;

- (NSString*)CODReportFile;
- (void)setCODReportFile :(NSString*)newCODReportFile;

Default Value

""

Remarks

This applies only to shipments within the European Union (EU) countries. When applicable and the CODReportFile is set to a valid path and filename, the contents of the CODReport are written to disk upon successful response.

This has to have .html extension.

CODTotalAmount Property (UPSShipIntl Module)

The total amount to be collected on shipment level.

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

This indicates customer's input COD amount (prior to any accumulations: total collection amount minus transportation charges).

For MPS COD shipments (when Packages is greater than 1), the COD amount must be included on each package that uses COD service by setting the PackagesCODAmount.

Format: Two explicit decimals (e.g.5.00).

CODType Property (UPSShipIntl Module)

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

Syntax

• Swift
• Objective-C

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

public enum UpsshipintlCODTypes: Int32 {
  case codtsCash = 0
  case codtsCheck = 1
}

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

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

Default Value

0

Remarks

This property identifies the type of funds UPS should collect upon shipment delivery. It is required to be provided in the request only if COD is requested (i.e., CODTotalAmount is set to a value other than "0.00").

Valid values are:

Note: COD special service is not valid for return service movements.

CommercialInvoice Property (UPSShipIntl Module)

Contains specific details on Commercial Invoice (when this form is requested).

Syntax

• Swift
• Objective-C

public var commercialInvoice: CommercialInvoiceDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=commercialInvoiceComments,setter=setCommercialInvoiceComments:) NSString* commercialInvoiceComments;

- (NSString*)commercialInvoiceComments;
- (void)setCommercialInvoiceComments :(NSString*)newCommercialInvoiceComments;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceDate,setter=setCommercialInvoiceDate:) NSString* commercialInvoiceDate;

- (NSString*)commercialInvoiceDate;
- (void)setCommercialInvoiceDate :(NSString*)newCommercialInvoiceDate;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceFreightCharge,setter=setCommercialInvoiceFreightCharge:) NSString* commercialInvoiceFreightCharge;

- (NSString*)commercialInvoiceFreightCharge;
- (void)setCommercialInvoiceFreightCharge :(NSString*)newCommercialInvoiceFreightCharge;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceInsurance,setter=setCommercialInvoiceInsurance:) NSString* commercialInvoiceInsurance;

- (NSString*)commercialInvoiceInsurance;
- (void)setCommercialInvoiceInsurance :(NSString*)newCommercialInvoiceInsurance;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceNumber,setter=setCommercialInvoiceNumber:) NSString* commercialInvoiceNumber;

- (NSString*)commercialInvoiceNumber;
- (void)setCommercialInvoiceNumber :(NSString*)newCommercialInvoiceNumber;

@property (nonatomic,readwrite,assign,getter=commercialInvoicePurpose,setter=setCommercialInvoicePurpose:) int commercialInvoicePurpose;

- (int)commercialInvoicePurpose;
- (void)setCommercialInvoicePurpose :(int)newCommercialInvoicePurpose;

@property (nonatomic,readwrite,assign,getter=commercialInvoiceTerms,setter=setCommercialInvoiceTerms:) int commercialInvoiceTerms;

- (int)commercialInvoiceTerms;
- (void)setCommercialInvoiceTerms :(int)newCommercialInvoiceTerms;

 

Default Value

""

Remarks

This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if Commercial Invoice international form is requested (i.e., one of the FormTypes is set to Invoice).

This must be set to an instance of the CommercialInvoiceDetail type, which will contain specific information about the Commercial Invoice (CI) that is requested to associate an international shipment. See the CommercialInvoiceDetail type for more information.

Commodities Property (UPSShipIntl Module)

Collection of commodity line items.

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)commodityIdx;
- (void)setCommodityDescription:(int)commodityIdx :(NSString*)newCommodityDescription;

- (int)commodityExportType:(int)commodityIdx;
- (void)setCommodityExportType:(int)commodityIdx :(int)newCommodityExportType;

- (NSString*)commodityHarmonizedCode:(int)commodityIdx;
- (void)setCommodityHarmonizedCode:(int)commodityIdx :(NSString*)newCommodityHarmonizedCode;

- (NSString*)commodityManufacturer:(int)commodityIdx;
- (void)setCommodityManufacturer:(int)commodityIdx :(NSString*)newCommodityManufacturer;

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

- (int)commodityQuantity:(int)commodityIdx;
- (void)setCommodityQuantity:(int)commodityIdx :(int)newCommodityQuantity;

- (NSString*)commodityQuantityUnit:(int)commodityIdx;
- (void)setCommodityQuantityUnit:(int)commodityIdx :(NSString*)newCommodityQuantityUnit;

- (NSString*)commodityScheduleBCode:(int)commodityIdx;
- (void)setCommodityScheduleBCode:(int)commodityIdx :(NSString*)newCommodityScheduleBCode;

- (NSString*)commodityUnitPrice:(int)commodityIdx;
- (void)setCommodityUnitPrice:(int)commodityIdx :(NSString*)newCommodityUnitPrice;

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

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

Default Value

""

Remarks

The Commodities is required to be provided in any international shipment request only if any of the international forms (Invoice, CO, NAFTA CO, SED or Partial Invoice) are requested.

For international multiple piece shipments (MPS), commodity information will be passed in the Master and on each subsequent package. If this shipment contains more than four commodities line items, the four highest valued should be included in the request.

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.

Each commodity item has a: (required), (required), (required), (optional), (conditional), (optional), (optional), (optional), and (conditional) tied to it.

For instance, to send a package containing 2 computer softwares and 5 iPods: (0) = 2 (0) = "computer software" (0) = "US" // country of manufacturer (0) = "0.5" // each software box weighs .5 lbs (0) = "EA" // for 'each' (0) = "100.00" // each software priced at $100 (1) = 5 (1) = "portable digital audio player" (1) = "US" // country of manufacturer (1) = "0.5" // each iPod box weighs .5 lbs (1) = "EA" // for 'each' (1) = "150.00" // each iPod priced at $150

DutiesPayor Property (UPSShipIntl Module)

Identifies the payor of duty and tax charges for the requested shipment.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=dutiesPayorAccountNumber,setter=setDutiesPayorAccountNumber:) NSString* dutiesPayorAccountNumber;

- (NSString*)dutiesPayorAccountNumber;
- (void)setDutiesPayorAccountNumber :(NSString*)newDutiesPayorAccountNumber;

@property (nonatomic,readwrite,assign,getter=dutiesPayorCountryCode,setter=setDutiesPayorCountryCode:) NSString* dutiesPayorCountryCode;

- (NSString*)dutiesPayorCountryCode;
- (void)setDutiesPayorCountryCode :(NSString*)newDutiesPayorCountryCode;

@property (nonatomic,readwrite,assign,getter=dutiesPayorType,setter=setDutiesPayorType:) int dutiesPayorType;

- (int)dutiesPayorType;
- (void)setDutiesPayorType :(int)newDutiesPayorType;

@property (nonatomic,readwrite,assign,getter=dutiesPayorZipCode,setter=setDutiesPayorZipCode:) NSString* dutiesPayorZipCode;

- (NSString*)dutiesPayorZipCode;
- (void)setDutiesPayorZipCode :(NSString*)newDutiesPayorZipCode;

 

Default Value

""

Remarks

This is applicable to and required for international shipments only, and only if origin and destination countries are different (i.e., the SenderAddressCountryCode is different than RecipientAddressCountryCode), and the shipment is not US/PR or PR/US.

The is required for United States and Canadian UPS accounts and/or if the UPS account pickup address has a postal code. If the UPS account's pickup country is US or Puerto Rico, the postal code is 5 or 9 digits. The character '-' may be used to separate the first five digits and the last four digits. If the UPS account's pickup country is CA, the postal code is 6 alphanumeric characters.

This must be set to an instance of the PayorDetail type, which will contain the duties payor details. See the PayorDetail type for more information.

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

FormTypes Property (UPSShipIntl Module)

Contains the collection of types for international forms that can associate an international shipment.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=formTypes,setter=setFormTypes:) int formTypes;

- (int)formTypes;
- (void)setFormTypes :(int)newFormTypes;

Default Value

0

Remarks

The FormTypes property is optional. Up to 6 international forms (such as Invoice, Shipper's Export Declaration, Certificate of Origin, NAFTA Certificate of Origin, etc.) can be requested within a ship request. To request any of the forms offered by UPS, you must set the FormTypes to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

For instance, to request both a Commercial Invoice and a CN22 you could set the property like below:

upsshipintl1.FormTypes = 0x00000011

Note: Invoice and Partial Invoice are mutually exclusive.

InternationalForms Property (UPSShipIntl Module)

Image of the international forms.

Syntax

• Swift
• Objective-C

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

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

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

- (NSString*)internationalForms;

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

- (NSData*)internationalFormsB;

Default Value

""

Remarks

This is the decoded binary image file of the international forms accompanying the shipment already requested via the FormTypes property (such as Invoice, SED, Certificate of Origin, etc.), stored in memory upon successful international ship response. If the InternationalFormsFile is set to a valid path and filename, the international forms are also saved to disk in PDF format.

This property is read-only.

InternationalFormsFile Property (UPSShipIntl Module)

Filename and location to save the InternationalForms to.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=internationalFormsFile,setter=setInternationalFormsFile:) NSString* internationalFormsFile;

- (NSString*)internationalFormsFile;
- (void)setInternationalFormsFile :(NSString*)newInternationalFormsFile;

Default Value

""

Remarks

When the InternationalFormsFile is set to a valid path and filename, the contents of the InternationalForms are written to disk upon successful response.

The InternationalFormsFile has to have .pdf extension.

LabelImageType Property (UPSShipIntl Module)

Type of image or printer commands the shipping label is to be formatted in.

Syntax

• Swift
• Objective-C

public var labelImageType: UpsshipintlLabelImageTypes {
  get {...}
  set {...}
}

public enum UpsshipintlLabelImageTypes: Int32 {
  case uitGIF = 0
  case uitEPL = 1
  case uitSPL = 2
  case uitZPL = 3
  case uitStar = 4
}

@property (nonatomic,readwrite,assign,getter=labelImageType,setter=setLabelImageType:) int labelImageType;

- (int)labelImageType;
- (void)setLabelImageType :(int)newLabelImageType;

Default Value

0

Remarks

This element defines the print method code that the labels are to be generated to. It is applicable and required to be provided in a ship request for forward shipments or return shipments. The value selection depends on the printer type used to print the shipping label.

Valid image types and their meanings with the corresponding usage are listed below:

There are two types of shipping labels supported: plain paper (when printing to an HP compatible laser or inkjet type printer only. In this case, the only possible value for the LabelImageType is 0 (uitGIF)), and thermal (when printing to thermal printers only. In this case, possible values for the LabelImageType are 1, 2, 3, and 4).

While the content of each of these labels is the same, their usages are different. Each provides a bar-coded image for the purpose of scanning the package during handling. The uses of each label depend on the type of working environment to be used.

MasterTrackingNumber Property (UPSShipIntl Module)

Tracking number assigned to the whole MPS shipment.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)masterTrackingNumber;

Default Value

""

Remarks

This is applicable to MPS shipment requests only and identifies the whole shipment. In a MPS ship request, this property is returned in the server reply when the GetShipmentLabels method is called.

This value is used as parameter when a cancel shipment request is sent (i.e., when the CancelShipment method is called). It can also be used when tracking a MPS.

This property is read-only.

NAFTABlanketPeriod Property (UPSShipIntl Module)

Contains specific details on NAFTA CO (when this form is requested).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=NAFTABlanketPeriod,setter=setNAFTABlanketPeriod:) NSString* NAFTABlanketPeriod;

- (NSString*)NAFTABlanketPeriod;
- (void)setNAFTABlanketPeriod :(NSString*)newNAFTABlanketPeriod;

Default Value

""

Remarks

This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if NAFTA CO international form is requested (i.e., one of the FormTypes is set to NAFTA).

This contains the begin date and the end date of the blanket period. The begin date is the date upon which the Certificate becomes applicable to the good covered by the blanket Certificate (it may be prior to the date of signing this Certificate). The end date is the date upon which the blanket period expires.

This is applicable and required to be provided in the request only if the NAFTA Certificate covers multiple shipments of identical goods as described in the ShipmentDescription that are imported into a NAFTA country for a specified period of up to one year (the blanket period). The importation of a good for which preferential treatment is claimed based on this certificate must occur between beginning and ending dates.

Format is: YYYYMMDD-YYYYMMDD

NAFTAPreferenceCriteria Property (UPSShipIntl Module)

Preference Criteria for NAFTA Certificate of Origin documents.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=NAFTAPreferenceCriteria,setter=setNAFTAPreferenceCriteria:) NSString* NAFTAPreferenceCriteria;

- (NSString*)NAFTAPreferenceCriteria;
- (void)setNAFTAPreferenceCriteria :(NSString*)newNAFTAPreferenceCriteria;

Default Value

""

Remarks

This property is required when the FormTypes property includes the NAFTA flag. Valid values and their descriptions are listed from the UPS documentation:

NAFTAProducerInfo Property (UPSShipIntl Module)

Producer information for NAFTA Certificate of Origin documents.

Syntax

• Swift
• Objective-C

public var naftaProducerInfo: UpsshipintlNAFTAProducerInfos {
  get {...}
  set {...}
}

public enum UpsshipintlNAFTAProducerInfos: Int32 {
  case piYes = 0
  case piNo1 = 1
  case piNo2 = 2
  case piNo3 = 3
}

@property (nonatomic,readwrite,assign,getter=NAFTAProducerInfo,setter=setNAFTAProducerInfo:) int NAFTAProducerInfo;

- (int)NAFTAProducerInfo;
- (void)setNAFTAProducerInfo :(int)newNAFTAProducerInfo;

Default Value

0

Remarks

This property is required when the FormTypes property includes the NAFTA flag.

From UPS documentation, specify: piYes - If shipper is the producer of the good. If not, state No depending on whether this certificate was based upon: piNo1 - Knowledge of whether the good qualifies as an originating good. piNo2 - Reliance on the producer's written representation (other than a Certificate of Origin) that the good qualifies as an originating good. piNo3 - A completed and signed Certificate for the good voluntarily provided to the exporter by the producer.

Notify Property (UPSShipIntl 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"

Packages Property (UPSShipIntl Module)

A collection of packages contained in the shipment.

Syntax

• Swift
• Objective-C

public var packages: Array<PackageDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=packageCount,setter=setPackageCount:) int packageCount;

- (int)packageCount;
- (void)setPackageCount :(int)newPackageCount;

- (NSString*)packageBaseCharge:(int)packageIdx;

- (NSString*)packageCODAmount:(int)packageIdx;
- (void)setPackageCODAmount:(int)packageIdx :(NSString*)newPackageCODAmount;

- (int)packageCODType:(int)packageIdx;
- (void)setPackageCODType:(int)packageIdx :(int)newPackageCODType;

- (NSString*)packageDescription:(int)packageIdx;
- (void)setPackageDescription:(int)packageIdx :(NSString*)newPackageDescription;

- (int)packageHeight:(int)packageIdx;
- (void)setPackageHeight:(int)packageIdx :(int)newPackageHeight;

- (NSString*)packageId:(int)packageIdx;
- (void)setPackageId:(int)packageIdx :(NSString*)newPackageId;

- (NSString*)packageInsuredValue:(int)packageIdx;
- (void)setPackageInsuredValue:(int)packageIdx :(NSString*)newPackageInsuredValue;

- (int)packageLength:(int)packageIdx;
- (void)setPackageLength:(int)packageIdx :(int)newPackageLength;

- (int)packageType:(int)packageIdx;
- (void)setPackageType:(int)packageIdx :(int)newPackageType;

- (NSString*)packageReference:(int)packageIdx;
- (void)setPackageReference:(int)packageIdx :(NSString*)newPackageReference;

- (NSString*)packageReturnReceipt:(int)packageIdx;

- (NSData*)packageReturnReceiptB:(int)packageIdx;
- (NSString*)packageReturnReceiptFile:(int)packageIdx;
- (void)setPackageReturnReceiptFile:(int)packageIdx :(NSString*)newPackageReturnReceiptFile;

- (NSString*)packageShippingLabel:(int)packageIdx;

- (NSData*)packageShippingLabelB:(int)packageIdx;
- (NSString*)packageShippingLabelFile:(int)packageIdx;
- (void)setPackageShippingLabelFile:(int)packageIdx :(NSString*)newPackageShippingLabelFile;

- (int)packageSignatureType:(int)packageIdx;
- (void)setPackageSignatureType:(int)packageIdx :(int)newPackageSignatureType;

- (long long)packageSpecialServices:(int)packageIdx;
- (void)setPackageSpecialServices:(int)packageIdx :(long long)newPackageSpecialServices;

- (NSString*)packageTotalSurcharges:(int)packageIdx;

- (NSString*)packageTrackingNumber:(int)packageIdx;

- (NSString*)packageWeight:(int)packageIdx;
- (void)setPackageWeight:(int)packageIdx :(NSString*)newPackageWeight;

- (int)packageWidth:(int)packageIdx;
- (void)setPackageWidth:(int)packageIdx :(int)newPackageWidth;

Default Value

""

Remarks

At least one package must be specified.

This property must be set to a collection of PackageDetail instances, which will contain specific information about a package contained in the shipment. See the PackageDetail type for more information.

For UPS, the PackagesPackagingType is required. The PackagesDescription is optional. The PackagesWeight, PackagesLength, PackagesWidth, and PackagesHeight are all conditionally required. More information can be found in the individual property definitions.

Payor Property (UPSShipIntl Module)

Identifies the payor of transportation charges for the requested shipment.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=payorAccountNumber,setter=setPayorAccountNumber:) NSString* payorAccountNumber;

- (NSString*)payorAccountNumber;
- (void)setPayorAccountNumber :(NSString*)newPayorAccountNumber;

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

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

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

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

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

PickupEarliestTime Property (UPSShipIntl Module)

The earliest time a shipment is ready to be picked up.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=pickupEarliestTime,setter=setPickupEarliestTime:) NSString* pickupEarliestTime;

- (NSString*)pickupEarliestTime;
- (void)setPickupEarliestTime :(NSString*)newPickupEarliestTime;

Default Value

""

Remarks

This is required when calling SchedulePickup. This contains the earliest time UPS can come to pickup the package.

This should be entered in this format: HHmm.

PickupLatestTime Property (UPSShipIntl Module)

The latest time a shipment can be picked up.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=pickupLatestTime,setter=setPickupLatestTime:) NSString* pickupLatestTime;

- (NSString*)pickupLatestTime;
- (void)setPickupLatestTime :(NSString*)newPickupLatestTime;

Default Value

""

Remarks

This is required when calling SchedulePickup. This contains the latest time UPS can come to pickup the package.

This should be entered in this format: HHmm.

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

SED Property (UPSShipIntl Module)

Contains specific details on SED (when this form is requested).

Syntax

• Swift
• Objective-C

public var sed: SEDDetail {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SEDECCNNumber,setter=setSEDECCNNumber:) NSString* SEDECCNNumber;

- (NSString*)SEDECCNNumber;
- (void)setSEDECCNNumber :(NSString*)newSEDECCNNumber;

@property (nonatomic,readwrite,assign,getter=SEDEntryNumber,setter=setSEDEntryNumber:) NSString* SEDEntryNumber;

- (NSString*)SEDEntryNumber;
- (void)setSEDEntryNumber :(NSString*)newSEDEntryNumber;

@property (nonatomic,readwrite,assign,getter=SEDExceptionCode,setter=setSEDExceptionCode:) int SEDExceptionCode;

- (int)SEDExceptionCode;
- (void)setSEDExceptionCode :(int)newSEDExceptionCode;

@property (nonatomic,readwrite,assign,getter=SEDFiledByUPS,setter=setSEDFiledByUPS:) BOOL SEDFiledByUPS;

- (BOOL)SEDFiledByUPS;
- (void)setSEDFiledByUPS :(BOOL)newSEDFiledByUPS;

@property (nonatomic,readwrite,assign,getter=SEDInBondCode,setter=setSEDInBondCode:) int SEDInBondCode;

- (int)SEDInBondCode;
- (void)setSEDInBondCode :(int)newSEDInBondCode;

@property (nonatomic,readwrite,assign,getter=SEDLicenseDate,setter=setSEDLicenseDate:) NSString* SEDLicenseDate;

- (NSString*)SEDLicenseDate;
- (void)setSEDLicenseDate :(NSString*)newSEDLicenseDate;

@property (nonatomic,readwrite,assign,getter=SEDLicenseNumber,setter=setSEDLicenseNumber:) NSString* SEDLicenseNumber;

- (NSString*)SEDLicenseNumber;
- (void)setSEDLicenseNumber :(NSString*)newSEDLicenseNumber;

@property (nonatomic,readwrite,assign,getter=SEDPointOfOrigin,setter=setSEDPointOfOrigin:) NSString* SEDPointOfOrigin;

- (NSString*)SEDPointOfOrigin;
- (void)setSEDPointOfOrigin :(NSString*)newSEDPointOfOrigin;

@property (nonatomic,readwrite,assign,getter=SEDShipperTaxId,setter=setSEDShipperTaxId:) NSString* SEDShipperTaxId;

- (NSString*)SEDShipperTaxId;
- (void)setSEDShipperTaxId :(NSString*)newSEDShipperTaxId;

@property (nonatomic,readwrite,assign,getter=SEDTransportType,setter=setSEDTransportType:) NSString* SEDTransportType;

- (NSString*)SEDTransportType;
- (void)setSEDTransportType :(NSString*)newSEDTransportType;

 

Default Value

""

Remarks

This is applicable only to international shipments that contain non-documents. It is required to be provided in the request only if SED international form is requested (i.e., one of the FormTypes is set to SED).

This must be set to an instance of the SEDDetail type, which will contain specific information about the SED that is requested to associate an international shipment. See the SEDDetail type for more information.

SenderAddress Property (UPSShipIntl 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 (UPSShipIntl 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 (UPSShipIntl Module)

Identifies the UPS service type (applicable to international shipments) to use in a ship request.

Syntax

• Swift
• Objective-C

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

public enum UpsshipintlServiceTypes: Int32 {
  case stUnspecified = 0
  case stFedExPriorityOvernight = 10
  case stFedExStandardOvernight = 11
  case stFedExFirstOvernight = 12
  case stFedEx2Day = 13
  case stFedExExpressSaver = 14
  case stFedExGround = 15
  case stFedExGroundHomeDelivery = 16
  case stFedEx1DayFreight = 17
  case stFedEx2DayFreight = 18
  case stFedEx3DayFreight = 19
  case stFedExInternationalPriority = 20
  case stFedExInternationalEconomy = 21
  case stFedExInternationalFirst = 22
  case stFedExInternationalPriorityFreight = 23
  case stFedExInternationalEconomyFreight = 24
  case stFedExEuropeFirstInternationalPriority = 25
  case stFedExSmartPost = 26
  case stFedEx2DayAM = 27
  case stFedExFirstFreight = 28
  case stFedExInternationalGround = 29
  case stFedExFreightEconomy = 30
  case stFedExFreightPriority = 31
  case stFedExInternationalPriorityExpress = 32
  case stFedExInternationalConnectPlus = 33
  case stUPSFirstClass = 35
  case stUPSPriorityMail = 36
  case stUPSExpeditedMailInnovations = 37
  case stUPSPriorityMailInnovations = 38
  case stUPSEconomyMailInnovations = 39
  case stUPSNextDayAir = 40
  case stUPSExpress = 41
  case stUPS2ndDayAir = 42
  case stUPSGround = 43
  case stUPSWorldwideExpress = 44
  case stUPSWorldwideExpedited = 45
  case stUPSExpedited = 46
  case stUPSStandard = 47
  case stUPS3DaySelect = 48
  case stUPSNextDayAirSaver = 49
  case stUPSSaver = 50
  case stUPSNextDayAirEarlyAM = 51
  case stUPSExpressEarlyAM = 52
  case stUPSWorldwideExpressPlus = 53
  case stUPSExpressPlus = 54
  case stUPS2ndDayAirAM = 55
  case stUPSTodayStandard = 56
  case stUPSTodayCourrier = 57
  case stUPSTodayInterCity = 58
  case stUPSTodayExpress = 59
  case stUPSTodayExpressSaver = 60
  case stUPSWorldwideExpressFreight = 61
  case stUPSSurePostLessThan1LB = 62
  case stUPSSurePost1LBOrGreater = 63
  case stUPSSurePostBPM = 64
  case stUPSSurePostMedia = 65
  case stUSPSExpress = 70
  case stUSPSFirstClass = 71
  case stUSPSPriority = 72
  case stUSPSParcelPost = 73
  case stUSPSBPM = 74
  case stUSPSMedia = 75
  case stUSPSLibrary = 76
  case stUSPSOnline = 77
  case stUSPSGlobalExpress = 78
  case stUSPSParcelSelect = 79
  case stUSPSCriticalMail = 80
  case stUSPSStandardMail = 81
  case stUSPSExpressMailInternational = 82
  case stUSPSFirstClassMailInternational = 83
  case stUSPSPriorityMailInternational = 84
  case stUSPSPriorityExpress = 85
  case stUSPSRetailGround = 86
  case stUSPSFirstClassPackageInternationalService = 87
  case stUSPSPriorityMailExpressInternational = 88
  case stCanadaRegularParcel = 90
  case stCanadaExpeditedParcel = 91
  case stCanadaXpresspost = 92
  case stCanadaLibrary = 93
  case stCanadaPriority = 94
  case stCanadaPriorityEnvelopeUSA = 95
  case stCanadaPriorityPakUSA = 96
  case stCanadaPriorityParcelUSA = 97
  case stCanadaXpresspostUSA = 98
  case stCanadaExpeditedParcelUSA = 99
  case stCanadaSmallPacketAirUSA = 100
  case stCanadaTrackedPacketUSA = 101
  case stCanadaTrackedPacketLVMUSA = 102
  case stCanadaPriorityEnvelopeInternational = 103
  case stCanadaPriorityPakInternational = 104
  case stCanadaPriorityParcelInternational = 105
  case stCanadaXpresspostInternational = 106
  case stCanadaSmallPacketAirInternational = 107
  case stCanadaSmallPacketLandInternational = 108
  case stCanadaParcelAirInternational = 109
  case stCanadaParcelLandInternational = 110
  case stCanadaTrackedPacketInternational = 111
  case stFedExSameDay = 126
  case stFedExSameDayCity = 127
  case stFedExSameDayMetroAfternoon = 128
  case stFedExSameDayMetroMorning = 129
  case stFedExSameDayMetroRush = 130
  case stUPSWorldwideEconomyDDU = 131
  case stUPSWorldwideEconomyDDP = 132
  case stUSPSParcelSelectGround = 133
  case stUSPSPriorityMailCubic = 134
  case stUSPSGroundAdvantage = 135
  case stUSPSGroundAdvantageCubic = 136
  case stFedExFirst = 140
  case stFedExPriority = 141
  case stFedExPriorityExpress = 142
  case stFedExPriorityExpressFreight = 143
  case stFedExPriorityFreight = 144
  case stFedExEconomySelect = 145
}

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

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

Default Value

0

Remarks

This property is required to be provided in a ship request when the GetShipmentLabels method is called.

Note that the availability and the description of UPS services depend on the country of origin. Possible values of ServiceType and their corresponding availability to each group country origin are listed below:

ShipDate Property (UPSShipIntl Module)

The date the user requests UPS to pickup the package from the origin.

Syntax

• Swift
• Objective-C

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

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

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

Default Value

""

Remarks

This is required to be provided in a ship request only if UPS On-Call Pickup service is requested (i.e., when the corresponding flag for On-Call Pickup (0x01000000) is present in ShipmentSpecialServices). This date should not be a past date or a date more than 10 days in the future. If not provided, then it defaults to the current date.

This should be entered in this format: YYYYMMDD.

Note: It is not valid if this pickup date is the same day for shipment(s) going from Germany to Germany using UPS Standard service. Error 129090 will be returned in this case.

ShipmentDescription Property (UPSShipIntl Module)

A textual description of goods for the whole shipment.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=shipmentDescription,setter=setShipmentDescription:) NSString* shipmentDescription;

- (NSString*)shipmentDescription;
- (void)setShipmentDescription :(NSString*)newShipmentDescription;

Default Value

""

Remarks

This is applicable to international shipments only. Provide a detailed description of items being shipped for documents and non-documents, such as 'annual reports', '9 mm steel screws', etc..

This is required to be provided in a ship request if all of the listed conditions are true:

• the SenderAddressCountryCode and RecipientAddressCountryCode are not the same;
• the SenderAddressCountryCode and/or RecipientAddressCountryCode are not in the European Union; or the SenderAddressCountryCode and RecipientAddressCountryCode are both in the European Union; and ServiceType is not 'UPS Standard'.
• the packaging type of any packages contained in the shipment is not 'UPS Letter';

Maximum length: 35 characters.

ShipmentReference Property (UPSShipIntl 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 {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipmentReference,setter=setShipmentReference:) NSString* shipmentReference;

- (NSString*)shipmentReference;
- (void)setShipmentReference :(NSString*)newShipmentReference;

Default Value

""

Remarks

This is applicable to international shipments only. Valid if the origin/destination pair is not US/US or PR/PR.

This is optional to be provided in a ship request (when the GetShipmentLabels method is called). You can enter up to two customer references on shipment level by providing: the type(s) and value(s) in the request.

Valid values for types are:

The type and value pair(s) should be entered as a string in this format: 'type1:value1; type2:value2'. For example, if the user wants to assign 2 references to this shipment, the ShipmentReference should be set to: 'AJ:123456; TN:123'.

You can also chose to bar code the first reference number's value on the shipping label by setting the BarCodeReference to True.

Reference information may also be used to track shipment by reference.

ShipmentSpecialServices Property (UPSShipIntl Module)

Contains the collection of special services offered by UPS on shipment level.

Syntax

• Swift
• Objective-C

public var shipmentSpecialServices: Int64 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=shipmentSpecialServices,setter=setShipmentSpecialServices:) long long shipmentSpecialServices;

- (long long)shipmentSpecialServices;
- (void)setShipmentSpecialServices :(long long)newShipmentSpecialServices;

Default Value

0

Remarks

To request any of the special services offered by UPS in a request, you must set the ShipmentSpecialServices to a set of flags as listed below (specified in hexadecimal notation). They can be or-ed together to include multiple conditions:

The meaning and limitations for each special service option are listed below:

• Hold for Pickup: This indicates that UPS should deliver your package to the UPS Customer Center you choose and then call the recipient when the package is ready.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Liftgate Dropoff: This requests that UPs provide their liftgate services unload a shipment when unloading docks are not available.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Liftgate Pickup: This requests that UPs provide their liftgate services load a shipment when loading docks are not available.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Return Shipment: This is applicable to return shipments only. Indicates that the ship request is made for Print Return Label (PRL). With this option you can print a return label to include in an outbound shipment, or provide a label to your customer separately.

  If you want to arrange for UPS to mail a return label to your customer, you can use the ReturnPrintAndMail config setting.

  If you want to arrange for UPS to email a return label to your customer, you can use the ElectronicReturnLabel config setting.

  If you want to arrange for UPS to make one attempt to pick up the package to be returned, you can use the ReturnServiceFirstAttempt config setting.

  If you want to arrange for UPS to make three attempts to pick up the package to be returned, you can use the ReturnServiceThirdAttempt config setting.

  Using the last 4 options: in the server response, you will receive only a Tracking number for the shipment to be returned, but not a return label and/or return receipt.

  For return shipments, one of the following conditions must be met on AccountAddressCountryCode, SenderAddressCountryCode and RecipientAddressCountryCode: At least two of these country codes are the same; None of these country codes are the same and are a member of the EU; None of these country codes are the same and at least one of them is not a member of the EU, and the shipper must have third country contract service. Following is a list of restrictions that are applicable when using return label types. This cannot be combined with COD, Saturday Delivery, Saturday Pickup, and/or Delivery Confirmation service options. For international shipments with return service, the Invoice flag is the only valid value for FormTypes. The availability of return service depends on the origin and destination country code, and on the selected ServiceType. The PackagesDescription is required to be provided in the request for each package contained in the shipment. The PackagesPackagingType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only.

  Also please note that when you set this option that only the return label is being printed, you must submit a separate request to print the shipping label.

• Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is not available for return shipments.
• Saturday Pickup: The presence indicates Saturdary pickup is requested. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair.
• Return of Document: This may also be referred to as the Return of Invoice service and is unique to Poland. If set UPS will use their Return of Document service to return the signed invoice to the shipper.
• Commercial Invoice Removal: When set this will indicate that the commercial invoice should be removed before delivery, thus not revealing the value of the contents to the recipient.
• Carbon Neutral: This is required to make a shipment that is carbon neutral.
• Exchange Forward: This is required in order to make exchange forward shipments.
• Dropoff at UPS Facility: When set this indicates that the package will be dropped off at a UPS Facility.

  This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.

• Deliver To Addressee Only: When set this requires that the addressee be the one who takes final delivery of the package being held at a UPS Access Point

  This accessorial is only valid when ShipmentIndicationType is set to 1.

• Direct Delivery Only: When set this will ensure that the package is delivered to the ShipTo address on the shipping label.

  This accessorial is not valid when ShipmentIndicationType is set.

ShipmentVoidStatus Property (UPSShipIntl Module)

Status description of shipment void request.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)shipmentVoidStatus;

Default Value

""

Remarks

Upon successful response, this is populated when the CancelShipment or CancelPackage method is called.

This property is read-only.

SoldToAddress Property (UPSShipIntl Module)

Identifies the address of the party who imports and pays any duties due on the current shipment, or the end-user of the goods..

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=soldToAddress1,setter=setSoldToAddress1:) NSString* soldToAddress1;

- (NSString*)soldToAddress1;
- (void)setSoldToAddress1 :(NSString*)newSoldToAddress1;

@property (nonatomic,readwrite,assign,getter=soldToAddress2,setter=setSoldToAddress2:) NSString* soldToAddress2;

- (NSString*)soldToAddress2;
- (void)setSoldToAddress2 :(NSString*)newSoldToAddress2;

@property (nonatomic,readwrite,assign,getter=soldToCity,setter=setSoldToCity:) NSString* soldToCity;

- (NSString*)soldToCity;
- (void)setSoldToCity :(NSString*)newSoldToCity;

@property (nonatomic,readwrite,assign,getter=soldToCountryCode,setter=setSoldToCountryCode:) NSString* soldToCountryCode;

- (NSString*)soldToCountryCode;
- (void)setSoldToCountryCode :(NSString*)newSoldToCountryCode;

@property (nonatomic,readwrite,assign,getter=soldToState,setter=setSoldToState:) NSString* soldToState;

- (NSString*)soldToState;
- (void)setSoldToState :(NSString*)newSoldToState;

@property (nonatomic,readwrite,assign,getter=soldToZipCode,setter=setSoldToZipCode:) NSString* soldToZipCode;

- (NSString*)soldToZipCode;
- (void)setSoldToZipCode :(NSString*)newSoldToZipCode;

 

Default Value

""

Remarks

The SoldToAddress represents address details of the party who imports and pays any duties due on the shipment, or the end-user. It is required to be provided in an international ship request only if this party is different from recipient, and if Commercial Invoice, NAFTA CO, and/or SED international forms are requested.

• in Commercial Invoice or NAFTA CO forms: SoldToAddress represents the party's address who imports and pays any duties due on the current shipment.
• in SED form: SoldToAddress represents the person or company's address who receives the goods for end-use or the person or company listed on the export license. This is the end-user of the goods.

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

If not set, it will default to RecipientAddress.

SoldToContact Property (UPSShipIntl Module)

Identifies the contact info of the party who imports and pays any duties due on the current shipment.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=soldToCompany,setter=setSoldToCompany:) NSString* soldToCompany;

- (NSString*)soldToCompany;
- (void)setSoldToCompany :(NSString*)newSoldToCompany;

@property (nonatomic,readwrite,assign,getter=soldToEmail,setter=setSoldToEmail:) NSString* soldToEmail;

- (NSString*)soldToEmail;
- (void)setSoldToEmail :(NSString*)newSoldToEmail;

@property (nonatomic,readwrite,assign,getter=soldToFax,setter=setSoldToFax:) NSString* soldToFax;

- (NSString*)soldToFax;
- (void)setSoldToFax :(NSString*)newSoldToFax;

@property (nonatomic,readwrite,assign,getter=soldToFirstName,setter=setSoldToFirstName:) NSString* soldToFirstName;

- (NSString*)soldToFirstName;
- (void)setSoldToFirstName :(NSString*)newSoldToFirstName;

@property (nonatomic,readwrite,assign,getter=soldToLastName,setter=setSoldToLastName:) NSString* soldToLastName;

- (NSString*)soldToLastName;
- (void)setSoldToLastName :(NSString*)newSoldToLastName;

@property (nonatomic,readwrite,assign,getter=soldToMiddleInitial,setter=setSoldToMiddleInitial:) NSString* soldToMiddleInitial;

- (NSString*)soldToMiddleInitial;
- (void)setSoldToMiddleInitial :(NSString*)newSoldToMiddleInitial;

@property (nonatomic,readwrite,assign,getter=soldToPhone,setter=setSoldToPhone:) NSString* soldToPhone;

- (NSString*)soldToPhone;
- (void)setSoldToPhone :(NSString*)newSoldToPhone;

 

Default Value

""

Remarks

The SoldToContact represents descriptive contact data identifying the party who imports and pays any duties due on the shipment, or the end-user. It is required to be provided in an international ship request only if this party is different from recipient, and if Commercial Invoice, NAFTA CO, and/or SED international forms are requested.

• in Commercial Invoice or NAFTA CO forms: SoldToAddress represents the party's contact who imports and pays any duties due on the current shipment.
• in SED form: SoldToAddress represents the person or company's contact who receives the goods for end-use or the person or company listed on the export license. This is the end-user of the goods.

If not set, it will default to RecipientContact.

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

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

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

public enum UpsshipintlSSLCertStoreTypes: 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 (UPSShipIntl 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 (UPSShipIntl Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

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

public enum UpsshipintlSSLProviders: 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 (UPSShipIntl 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 (UPSShipIntl 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.

TotalBaseCharge Property (UPSShipIntl Module)

The total base charge applied to the whole shipment (specific to the AccountNumber ).

Syntax

• Swift
• Objective-C

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

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

- (NSString*)totalBaseCharge;

Default Value

""

Remarks

In a MPS ship request, this represents the total base charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackagesBaseCharge at index=0.

This property is read-only.

TotalCustomsValue Property (UPSShipIntl Module)

Total customs value for the shipment.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=totalCustomsValue,setter=setTotalCustomsValue:) NSString* totalCustomsValue;

- (NSString*)totalCustomsValue;
- (void)setTotalCustomsValue :(NSString*)newTotalCustomsValue;

Default Value

"1"

Remarks

The TotalCustomsValue is required to be provided in an international shipment request only if the following requirements are met:

• the SenderAddressCountryCode is US;
• the RecipientAddressCountryCode is either CA (Canada) or PR (PuertoRico);
• the shipment does not contain any package of UPS Letter type;

Format: Whole number, no decimal position (e.g. 100) with maximum length of 8 digits. Possible values: 1 to 99999999.

TotalNetCharge Property (UPSShipIntl Module)

The total net charge (transportation charge + options charges) applied to the whole shipment (specific to the AccountNumber ).

Syntax

• Swift
• Objective-C

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

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

- (NSString*)totalNetCharge;

Default Value

""

Remarks

In a MPS ship request, this represents the total net charge applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackagesNetCharge at index=0.

This property is read-only.

TotalSurcharges Property (UPSShipIntl Module)

The total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ).

Syntax

• Swift
• Objective-C

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

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

- (NSString*)totalSurcharges;

Default Value

""

Remarks

In a MPS ship request, this represents the total surcharges applied to all packages contained in the shipment. When the shipment consists of a single package, this is the same as PackagesTotalSurcharges at index=0.

This property is read-only.

UPSAccount Property (UPSShipIntl 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.

CancelPackage Method (UPSShipIntl Module)

Cancels a single package by deleting it from the shipping log.

Syntax

• Swift
• Objective-C

public func cancelPackage(masterTrackingNumber: String, packageTrackingNumber: String) throws -> Void

- (void)cancelPackage:(NSString*)masterTrackingNumber :(NSString*)packageTrackingNumber;

Remarks

To cancel shipment of a single package, a void shipment request should be sent to UPS UPSAccountServer by calling the CancelPackage method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the UPSAccountServer to: https://wwwcie.ups.com/api/shipments/.

Once your application is in production, the UPSAccountServer should be sent to the URL provided as part of the certification process.

The TrackingNumber parameter identifies the package to be deleted from the shipping log.

This method will return the void status of the specified package.

To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.

CancelPickup Method (UPSShipIntl Module)

Cancel a pickup.

Syntax

• Swift
• Objective-C

public func cancelPickup(confirmationNumber: String) throws -> Void

- (void)cancelPickup:(NSString*)confirmationNumber;

Remarks

When called the pickup referenced by the ConfirmationNumber will be canceled.

To check the status of your cancel pickup request the CancelPickUpStatus config should be inspected.

CancelShipment Method (UPSShipIntl Module)

Cancels an entire multi-package (MPS) shipment by deleting it from the shipping log.

Syntax

• Swift
• Objective-C

public func cancelShipment(masterTrackingNumber: String) throws -> Void

- (void)cancelShipment:(NSString*)masterTrackingNumber;

Remarks

To cancel an entire MPS shipment, a void shipment request should be sent to UPS Server by calling the CancelShipment method.

For void shipment requests while your application is undergoing testing and integration, you will have to set the Server to: https://wwwcie.ups.com/api/shipments/.

Once your application is in production, the Server should be sent to the URL provided as part of the certification process.

The MasterTrackingNumber parameter identifies the shipment that contains all packages to be deleted from shipping log.

To check the status of your shipment void request, the ShipmentVoidStatus should be inspected.

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

GetShipmentLabels Method (UPSShipIntl Module)

Generates a shipping label.

Syntax

• Swift
• Objective-C

public func getShipmentLabels() throws -> Void

- (void)getShipmentLabels;

Remarks

When this method is called, the following properties must have been set:

• UPSAccountServer (required)
• UPSAccountAuthorizationToken (required)
• UPSAccountAccountNumber (required)
• ServiceType (required)
• AccountContact (conditional)
• AccountAddress (conditional)
• SenderContact (required)
• SenderAddress (required)
• RecipientContact (required)
• RecipientAddress (required)
• SoldToContact (conditional)
• SoldToAddress (conditional)
• Payor (required)
• ShipmentSpecialServices (optional)
• ShipmentDescription (conditional)
• ShipmentReference (conditional)
• Packages (required)
• LabelImageType (required)
• Notify (optional)
• FormTypes (optional)
• CommercialInvoice (optional)
• Commodities (conditional)
• CODReportFile (optional)
• CODTotalAmount (optional)
• CODType (optional)
• WeightUnit (required; defaults to LB)
• Documents (optional)

The commodity information you provide in your transaction is forwarded to customs electronically at the time the shipping label is generated. Commodity information can be provided via the Commodities (required, regardless of the Documents value).

Upon successful response, the following properties might be populated:

• MasterTrackingNumber (if MPS)
• PackagesTrackingNumber for each package included in the shipment;
• PackagesShippingLabel for each package included in the shipment;
• PackagesTotalSurcharges for each package included in the shipment (only guaranteed to be returned for shipments whose origin country is US or Puerto Rico);
• TotalNetCharge (applicable to the whole shipment);
• TotalBaseCharge (applicable to the whole shipment);
• TotalSurcharges (applicable to the whole shipment);

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

SchedulePickup Method (UPSShipIntl Module)

Schedules a pickup.

Syntax

• Swift
• Objective-C

public func schedulePickup() throws -> String

- (NSString*)schedulePickup;

Remarks

When called, this will request an OnCall Pickup from UPS and return the Pickup Confirmation Number.

The valid properties when calling this method are as follows:

• ServiceType (Required)
• PickupEarliestTime (Required)
• PickupLatestTime (Required)
• SenderContactFirstName (Optional, required if Company is not provided)
• SenderContactLastName (Optional, required if Company is not provided)
• SenderContactCompany (Optional, required if FirstName and/or LastName are not provided)
• SenderContactPhone (Required)
• SenderAddressAddress1 (Required)
• PickupFloorNumber (Optional)
• PickupRoomNumber (Optional)
• SenderAddressCity (Required)
• SenderAddressState (Required, optional if outside US and Canada)
• SenderAddressZipCode (Required)
• SenderAddressCountryCode (Required)
• ShipDate (Required)

Please note that only SenderAddressAddress1 is valid as the request only allows one address line.

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

CommercialInvoiceDetail Type

Represents the commercial invoice (CI) information.

Remarks

This type contains descriptive data identifying the commercial invoice (CI) associating an international shipment that contains non-documents items.

Example: Setting the fields CommercialInvoiceDetail ci = new CommercialInvoiceDetail ci.Comments = "Anything" ci.FreightCharge = "100.00" ci.Insurance = "1000.00" ci.Purpose = CIP_SAMPLE ci.Terms = CIT_FOB_OR_FCA

The fields contained by this type are listed below.

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

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