USPSShipIntl Module

Properties   Methods   Events   Config Settings   Errors  

Allows you to generate a USPS shipping label for any of USPS international services complete with addresses and barcode. Note that when PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label. The eVS International Label API lets customers generate eVS labels with integrated customs declaration forms.

Syntax

DShippingSDK.Uspsshipintl

Remarks

Generating a shipping label can be done by calling the GetPackageLabel method. You will have to specify the package information, USPS service to be used for shipping this package, origin and destination information, and any special services you want to associate the shipment (such as Return Shipment, etc.), and any other specific information on international shipments.

Postage Provider Notes

When using USPS as the PostageProvider (i.e. ppNone) you will need to...

• Set PostageProvider to ppNone (default).
• Set USPSAccountUserId to the UserId provided by USPS.
• Set USPSAccountPassword to the password provided by USPS.
• Set USPSAccountServer to either the test or production server.

When using Endicia as the PostageProvider there are different instructions for Production and Testing.

Production

Endicia will provide you with a production account number and password. To use your account with the components...

• Set PostageProvider to ppEndicia.
• Set USPSAccountAccountNumber to your production account number (provided by Endicia).
• Set USPSAccountPassword to your production password (provided by Endicia).

The components come with a built in sandbox account for your use. To use that account with the components...

• Set PostageProvider to ppEndicia.
• Set EndiciaTestMode to either 1 or 2.

ppStamps

When using Stamps.com as the PostageProvider you will need to...

• Set PostageProvider to ppStamps.
• Set USPSAccountUserId to the sandbox or production user provided by Stamps.com.
• Set USPSAccountAccountNumber to the sandbox or production account number provided by Stamps.com.
• Set USPSAccountPassword to the sandbox or production password provided by Stamps.com.
• Set USPSAccountServer to either the test or production server.

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.

BarcodeNumber Property (USPSShipIntl Module)

Barcode number associated with label's barcode.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)barcodeNumber;

Default Value

""

Remarks

The value of this property is filled after a call to the GetPackageLabel method when using the eVS Label API (in other words PostageProvider is set to ppNone).

This property is read-only.

CertificateNumber Property (USPSShipIntl Module)

Certificate number (if known or included in the package).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=certificateNumber,setter=setCertificateNumber:) NSString* certificateNumber;

- (NSString*)certificateNumber;
- (void)setCertificateNumber :(NSString*)newCertificateNumber;

Default Value

""

Remarks

Some countries require a Certificate of Origin in order for certain items to be imported. (for example, fruits and vegetables). Restrictions as to what items require a Certificate Of Origin are returned in the Restrictions property.

The value of this property is optional. Maximum length: 24.

This property is not applicable for International First Class mail.

Comments Property (USPSShipIntl Module)

Comments on the package being shipped.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=comments,setter=setComments:) NSString* comments;

- (NSString*)comments;
- (void)setComments :(NSString*)newComments;

Default Value

""

Remarks

Optional comments field. Maximum length: 76.

This property is not applicable for International First Class mail.

Commodities Property (USPSShipIntl Module)

Items being shipped inside this package.

Syntax

• Swift
• Objective-C

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

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

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

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

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

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

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

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

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

Default Value

""

Remarks

This property should be set to the commodity types that are inside the package. Each commodity has a , , , , , and .

For instance, to send a package containing 20 wheel bearings and 15 fork seals: class.CommodityCount = 2; class.CommodityDescription(0) = "Wheel bearings"; class.CommodityQuantity(0) = 20; class.CommodityValue(0) = "100.00"; // 20 bearings at $5 each class.CommodityWeight(0) = "10 lbs 0 oz"; // each wheel bearing is .5 lbs class.CommodityDescription(1) = "Fork seals"; class.CommodityQuantity(1) = 15; class.CommodityValue(1) = "375.00"; // 15 seals at $25 each class.CommodityWeight(1) = "3 lbs 8 oz"; // Total weight of all fork seals in the package.

Please note that and are only valid for commercial shippers, and may be left out. The remaining properties are all required.

Contents Property (USPSShipIntl Module)

Type of the contents in the package.

Syntax

• Swift
• Objective-C

public var contents: UspsshipintlContents {
  get {...}
  set {...}
}

public enum UspsshipintlContents: Int32 {
  case ctSample = 0
  case ctGift = 1
  case ctDocuments = 2
  case ctReturn = 3
  case ctOther = 4
  case ctMerchandise = 5
  case ctHumanitarianDonation = 6
  case ctDangerousGoods = 7
  case ctCrematedRemains = 8
  case ctNonNegotiableDocument = 9
  case ctPharmaceuticals = 10
  case ctMedicalSupplies = 11
  case ctHAZMAT = 12
  case ctLives = 13
  case ctPerishable = 14
}

@property (nonatomic,readwrite,assign,getter=contents,setter=setContents:) int contents;

- (int)contents;
- (void)setContents :(int)newContents;

Default Value

0

Remarks

You can set this property when generating labels to indicate the content type in the package.

Possible values are as follows:

Note that if Contents is set to ctOther, you may be required to set the OtherContents configuration setting with a description of the contents. For example:

class.Contents = ctOther class.Config("OtherContents=Livestock")

CustomerId Property (USPSShipIntl Module)

User-assigned number for internal use.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=customerId,setter=setCustomerId:) NSString* customerId;

- (NSString*)customerId;
- (void)setCustomerId :(NSString*)newCustomerId;

Default Value

""

Remarks

You can set a value to CustomerId property if you have a need to cross-reference information about a shipment using your own tracking or inventory systems. Any combination of alpha and numeric characters can be entered, up to a maximum of 30.

Note: For USPS eVS Domestic Labels only - you will be able to print the first 18 characters of the CustomerId value on the shipping label image if you set the PrintCustomerRefNo to True. In all other cases this string will not be included on the label.

For Endicia requests, this is a unique Id for the partner's end-user that is printing the label.

ExtraServices Property (USPSShipIntl Module)

Contains the collection of extra services offered by USPS on shipment level.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=extraServices,setter=setExtraServices:) long long extraServices;

- (long long)extraServices;
- (void)setExtraServices :(long long)newExtraServices;

Default Value

0

Remarks

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

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

ImageLayout Property (USPSShipIntl Module)

Determines how the labels will be formatted for printing.

Syntax

• Swift
• Objective-C

public var imageLayout: UspsshipintlImageLayouts {
  get {...}
  set {...}
}

public enum UspsshipintlImageLayouts: Int32 {
  case ilOnePerFile = 0
  case ilAllInOneFile = 1
  case ilTrimOnePerFile = 2
  case ilTrimAllInOneFile = 3
}

@property (nonatomic,readwrite,assign,getter=imageLayout,setter=setImageLayout:) int imageLayout;

- (int)imageLayout;
- (void)setImageLayout :(int)newImageLayout;

Default Value

0

Remarks

The LabelImageType property indicates the file type of the label that USPS returns. ImageLayout dictates how the label looks in that file. The labels returned by USPS measure 8.5" x 5.5", or exactly one half of a sheet of regular 8.5" x 11" paper. The layouts available are listed below:

For the ilAllInOneFile and ilTrimAllInOneFile ImageLayouts, only one file will be written. However, for the ilOnePerFile and ilTrimOnePerFile ImageLayouts, more than one shipping label may be returned, up to a maximum of 6 total pages. If PackagesShippingLabelFile is specified, these additional pages will be saved with the page number appended to the PackagesShippingLabelFile you supplied.

For instance, if the PackagesShippingLabelFile is "c:\expresslabel.pdf", the following files will be created: "expresslabel.pdf", "expresslabel.page2.pdf", "expresslabel.page3.pdf", etcetera.

Note that for the stUSPSFirstClass ServiceType, only ilOnePerFile and ilAllInOneFile are supported. Using any of the Trim-values will result in an error from USPS.

ImportersContact Property (USPSShipIntl Module)

Identifies the importer's contact info.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=importersEmail,setter=setImportersEmail:) NSString* importersEmail;

- (NSString*)importersEmail;
- (void)setImportersEmail :(NSString*)newImportersEmail;

@property (nonatomic,readwrite,assign,getter=importersFax,setter=setImportersFax:) NSString* importersFax;

- (NSString*)importersFax;
- (void)setImportersFax :(NSString*)newImportersFax;

@property (nonatomic,readwrite,assign,getter=importersPhone,setter=setImportersPhone:) NSString* importersPhone;

- (NSString*)importersPhone;
- (void)setImportersPhone :(NSString*)newImportersPhone;

 

Default Value

""

Remarks

The ImportersContact represents contact data identifying the importer. It can be provided in an international ship request only when the ServiceType is stUSPSExpressMailInternational (82) or stUSPSPriorityMailInternational (84).

The only necessary fields to be set for this type are the , , and .

This must be set to an instance of the ContactDetail type. See the ContactDetail type for more information.

IndemnityCoverage Property (USPSShipIntl Module)

Indicates the indemnity coverage for the package.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)indemnityCoverage;

Default Value

""

Remarks

This property is returned only for International Priority Mail packages, and only when the InsuredValue property was set to an amount greater than "0.00".

This property is read-only.

InsurancePolicy Property (USPSShipIntl Module)

Insurance number, if known.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=insurancePolicy,setter=setInsurancePolicy:) NSString* insurancePolicy;

- (NSString*)insurancePolicy;
- (void)setInsurancePolicy :(NSString*)newInsurancePolicy;

Default Value

""

Remarks

If insurance has been purchased, this property should be set to the policy number.

This property is not applicable for International First Class mail.

InvoiceNumber Property (USPSShipIntl Module)

Invoice number if known or included in the package.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=invoiceNumber,setter=setInvoiceNumber:) NSString* invoiceNumber;

- (NSString*)invoiceNumber;
- (void)setInvoiceNumber :(NSString*)newInvoiceNumber;

Default Value

""

Remarks

This property may contain an invoice number if it is known or included in the package. Maximum length is 24 characters. This property is ignored when PackagesPackagingType is set to scFlatRateEnvelope.

This property is not applicable for International First Class mail.

LabelImageType Property (USPSShipIntl Module)

Type of label image.

Syntax

• Swift
• Objective-C

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

public enum UspsshipintlLabelImageTypes: Int32 {
  case sitNone = 0
  case sitTIF = 1
  case sitJPG = 2
  case sitPDF = 3
  case sitGIF = 4
  case sitEPL = 5
  case sitPNG = 6
  case sitZPL = 7
  case sitPDFVector = 8
  case sitPDFVectorWithFonts = 9
  case sitAZPL = 10
}

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

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

Default Value

0

Remarks

The value of this property is required when calling methods to retrieve shipping labels. Valid image formats are listed below:

Valid values for USPS (eVSLabels):

• sitTIF (1)
• sitPDF (3)

Valid values for Endicia:

• sitJPG (2)
• sitPDF (3)
• sitGIF (4)
• sitEPL (5)
• sitPNG (6)
• sitZPL (7)
• sitPDFVector (8)
• sitPDFVectorWithFonts (9)

Valid values for Stamps.com:

• sitJPG (2)
• sitPDF (3)
• sitGIF (4)
• sitEPL (5)
• sitPNG (6)
• sitZPL (7)
• sitAZPL (10)

LicenseNumber Property (USPSShipIntl Module)

Import License number if known, or included in package.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=licenseNumber,setter=setLicenseNumber:) NSString* licenseNumber;

- (NSString*)licenseNumber;
- (void)setLicenseNumber :(NSString*)newLicenseNumber;

Default Value

""

Remarks

Many countries require the sender to obtain a license in order to import certain items (for example, drugs or medical equipment). Restrictions as to what items require a license are returned in the Restrictions property.

The value of this property is optional. Maximum length: 24.

This property is not applicable for International First Class mail.

Machinable Property (USPSShipIntl Module)

Indicates if shipment is machinable or not.

Syntax

• Swift
• Objective-C

public var machinable: UspsshipintlMachinables {
  get {...}
  set {...}
}

public enum UspsshipintlMachinables: Int32 {
  case moTrue = 0
  case moFalse = 1
  case moIrregular = 2
}

@property (nonatomic,readwrite,assign,getter=machinable,setter=setMachinable:) int machinable;

- (int)machinable;
- (void)setMachinable :(int)newMachinable;

Default Value

0

Remarks

The default value for this property is moTrue (0).

Note: The value moIrregular (2) is valid only when ServiceType is stUSPSBPM (74), stUSPSMedia (75), or stUSPSLibrary (76).

Possible values are as follows:

MailingLocation Property (USPSShipIntl Module)

Postal Office Zip Code where the item will be mailed (if different from ZipCode ).

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=mailingLocation,setter=setMailingLocation:) NSString* mailingLocation;

- (NSString*)mailingLocation;
- (void)setMailingLocation :(NSString*)newMailingLocation;

Default Value

""

Remarks

The value of this property is optional.

If you plan to mail your item(s) from a post office or a collection box other than your return address Zip Code (SenderAddressZipCode), you must enter that ZIP Code (of the post office or collection box where the item is mailed) by providing a value for the MailingLocation property.

This way, you convey this difference to the USPS Server.

This property is not applicable for International First Class mail.

NonDeliveryOption Property (USPSShipIntl Module)

Indicates what to do with the package in case it is undeliverable.

Syntax

• Swift
• Objective-C

public var nonDeliveryOption: UspsshipintlNonDeliveryOptions {
  get {...}
  set {...}
}

public enum UspsshipintlNonDeliveryOptions: Int32 {
  case ndoReturn = 0
  case ndoRedirect = 1
  case ndoAbandon = 2
}

@property (nonatomic,readwrite,assign,getter=nonDeliveryOption,setter=setNonDeliveryOption:) int nonDeliveryOption;

- (int)nonDeliveryOption;
- (void)setNonDeliveryOption :(int)newNonDeliveryOption;

Default Value

0

Remarks

In case the package is undeliverable, the package may be Returned, Redirected, or Abandoned.

This property is not applicable for International First Class mail (stUSPSFirstClassMailInternational (83) ).

Notes Property (USPSShipIntl Module)

Additional information returned by the USPS Server .

Syntax

• Swift
• Objective-C

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

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

- (NSString*)notes;

Default Value

""

Remarks

This property may contain additional notes pertaining to the shipment of goods to the destination country (RecipientAddressCountryCode).

This property is read-only.

Observations Property (USPSShipIntl Module)

Additional mailing information based on country of destination.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)observations;

Default Value

""

Remarks

Additional information that may be important to the sender. Returned by the USPS Server

This property is read-only.

Packages Property (USPSShipIntl 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*)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)packageGirth:(int)packageIdx;
- (void)setPackageGirth:(int)packageIdx :(int)newPackageGirth;

- (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;

- (NSString*)packageNetCharge:(int)packageIdx;
- (void)setPackageNetCharge:(int)packageIdx :(NSString*)newPackageNetCharge;

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

- (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;

- (int)packageSize:(int)packageIdx;
- (void)setPackageSize:(int)packageIdx :(int)newPackageSize;

- (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 USPS, the PackagesPackagingType, PackagesSize, and PackagesWeight properties are required. PackagesLength, PackagesWidth, PackagesHeight, and PackagesGirth are all conditionally required, and more information may be found in the individual property definitions.

Note: USPS only supports one package per shipment.

PermitNumber Property (USPSShipIntl Module)

Permit number to print Postage Due labels.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=permitNumber,setter=setPermitNumber:) NSString* permitNumber;

- (NSString*)permitNumber;
- (void)setPermitNumber :(NSString*)newPermitNumber;

Default Value

""

Remarks

Sending postage due packages requires a permit with a US Post Office. This property should contain the Permit Number you were issued by that post office.

PostageProvider Property (USPSShipIntl Module)

The postage provider to use. If a postage-paid label is required either ppEndicia or ppStamps must be used.

Syntax

• Swift
• Objective-C

public var postageProvider: UspsshipintlPostageProviders {
  get {...}
  set {...}
}

public enum UspsshipintlPostageProviders: Int32 {
  case ppNone = 0
  case ppEndicia = 1
  case ppStamps = 2
}

@property (nonatomic,readwrite,assign,getter=postageProvider,setter=setPostageProvider:) int postageProvider;

- (int)postageProvider;
- (void)setPostageProvider :(int)newPostageProvider;

Default Value

0

Remarks

When set to ppNone, the class will communicate with USPS servers. When set to this value the following properties should also be set.

• Set USPSAccountUserId
• Set USPSAccountPassword
• Set USPSAccountServer

When set to ppEndicia, the class will communicate with Endicia's servers. When set to this value the following properties should also be set.

For Production

• Set USPSAccountAccountNumber
• Set USPSAccountPassword

For Testing

• Set EndiciaTestMode

When set to ppStamps, the class will communicate with Stamps.com's servers. When set to this value the following properties should also be set.

• Set USPSAccountUserId
• Set USPSAccountAccountNumber
• Set USPSAccountPassword
• Set USPSAccountServer

PriceOption Property (USPSShipIntl Module)

Indicates pricing that should be returned (i.e. Commercial Base).

Syntax

• Swift
• Objective-C

public var priceOption: UspsshipintlPriceOptions {
  get {...}
  set {...}
}

public enum UspsshipintlPriceOptions: Int32 {
  case poRetail = 0
  case poCommercialPlus = 1
  case poCommercialBase = 2
}

@property (nonatomic,readwrite,assign,getter=priceOption,setter=setPriceOption:) int priceOption;

- (int)priceOption;
- (void)setPriceOption :(int)newPriceOption;

Default Value

2

Remarks

The default value for this property is poCommercialBase (2).

Note: When ServiceType is stUSPSPriorityMailCubic (134) the component will send "Commercial Plus" in the request (per USPS eVSLabel specifications).

Note: The value poRetail (0) is valid only when ServiceType is stUSPSPriorityMailInternational (84).

Possible values are as follows:

Prohibitions Property (USPSShipIntl Module)

List of items prohibited from mailing to the destination country.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)prohibitions;

Default Value

""

Remarks

Articles that are prohibited by the destination country are non-mailable. These prohibitions are based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific prohibitions as a country may return or seize mail containing articles prohibited within that country, whether or not notice of such prohibitions has been provided to or published by the Postal Service.

This property is read-only.

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

RecipientCustomsReference Property (USPSShipIntl Module)

Corresponds to the person's Customs Reference field that appears on the shipping label.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=recipientCustomsReference,setter=setRecipientCustomsReference:) NSString* recipientCustomsReference;

- (NSString*)recipientCustomsReference;
- (void)setRecipientCustomsReference :(NSString*)newRecipientCustomsReference;

Default Value

""

Remarks

This property may contain any reference number that the person wishes to use.

Regulations Property (USPSShipIntl Module)

Additional regulations for shipping to the destination country.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)regulations;

Default Value

""

Remarks

Any additional regulations not covered under Restrictions, Observations, or Prohibitions will be listed here after a successful transaction. The returned data might include information such as: country code, required Customs Forms, special notes when shipping certain items, areas served, etc.

This property is read-only.

Restrictions Property (USPSShipIntl Module)

Restrictions on items being shipped based on country of destination.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)restrictions;

Default Value

""

Remarks

This property will contain information indicating mail articles which are restricted by the destination country, Any packages sent are subject to the import requirements of that country. The contents of this property is based on information furnished by the country concerned.

You may also inquire at the Post Office facility about specific restrictions as a country may return or seize mail containing articles prohibited or restricted within that country, whether or not notice of such restriction has been provided to or published by the Postal Service.

This property is read-only.

SDRValue Property (USPSShipIntl Module)

Special Drawing Right calculated on TotalValue .

Syntax

• Swift
• Objective-C

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

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

- (NSString*)SDRValue;

Default Value

""

Remarks

The Special Drawing Right (SDR) is an artificial currency unit based on a collection of major world currencies. The SDRValue is the calculated TotalValue in this artificial currency.

This property is read-only.

SenderAddress Property (USPSShipIntl 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=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 GetPackageLabel 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 (USPSShipIntl 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 GetPackageLabel 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.

SenderCustomsReference Property (USPSShipIntl Module)

Corresponds to the person's Customs Reference field that appears on the shipping label.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=senderCustomsReference,setter=setSenderCustomsReference:) NSString* senderCustomsReference;

- (NSString*)senderCustomsReference;
- (void)setSenderCustomsReference :(NSString*)newSenderCustomsReference;

Default Value

""

Remarks

This property may contain any reference number that the person wishes to use.

ServiceType Property (USPSShipIntl Module)

The mail service type when shipping to the CountryCode .

Syntax

• Swift
• Objective-C

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

public enum UspsshipintlServiceTypes: 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 GetPackageLabel method is called.

Possible values are:

ShipDate Property (USPSShipIntl Module)

Date package will be mailed.

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

You can post-date the Express Mail label up to three days in advance by using this optional property. The mailing date entered should reflect the actual date the package will be shipped. For USPS, the ship date may be today plus 0 to 3 days in advance. Enter the date in either format: yyyy-MM-dd, such as 2022-08-14, or MM/dd/yyyy, such as 08/14/2022.

This property allows you to post-date the Signature Confirmation label up to four days in advance. The package should not be shipped until the label date requested.

Note: When using Endicia, only the format yyyyMMdd is valid and may be specified up to 7 days in advance. When using Stamps.com date format should be "yyyy-MM-dd", e.g. 2022-08-14.

This property is also returned after the following carrier pickup methods are called:

• PickupAvailability
• SchedulePickup
• ChangePickup
• PickupInquiry

ShipmentSpecialServices Property (USPSShipIntl Module)

Contains the collection of special services offered by USPS 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 USPS, 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:

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

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

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

public enum UspsshipintlSSLCertStoreTypes: 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 (USPSShipIntl 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 (USPSShipIntl Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

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

public enum UspsshipintlSSLProviders: 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 (USPSShipIntl 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 (USPSShipIntl 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.

TotalValue Property (USPSShipIntl Module)

Total value of all items being shipped.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)totalValue;

Default Value

""

Remarks

This is the total value of all items in the package. It should match the sum of all individual CommoditiesUnitPrices.

This property is read-only.

TransactionId Property (USPSShipIntl Module)

The transaction Id.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=transactionId,setter=setTransactionId:) NSString* transactionId;

- (NSString*)transactionId;
- (void)setTransactionId :(NSString*)newTransactionId;

Default Value

""

Remarks

This property is only used for Endicia labels, and is defined as a unique Id for the partner's end-user's transaction. This can be an invoice number or transaction number.

USPSAccount Property (USPSShipIntl Module)

Login information for USPS.

Syntax

• Swift
• Objective-C

public var uspsAccount: USPSAccount {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=USPSAccountNumber,setter=setUSPSAccountNumber:) NSString* USPSAccountNumber;

- (NSString*)USPSAccountNumber;
- (void)setUSPSAccountNumber :(NSString*)newUSPSAccountNumber;

@property (nonatomic,readwrite,assign,getter=USPSPassword,setter=setUSPSPassword:) NSString* USPSPassword;

- (NSString*)USPSPassword;
- (void)setUSPSPassword :(NSString*)newUSPSPassword;

@property (nonatomic,readwrite,assign,getter=USPSServer,setter=setUSPSServer:) NSString* USPSServer;

- (NSString*)USPSServer;
- (void)setUSPSServer :(NSString*)newUSPSServer;

@property (nonatomic,readwrite,assign,getter=USPSUserId,setter=setUSPSUserId:) NSString* USPSUserId;

- (NSString*)USPSUserId;
- (void)setUSPSUserId :(NSString*)newUSPSUserId;

 

Default Value

""

Remarks

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

CancelPackage Method (USPSShipIntl Module)

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

Syntax

• Swift
• Objective-C

public func cancelPackage(barcodeNumber: String) throws -> String

- (NSString*)cancelPackage:(NSString*)barcodeNumber;

Remarks

The Cancel request allows an eVS label to be removed from processing. This functionality is available only if the eVS label is pending inclusion in the Shipping Services.

The BarcodeNumber parameter that identifies the package to be canceled and deleted from the shipping log, is the PackagesTrackingNumber assigned to the package by USPS server when the GetPackageLabel method was called.

If the BarcodeNumber entered is valid (matches the existing record and is within the time frames available for cancellation), this method will return with no error. The return value for this method is a string containing a message from USPS about the request to cancel the eVS Label.

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

GetPackageLabel Method (USPSShipIntl Module)

Generates a shipping label for the first package in the shipment. When PostageProvider is set to ppNone the GetPackageLabel method will generate an eVS label.

Syntax

• Swift
• Objective-C

public func getPackageLabel() throws -> Void

- (void)getPackageLabel;

Remarks

When this method is called, the following properties are used to construct the request:

• USPSAccountUserId (required for API authentication)
• SenderContactFirstName (required unless SenderContactCompany is provided)
• SenderContactMiddleInitial (optional)
• SenderContactLastName (required unless SenderContactCompany is provided)
• SenderContactCompany (optional if SenderContactFirstName and SenderContactLastName are provided)
• SenderContactPhone (required)
• SenderAddressAddress1 (required)
• SenderAddressAddress2 (optional)
• SenderAddressCity (required)
• SenderAddressState (required)
• SenderAddressZipCode (required)
• SenderUrbanization (optional)
• SenderCustomsReference (optional)
• RecipientContactFirstName (you must send either a name or RecipientContactCompany (or both))
• RecipientContactLastName (you must send either a name or RecipientContactCompany (or both))
• RecipientContactCompany (optional if name is provided)
• RecipientContactPhone (optional)
• RecipientContactFax (optional)
• RecipientContactEmail (optional)
• RecipientAddressAddress1 (at least one address line is required)
• RecipientAddressAddress2
• RecipientAddress3
• RecipientAddressCity (required)
• RecipientAddressState (Province, optional)
• RecipientAddressCountryCode (required)
• RecipientAddressZipCode (Postal Code, required)
• RecipientAddressAddressFlags (required)
• RecipientCustomsReference (optional)
• NonDeliveryOption (if this is set to "REDIRECT" provide the return address via Config)
• RedirectName (optional)
• RedirectEmail (optional)
• RedirectSMS (optional)
• RedirectAddress (optional)
• RedirectCity (optional)
• RedirectState (optional)
• RedirectZipCode (optional)
• RedirectZip4 (optional)
• PackagesPackagingType (optional)
• CommoditiesDescription (required)
• CommoditiesQuantity (required)
• CommoditiesValue (required)
• CommoditiesWeight (required)
• CommoditiesHarmonizedCode (optional)
• CommoditiesManufacturer (optional)
• UseInsurance (optional)
• InsurancePolicy (optional)
• PackagesInsuredValue (optional)
• PackagesNetCharge (optional - if left blank the server will return the postage cost here)
• PackagesWeight (required)
• PackagesLength (optional)
• PackagesWidth (optional)
• PackagesHeight (optional)
• Machinable (optional)
• Contents (required - if set to ctOther OtherContents must be set)
• Comments (optional)
• LicenseNumber (optional)
• CertificateNumber (optional)
• InvoiceNumber (optional)
• LabelImageType (required)
• ImageLayout (optional)
• CustomerId (optional)
• CustomerId2 (optional)
• MailingLocation (optional)
• ShipDate (optional. If specified must be within 3 days)
• HoldForManifest (optional)
• EELPFC (optional)
• PriceOption (optional)
• MeterPayment (optional)
• ExtraServices (optional)
• ActionCode (optional)
• OptOutOfSPE (optional)
• PermitNumber (optional)
• ImportersReferenceType (optional)
• ImportersContact (optional - Phone, Fax, Email)
• DestinationRateIndicator (optional)
• MID (optional)
• LogisticsManagerMID (optional)
• CRID (optional)
• VendorCode (optional)
• VendorProductVersionNumber (optional)
• PackagesShippingLabelFile (optional if you wish to save the labels to disk)

This method fills the following properties:

• PackagesTrackingNumber
• BarcodeNumber
• PackagesShippingLabel
• PackagesNetCharge
• TotalValue
• SDRValue
• IndemnityCoverage (Priority Mail only)
• Prohibitions
• Observations
• Restrictions
• Regulations
• Notes

If PackagesShippingLabelFile was specified with a path and filename, all of the returned label images will also be saved to disk.

Reset Method (USPSShipIntl Module)

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

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

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

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

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

PackageDetail Type

Represents a single package contained in shipment.

Remarks

This type contains specific information on the package that is part of the whole shipment.

Example: Setting the package elements PackageDetail pckg = new PackageDetail pckg.Weight = "2.0" pckg.Description = "Your order for the 4D Shipping SDK" pckg.ShippingLabelFile = "shipping label for package# 1.pdf"

The fields contained by this type are listed below.

Fields