CanadaPostShipIntl Module

Properties Methods Events Config Settings Errors

Allows you to generate international labels using Canada Post.

Syntax

DShippingSDK.Canadapostshipintl

Remarks

Generating a shipping label can be done by calling the GetPackageLabel method. You will need to specify the Packages details, the Canada Post ServiceType to be used for shipping the package, the origin and destination information, and any other ShipmentSpecialServices that should be associated with the shipment (such as COD, Return Shipment, Deliver to Post Office, etc.).

You should also specify the Commodities for all packages. Note that Canada Post will use this information to generate a commercial invoice, which will be returned to you in PDF format in the InternationalForm property, unless InternationalFormFile is set, in which case the file will be saved to the path specified.

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

Assign each shipment a GroupId and then call GetPackageLabel for each package in the shipment.
Call TransmitShipments with the GroupId for the shipment.
Call GetManifest for each manifest in ManifestDetails.

Note that this only applies when submitting a contract shipment (ie. CanadaPostAccountContractId is set).

If you wish to cancel a package before you call TransmitShipments for that shipment, you can call CancelShipment and the package will be voided.

In order to use this class you will need to have a CanadaPost CanadaPostAccountAccountNumber, which is your customer number. You will also need to have signed up for the Developer Program and obtained a CanadaPostAccountUserId and CanadaPostAccountPassword.

Property List

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


CanadaPostAccount	Login information for Canada Post.
Commodities	Collection of commodity line items.
Firewall	A set of properties related to firewall access.
GroupId	The Group Id that will be associated with the shipment.
InternationalForm	Image of the international form.
InternationalFormFile	The location where the international form files will be written.
Manifest	Image of the manifest.
ManifestDetails	The details returned for a manifest.
ManifestFile	The location where the manifest files will be written.
Notify	Collection of recipients to get notified.
OriginPostalCode	The Postal Code of the client sending location when using the Canada Post provider.
Packages	A collection of packages contained in the shipment.
PaymentMethod	The intended payment method when using Canada Post.
Proxy	A set of properties related to proxy access.
ReasonForExport	The reason for the export.
RecipientAddress	Identifies the recipient's address.
RecipientContact	Identifies the recipient's contact info.
SenderAddress	Identifies the sender's address.
SenderContact	Identifies the sender's contact info.
ServiceType	Identifies the domestic service to use in a ship request.
ShipDate	The date on which the package will be tendered.
ShipmentId	The unique identifier for this shipment.
ShipmentSpecialServices	Contains the collection of special services offered.
SSLAcceptServerCertEncoded	This is the certificate (PEM/Base64 encoded).
SSLCertEncoded	This is the certificate (PEM/Base64 encoded).
SSLCertStore	This is the name of the certificate store for the client certificate.
SSLCertStorePassword	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SSLCertStoreType	This is the type of certificate store for this certificate.
SSLCertSubject	This is the subject of the certificate used for client authentication.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCertEncoded	This is the certificate (PEM/Base64 encoded).
Timeout	A timeout for the module.

Method List

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


CancelShipment	Cancels a shipment.
Config	Sets or retrieves a configuration setting.
GetManifest	Gets the manifest info and file for the specified manifest.
GetPackageLabel	Generates a shipping label for the specified package.
Reset	Resets the internal state of the module and all properties to their default values.
SearchManifests	Search for manifests within a given date range.
TransmitShipments	Submits the shipment information and retrieve the manifest for the specified GroupId.

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.


Error	Information about errors during data delivery.
Notification	Notification returned by the server upon successful request (if applicable).
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Fired when secure connection progress messages are available.

Config Settings

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


CanadaGstAmount[i]	The amount of Goods and Services Tax (GST) for the service.
CanadaHstAmount[i]	The amount of Harmonized Sales Tax (HST) for the service.
CanadaPstAmount[i]	The amount of Provincial Sales Tax (PST) for the service.
CancelPickup	Used to cancel a previously schedule pickup.
CertificateNumber	The number of the government/agency certificate or permit.
CODIncludePostage	Indicates whether the postage should be included in the COD amount.
CODRecipientAddress1	The primary street address of the COD recipient.
CODRecipientAddress2	The secondary street address of the COD recipient.
CODRecipientCity	The city of the COD recipient.
CODRecipientCompany	The company of the COD recipient.
CODRecipientName	The name of the COD recipient.
CODRecipientPostalCode	The postal code of the COD recipient.
CODRecipientProvince	The province of the COD recipient.
CommodityOriginProvince[i]	The province the commodity originated in.
CommoditySKU[i]	The SKU for the commodity.
CommodityUnitMeasure[i]	The unit of measure for the commodity.
ConversionFromCAD	The conversion rate from CAD.
CurrencyCode	The currency code associated with the monetary values present in the request.
ExcludedShipments	List of shipments to be excluded when closing shipments.
GetAllPickupRequests	Used to return all pickup requests for an account.
GetPickupAvailablity	Used to check the availability of pickups.
GetPickupDetails	Used to return additional details for a pickup.
GetPickupPrice	Used to get pricing for a pickup.
HasXPath	Determines whether a specific element exists in the document.
InvoiceNumber	The commercial invoice number.
LabelImageType	The type of label to be requested.
LabelSize	The size of the label.
LicenceNumber	The number of the government/agency import or export license.
PackageReturnTrackingNumber[i]	The tracking number for the return shipment.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
ReasonForExportDescription	The description for the reason for export.
RetryCount	The number of times the module will re-attempt a transaction.
RetryDelay	The amount of time the module will wait before retrying a transaction.
SchedulePickup	Used to schedule a pickup.
ShipmentVersion	The version of the CanadaPost shipping API to be used.
ShowInsuredValue	Indicates that the insured value should be shown.
ShowPackagingInstructions	Indicates that the packaging instructions should be shown.
ShowPostageRate	Indicates that the postage rate should be shown.
UpdatePickup	Used to update a previously scheduled pickup.
XAttrCount	The number of records in the XAttr arrays.
XAttrName[i]	The name of the indexed attribute.
XAttrValue[i]	The value of the indexed attribute.
XChildCount	The number of records in the XChild arrays.
XChildElement[i]	The name of the indexed child element.
XChildText[i]	The text of the indexed child element.
XElement	The name of the current element.
XParent	The parent of the current element.
XPath	Used to set the XPath within the response from the server.
XText	The text of the current element.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowHTTPFallback	Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequest	Set to true to compress the body of a PUT or POST request.
EncodeURL	If set to True the URL will be encoded by the module.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the module will perform a GET on the new location.
HTTP2HeadersWithoutIndexing	HTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersion	The version of HTTP used by the module.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
LogLevel	The level of detail that is logged.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
NegotiatedHTTPVersion	The negotiated HTTP version.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
SentHeaders	The full set of headers as sent by the client.
StatusCode	The status code of the last response from the server.
StatusLine	The first line of the last response from the server.
TransferredData	The contents of the last response from the server.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the module.
TransferredHeaders	The full set of headers as received from the server.
TransferredRequest	The full request as sent by the client.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
UseIDNs	Whether to encode hostnames to internationalized domain names.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the module whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The port in the local host where the module binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
ProxyExceptionsList	A semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
TcpNoDelay	Whether or not to delay when sending packets.
UseIPv6	Whether to use IPv6.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

CanadaPostAccount Property (CanadaPostShipIntl Module)

public var canadaPostAccount: CanadaPostAccount {
  get {...}
  set {...}
}


@property (nonatomic,readwrite,assign,getter=canadaPostAccountNumber,setter=setCanadaPostAccountNumber:) NSString* canadaPostAccountNumber;

- (NSString*)canadaPostAccountNumber;
- (void)setCanadaPostAccountNumber :(NSString*)newCanadaPostAccountNumber;

@property (nonatomic,readwrite,assign,getter=canadaPostContractId,setter=setCanadaPostContractId:) NSString* canadaPostContractId;

- (NSString*)canadaPostContractId;
- (void)setCanadaPostContractId :(NSString*)newCanadaPostContractId;

@property (nonatomic,readwrite,assign,getter=canadaPostPassword,setter=setCanadaPostPassword:) NSString* canadaPostPassword;

- (NSString*)canadaPostPassword;
- (void)setCanadaPostPassword :(NSString*)newCanadaPostPassword;

@property (nonatomic,readwrite,assign,getter=canadaPostServer,setter=setCanadaPostServer:) NSString* canadaPostServer;

- (NSString*)canadaPostServer;
- (void)setCanadaPostServer :(NSString*)newCanadaPostServer;

@property (nonatomic,readwrite,assign,getter=canadaPostUserId,setter=setCanadaPostUserId:) NSString* canadaPostUserId;

- (NSString*)canadaPostUserId;
- (void)setCanadaPostUserId :(NSString*)newCanadaPostUserId;

Default Value

Remarks

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

Commodities Property (CanadaPostShipIntl 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;

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

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

- (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 regardless of the fact that it contains documents or non-documents.

Each commodity item has a:

(required)
(required)
(required)
(optional)
(required)
(required)

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) = "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) = "150.00" // each iPod priced at $150

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

GroupId Property (CanadaPostShipIntl Module)

The Group Id that will be associated with the shipment.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=groupId,setter=setGroupId:) NSString* groupId;

- (NSString*)groupId;
- (void)setGroupId :(NSString*)newGroupId;

Default Value

Remarks

This property is used to specify the Group Id that will be associated with the shipment.

This is a user specified value and may be a number or string up to 32 characters in length. It is used by Canada Post to group shipments together for reporting purposes. If the specified group does not exist, it will be created automatically by the Canada Post service.

This value is required when CanadaPostAccountContractId is specified.

InternationalForm Property (CanadaPostShipIntl Module)

Image of the international form.

Syntax

Swift
Objective-C

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


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

- (NSString*)internationalForm;

Default Value

Remarks

This is the decoded binary image file of the international form and will be populated on a GetPackageLabel call if ManifestFile is not set.

This property is read-only.

InternationalFormFile Property (CanadaPostShipIntl Module)

The location where the international form files will be written.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=internationalFormFile,setter=setInternationalFormFile:) NSString* internationalFormFile;

- (NSString*)internationalFormFile;
- (void)setInternationalFormFile :(NSString*)newInternationalFormFile;

Default Value

Remarks

This should contain the full path to where the international form file will be written.

Manifest Property (CanadaPostShipIntl Module)

Image of the manifest.

Syntax

Swift
Objective-C

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


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

- (NSString*)manifest;

Default Value

Remarks

This is the decoded binary image file of the Manifest and will be populated on a GetManifest call if ManifestFile is not set.

This property is read-only.

ManifestDetails Property (CanadaPostShipIntl Module)

The details returned for a manifest.

Syntax

Swift
Objective-C

public var manifestDetails: Array<ManifestDetail> {
  get {...}
}


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

- (int)manifestCount;

- (NSString*)manifestAccountNumber:(int)manifestIdx;

- (NSString*)manifestBaseCharge:(int)manifestIdx;

- (NSString*)manifestCCAuthCode:(int)manifestIdx;

- (NSString*)manifestCCAuthTimestamp:(int)manifestIdx;

- (NSString*)manifestCCMerchantName:(int)manifestIdx;

- (NSString*)manifestCCMerchantURL:(int)manifestIdx;

- (NSString*)manifestCCNameOnCard:(int)manifestIdx;

- (NSString*)manifestContractId:(int)manifestIdx;

- (NSString*)manifestCustomerReference:(int)manifestIdx;

- (NSString*)manifestDate:(int)manifestIdx;

- (NSString*)manifestDestinationPostalCode:(int)manifestIdx;

- (NSString*)manifestGST:(int)manifestIdx;

- (NSString*)manifestHST:(int)manifestIdx;

- (NSString*)manifestMediaType:(int)manifestIdx;

- (NSString*)manifestNetCharge:(int)manifestIdx;

- (NSString*)manifestOriginId:(int)manifestIdx;

- (NSString*)manifestOriginName:(int)manifestIdx;

- (NSString*)manifestPayorAccountNumber:(int)manifestIdx;

- (NSString*)manifestPONumber:(int)manifestIdx;

- (NSString*)manifestPST:(int)manifestIdx;

- (NSString*)manifestShipperAccountNumber:(int)manifestIdx;

- (NSString*)manifestTime:(int)manifestIdx;

- (NSString*)manifestTotalDiscount:(int)manifestIdx;

- (NSString*)manifestTotalSurcharge:(int)manifestIdx;

- (NSString*)manifestURL:(int)manifestIdx;

Default Value

Remarks

This provides the manifest details returned after a call to TransmitShipments or SearchManifests.

ManifestFile Property (CanadaPostShipIntl Module)

The location where the manifest files will be written.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=manifestFile,setter=setManifestFile:) NSString* manifestFile;

- (NSString*)manifestFile;
- (void)setManifestFile :(NSString*)newManifestFile;

Default Value

Remarks

This should contain the full path to where the manifest file will be written.

Notify Property (CanadaPostShipIntl Module)

Collection of recipients to get notified.

Syntax

Swift
Objective-C

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


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

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

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

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

Default Value

Remarks

The Notify is required to be provided when the Deliver to Post Office flag has been set on the ShipmentSpecialServices property.

For each idx = 0 to NotifyCount - 1, this must be set to an instance of the NotifyDetail type, which will contain specific information about the recipient to be notified via email. See the NotifyDetail type for more information.

Each recipient to receive an e-mail notification has a (required), (optional), (optional), and (optional).

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

class.(0) = "test@test.com" class.(0) = (0x01 | 0x04); // (NOTIFY_FLAG_DELIVERY | NOTIFY_FLAG_SHIPMENT)

OriginPostalCode Property (CanadaPostShipIntl Module)

The Postal Code of the client sending location when using the Canada Post provider.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=originPostalCode,setter=setOriginPostalCode:) NSString* originPostalCode;

- (NSString*)originPostalCode;
- (void)setOriginPostalCode :(NSString*)newOriginPostalCode;

Default Value

Remarks

This property is used to specify the postal code of the client sending location to determine the nearest Post Office (this information is used for pricing). To force selection of a particular Post Office, the postal code of the desired Post Office should be used.

If packages are picked up by Canada Post enter the postal code of your location.

This must be set to a valid six character postal code such as A9A9A9

Note: This value is only used when a CanadaPostAccountContractId is specified.

Packages Property (CanadaPostShipIntl 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;

- (NSString*)packageCODFile:(int)packageIdx;
- (void)setPackageCODFile:(int)packageIdx :(NSString*)newPackageCODFile;

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

- (NSData*)packageCODLabelB:(int)packageIdx;
- (int)packageCODType:(int)packageIdx;
- (void)setPackageCODType:(int)packageIdx :(int)newPackageCODType;

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

- (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*)packageRatingAggregate:(int)packageIdx;

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

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

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

- (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 Canada Post the PackagesPackagingType and the PackagesWeight must be specified. The PackagesLength, PackagesWidth, PackagesHeight, PackagesInsuredValue, and PackagesSpecialServices are optional.

PaymentMethod Property (CanadaPostShipIntl Module)

The intended payment method when using Canada Post.

Syntax

Swift
Objective-C

public var paymentMethod: CanadapostshipintlPaymentMethods {
  get {...}
  set {...}
}

public enum CanadapostshipintlPaymentMethods: Int32 {
  case pmAccount = 0
  case pmCreditCard = 1
}


@property (nonatomic,readwrite,assign,getter=paymentMethod,setter=setPaymentMethod:) int paymentMethod;

- (int)paymentMethod;
- (void)setPaymentMethod :(int)newPaymentMethod;

Default Value

Remarks

This field is used to specify the intended method of payment when shipping via Canada Post.

The available values are:


Value	Meaning
0 (default)	Account
1	Credit Card

Note: This value is only used when a CanadaPostAccountContractId is specified.

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

ReasonForExport Property (CanadaPostShipIntl Module)

The reason for the export.

Syntax

Swift
Objective-C

public var reasonForExport: CanadapostshipintlReasonForExports {
  get {...}
  set {...}
}

public enum CanadapostshipintlReasonForExports: Int32 {
  case erGift = 0
  case erDocument = 1
  case erCommercialSample = 2
  case erRepair = 3
  case erSale = 4
  case erOther = 5
}


@property (nonatomic,readwrite,assign,getter=reasonForExport,setter=setReasonForExport:) int reasonForExport;

- (int)reasonForExport;
- (void)setReasonForExport :(int)newReasonForExport;

Default Value

Remarks

This provides the reason for the export, which is necessary to generate the customs forms.

The valid values are as follows:


Value	Meaning
erGift (0)	Gift
erDocument (1)	Documents
erCommercialSample (2)	Commercial Sample
erRepair (3)	Repair or Warranty
erSale (4)	Sale
erOther (5)	Other reason, specified in ReasonForExportDescription

RecipientAddress Property (CanadaPostShipIntl Module)

Identifies the recipient's address.

Syntax

Swift
Objective-C

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


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

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

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

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

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

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

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

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

@property (nonatomic,readwrite,assign,getter=recipientPostalCode,setter=setRecipientPostalCode:) NSString* recipientPostalCode;

- (NSString*)recipientPostalCode;
- (void)setRecipientPostalCode :(NSString*)newRecipientPostalCode;

@property (nonatomic,readwrite,assign,getter=recipientProvince,setter=setRecipientProvince:) NSString* recipientProvince;

- (NSString*)recipientProvince;
- (void)setRecipientProvince :(NSString*)newRecipientProvince;

Default Value

Remarks

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

RecipientContact Property (CanadaPostShipIntl 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=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.

SenderAddress Property (CanadaPostShipIntl Module)

Identifies the sender's address.

Syntax

Swift
Objective-C

public var senderAddress: CanadaPostAddressDetail {
  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=senderPostalCode,setter=setSenderPostalCode:) NSString* senderPostalCode;

- (NSString*)senderPostalCode;
- (void)setSenderPostalCode :(NSString*)newSenderPostalCode;

@property (nonatomic,readwrite,assign,getter=senderProvince,setter=setSenderProvince:) NSString* senderProvince;

- (NSString*)senderProvince;
- (void)setSenderProvince :(NSString*)newSenderProvince;

Default Value

Remarks

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

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

SenderContact Property (CanadaPostShipIntl 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=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.

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

Identifies the domestic service to use in a ship request.

Syntax

Swift
Objective-C

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

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

Remarks

This property is required to be provided in a ship request.

Valid values for Canada Post are:


stCanadaPriorityEnvelopeUSA (95)
stCanadaPriorityPakUSA (96)
stCanadaPriorityParcelUSA (97)
stCanadaXpresspostUSA (98)
stCanadaExpeditedParcelUSA (99)
stCanadaSmallPacketAirUSA (100)
stCanadaSmallPacketLandUSA (101)
stCanadaPriorityEnvelopeInternational (102)
stCanadaPriorityPakInternational (103)
stCanadaPriorityParcelInternational (104)
stCanadaXpresspostInternational (105)
stCanadaSmallPacketAirInternational (106)
stCanadaSmallPacketLandInternational (107)
stCanadaParcelAirInternational (108)
stCanadaParcelLandInternational (109)

ShipDate Property (CanadaPostShipIntl Module)

The date on which the package will be tendered.

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 property contains the expected ship date for the package(s).

ShipmentId Property (CanadaPostShipIntl Module)

The unique identifier for this shipment.

Syntax

Swift
Objective-C

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


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

- (NSString*)shipmentId;

Default Value

Remarks

A unique identifier for the shipment. This can be used in any future calls to TransmitShipments, using the ExcludedShipments config to indicate that this shipment is to be excluded from the manifest.

This property is read-only.

ShipmentSpecialServices Property (CanadaPostShipIntl Module)

Contains the collection of special services offered.

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

Remarks

To request any of the special services offered by Canada Post 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:


Value	Meaning
0x0000000008000000L	Return shipment
0x0000800000000000L	Card for pickup
0x0001000000000000L	Do not safe drop
0x0004000000000000L	Return at sender's expense
0x0008000000000000L	Return to sender
0x0010000000000000L	Abandon

Return Shipment

This indicates that a return shipment is requested. If you wish to have the return shipment go to a different address, you can set the ReturnAddress and ReturnContact properties.

Card for Pickup

When this is set, the package will be held at the post office and the recipient will be notified that their package is ready to be picked up. The recipient must show ID before they can pickup the package.

Do Not Safe Drop

Indicates that if no one is available to accept the package when delivery is attempted, a Delivery Notice Card is left and the recipient must pick up the package at the post office.

Return at Sender's Expense

This indicates that if unable to delivery the package, the package should be returned to the sender at the sender's expense.

Return to Sender

This indicates that if unable to delivery the package, the package should be returned to the sender.

Abandon

This indicates that if unable to delivery the package, the package should be abandoned.

SSLAcceptServerCertEncoded Property (CanadaPostShipIntl 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 (CanadaPostShipIntl 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 (CanadaPostShipIntl 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:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.

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

This is the type of certificate store for this certificate.

Syntax

Swift
Objective-C

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

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

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:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the SSLCertStore and set SSLCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

SSLCertSubject Property (CanadaPostShipIntl 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:


Field	Meaning
CN	Common Name. This is commonly a hostname like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

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

This specifies the SSL/TLS implementation to use.

Syntax

Swift
Objective-C

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

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

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:


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.

SSLServerCertEncoded Property (CanadaPostShipIntl 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 (CanadaPostShipIntl 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

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.

CancelShipment Method (CanadaPostShipIntl Module)

Cancels a shipment.

Syntax

Swift
Objective-C

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

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

Remarks

This method cancels a shipment. The ShipmentId parameter is the value returned by the ShipmentId property when GetPackageLabel was called.

Note: This is only valid for shipments created using a contract (e.g. when CanadaPostAccountContractId is specified) and must be called before TransmitShipments has been called for the specified shipment;

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

GetManifest Method (CanadaPostShipIntl Module)

Gets the manifest info and file for the specified manifest.

Syntax

Swift
Objective-C

public func getManifest(manifestIdx: Int32) throws -> Void

- (void)getManifest:(int)manifestIdx;

Remarks

When called, this will populate the manifest details in ManifestDetails at the specified index, specified by ManifestIdx. It will also write the manifest file to the path specified in ManifestFile.

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

Assign each shipment a GroupId and then call GetPackageLabel for each package in the shipment.
Call TransmitShipments with the GroupId for the shipment.
Call GetManifest for each manifest in ManifestDetails.

Note that this only applies when submitting a contract shipment (ie. CanadaPostAccountContractId is set).

GetPackageLabel Method (CanadaPostShipIntl Module)

Generates a shipping label for the specified package.

Syntax

Swift
Objective-C

public func getPackageLabel(packageIndex: Int32) throws -> Void

- (void)getPackageLabel:(int)packageIndex;

Remarks

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

CanadaPostAccount (required)
Commodities (required)
GroupId (required if CanadaPostAccountContractId is set)
Packages (required)
PaymentMethod (required if CanadaPostAccountContractId is set)
ReasonForExport (required)
RecipientContact (required)
RecipientAddress (required)
SenderContact (required)
SenderAddress (required)
ServiceType (required)
ShipmentSpecialServices (optional)

To print out the PackagesShippingLabel, you can save it to the PackagesShippingLabelFile file in LabelImageType format.

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

SearchManifests Method (CanadaPostShipIntl Module)

Search for manifests within a given date range.

Syntax

Swift
Objective-C

public func searchManifests(startDate: String, endDate: String) throws -> Void

- (void)searchManifests:(NSString*)startDate :(NSString*)endDate;

Remarks

This will retrieve any manifests printed between the StartDate and EndDate and populates the ManifestDetailsURL. The date must be specified in the format "YYYYMMDD".

TransmitShipments Method (CanadaPostShipIntl Module)

Submits the shipment information and retrieve the manifest for the specified GroupId.

Syntax

Swift
Objective-C

public func transmitShipments() throws -> Void

- (void)transmitShipments;

Remarks

This will transmit the shipment information for the specified GroupId and print the manifest for that shipment.

If you wish to get the manifest for more than one group, you can specify more than one group ID in a comma separated list in the GroupId property.

The following properties must be set before making a call to TransmitShipments:

ExcludedShipments (Optional)
GroupId (Required)
ManifestFile (Required)
SenderAddress (Required)

In order to print a label and manifest to be tendered to a Canada Post driver, you must:

Assign each shipment a GroupId and then call GetPackageLabel for each package in the shipment.
Call TransmitShipments with the GroupId for the shipment.
Call GetManifest for each manifest in ManifestDetails.

Note that this only applies when submitting a contract shipment (ie. CanadaPostAccountContractId is set).

Error Event (CanadaPostShipIntl 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 (CanadaPostShipIntl 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 (CanadaPostShipIntl 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 (CanadaPostShipIntl 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.

CanadaPostAccount Type

Represents the details of a shipper account.

Remarks

This type contains data describing the server and login information.

Example: Setting the fields of an account for Canada Post servers CanadaPostAccount account = new CanadaPostAccount account.AccountNumber = "1234567" account.UserId = "1234567" account.Password = "my_password" account.Server = "https://ct.soa-gw.canadapost.ca"

The properties contained by this type are listed below.

Fields

accountNumber
String
Default Value: ""

The shipper's account number.

This field should be set to the customer number of the owner of the mail (mailed on behalf of customer).

contractId
String
Default Value: ""

This property is used to specify the Contract Id of a Canada Post account and is used to identify a commercial contract.

When specified the negotiated rates for the contract will be used. If not specified the standard list rates will be used.

password
String
Default Value: ""

Password for logging in to the Server.

This property must be set to the login password for your Canada Post account.

server
String
Default Value: "https://soa-gw.canadapost.ca/"

URL for the server where the requests are sent.

By default this is set to Canada Post's production server: "https://soa-gw.canadapost.ca/"

userId
String
Default Value: ""

User Id for logging in to the .

This property must be set to the login username for your Canada Post account

Constructors

public init()

CanadaPostAddressDetail 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 = "1425 James St" addr.Address2 = "PO Box 4001 Stn A" addr.City = "Victoria" addr.Province = "BC" addr.PostalCode = "V8X3X4" addr.CountryCode = "CA"

The properties contained by this type are listed below.

Fields

address1
String
Default Value: ""

Street name. In a ship request, this is required to be provided for both sender and recipient. In all other requests, it is required for a valid physical address.

Maximum Length: 44 characters

address2
String
Default Value: ""

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional.

Maximum Length: 44 characters

city
String
Default Value: ""

Name of city, town, etc. In a ship request, this is required to be provided for both sender and recipient.

countryCode
String
Default Value: "CA"

Country code. This identifies a country. In a ship request, this is required to be provided for both sender and recipient. Maximum length: 2.

Here is a list of country names and their codes. Code is the value that has to be provided in all requests sent where country code is to be entered.


Country Name	Country Code
Afghanistan	AF
Albania	AL
American Samoa	AS
Andorra	AD
Angola	AO
Anguilla	AI
Antigua	AG
Argentina	AR
Armenia	AM
Aruba	AW
Australia	AU
Austria	AT
Azerbaijan	AZ
Bahamas	BS
Bahrain	BH
Bangladesh	BD
Barbados	BB
Barbuda	AG
Belarus	BY
Belgium	BE
Belize	BZ
Benin	BJ
Bermuda	BM
Bhutan	BT
Bolivia	BO
Bonaire	AN
Bosnia-Herzegovina	BA
Botswana	BW
Brazil	BR
British Virgin Islands	VG
Brunei	BN
Bulgaria	BG
Burkina Faso	BF
Burundi	BI
Cambodia	KH
Cameroon	CM
Canada	CA
Canary Islands	ES
Cape Verde	CV
Cayman Islands	KY
Chad	TD
Channel Islands	GB
Chile	CL
China	CN
Colombia	CO
Congo	CG
Congo Dem. Rep. Of	CD
Cook Islands	CK
Costa Rica	CR
Croatia	HR
Curacao	AN
Cyprus	CY
Czech Republic	CZ
Denmark	DK
Djibouti	DJ
Dominica	DM
Dominican Republic	DO
East Timor	TL
Ecuador	EC
Egypt	EG
El Salvador	SV
England	GB
Equatorial Guinea	GQ
Eritrea	ER
Estonia	EE
Ethiopia	ET
Faeroe Islands	FO
Fiji	FJ
Finland	FI
France	FR
French Guiana	GF
French Polynesia	PF
Gabon	GA
Gambia	GM
Georgia	GE
Germany	DE
Ghana	GH
Gibraltar	GI
Grand Cayman	KY
Great Britain	GB
Great Thatch Island	VG
Great Tobago Islands	VG
Greece	GR
Greenland	GL
Grenada	GD
Guadeloupe	GP
Guam	GU
Guatemala	GT
Guinea	GN
Guyana	GY
Haiti	HT
Holland	NL
Honduras	HN
Hong Kong	HK
Hungary	HU
Iceland	IS
India	IN
Indonesia	ID
Iraq	IQ
Ireland	IE
Israel	IL
Italy	IT
Ivory Coast	CI
Jamaica	JM
Japan	JP
Jordan	JO
Jost Van Dyke Islands	VG
Kazakhstan	KZ
Kenya	KE
Kuwait	KW
Kyrgyzstan	KG
Laos	LA
Latvia	LV
Lebanon	LB
Lesotho	LS
Liberia	LR
Liechtenstein	LI
Lithuania	LT
Luxembourg	LU
Macau	MO
Macedonia	MK
Madagascar	MG
Malawi	MW
Malaysia	MY
Maldives	MV
Mali	ML
Malta	MT
Marshall Islands	MH
Martinique	MQ
Mauritania	MR
Mauritius	MU
Mexico	MX
Micronesia	FM
Moldova	MD
Monaco	MC
Mongolia	MN
Montserrat	MS
Morocco	MA
Mozambique	MZ
Namibia	NA
Nepal	NP
Netherlands	NL
Netherlands Antilles	AN
New Caledonia	NC
New Zealand	NZ
Nicaragua	NI
Niger	NE
Nigeria	NG
Norman Island	VG
Northern Ireland	GB
Northern Mariana Islands	MP
Norway	NO
Oman	OM
Pakistan	PK
Palau	PW
Palestine	PS
Panama	PA
Papua New Guinea	PG
Paraguay	PY
Peru	PE
Philippines	PH
Poland	PL
Portugal	PT
Puerto Rico	PR
Qatar	QA
Reunion	RE
Romania	RO
Rota	MP
Russia	RU
Rwanda	RW
Saba	AN
Saipan	MP
Samoa	WS
San Marino	IT
Saudi Arabia	SA
Scotland	GB
Senegal	SN
Serbia & Montenegro	CS
Seychelles	SC
Singapore	SG
Slovak Republic	SK
Slovenia	SI
South Africa	ZA
South Korea	KR
Spain	ES
Sri Lanka	LK
St. Barthelemy	GP
St. Christopher	KN
St. Croix Island	VI
St. Eustatius	AN
St. John	VI
St. Kitts and Nevis	KN
St. Lucia	LC
St. Maarten	AN
St. Thomas	VI
St. Vincent	VC
Suriname	SR
Swaziland	SZ
Sweden	SE
Switzerland	CH
Tahiti	PF
Taiwan	TW
Tanzania	TZ
Thailand	TH
Tinian	MP
Togo	TG
Tonga	TO
Tortola Island	VG
Trinidad & Tobago	TT
Tunisia	TN
Turkey	TR
Turkmenistan	TM
Turks & Caicos Islands	TC
U.S. Virgin Islands	VI
Uganda	UG
Ukraine	UA
Union Island	VC
United Arab Emirates	AE
United Kingdom	GB
United States	US
Uruguay	UY
Uzbekistan	UZ
Vanuatu	VU
Vatican City	IT
Venezuela	VE
Vietnam	VN
Wales	GB
Wallis & Futuna Islands	WF
Yemen	YE
Zambia	ZM
Zimbabwe	ZW

postalCode
String
Default Value: ""

This is identifies of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country. The format for Canadian postal codes is A9A9A9.

In a ship request, this is required to be provided for both sender and recipient. In all other requests, this element is required if both and are not present.

Valid characters: A-Z; 0-9; a-z. Maximum length: 14.

province
String
Default Value: ""

Province or state code. This is the identifying abbreviation for Canada province, US state, etc. In a ship request, this is required to be provided for both sender and recipient (where applicable). Format and presence of this field will vary, depending on country.

This is required when is either CA or US.

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.


property	Required?
	Yes
	Conditional, required only for ground shipments
	Conditional, required if hazardous materials are contained in the shipment
	No
	Conditional, required if is specified
	Yes
	Yes
	Yes
	Yes

The fields contained by this type are listed below.

Fields

description_
String
Default Value: ""

Complete and accurate description of this commodity line item.

It is applicable to all international forms. Optional for Partial Invoice and required for the rest of form types.

Specific description of the type of equipment and its intended use is required. Clearance delays may result if the contents are not completely and accurately described. Vague description will not be accepted by Customs. Only a portion of this field will print on the label.

For FedEx, if the shipment contains documents only (i.e., Documents is set to True), then the has to be set to an approved value. The following table lists document descriptions approved by U.S. Customs.


Description
Correspondence/No Commercial Value	Leases
Accounting Documents	Legal Documents
Analysis Reports	Letters and Cards
Applications (Completed)	Letter of Credit Packets
Bank Statements	Loan Documents
Bid Quotations	Marriage Certificates
Birth Certificates	Medical Records
Bills of Sale	Office Records
Bonds	Operating Agreements
Business Correspondence	Patent Applications
Checks (Completed)	Permits
Claim Files	Photocopies
Closing Statements	Proposals
Conference Reports	Prospectuses
Contracts	Purchase Orders
Cost Estimates	Quotations
Court Transcripts	Reservation Confirmation
Credit Applications	Resumes
Data Sheets	Sales Agreements
Deeds	Sales Reports
Employment Papers	Shipping Documents
Escrow Instructions	Statements/Reports
Export Papers	Statistical Data
Financial Statements	Stock Information
Immigration Papers	Tax Papers
Income Statements	Trade Confirmation
Insurance Documents	Transcripts
Interoffice Memos	Warranty Deeds
Inventory Reports
Invoices (Completed)

exportType
TExportTypes
Default Value: 0

Indicates the export type. Applicable and required for SED only.

Valid values are:


Value	Meaning
etDomestic (0)	Exports that have been produced, manufactured, or grown in the United States or Puerto Rico. This includes imported merchandise which has been enhanced in value or changed from the form in which imported by further manufacture or processing in the United States or Puerto Rico.
etForeign (1)	Merchandise that has entered the United States and is being exported again in the same condition as when imported.
etForeignMilitary (2)	Exported merchandise that is sold under the foreign military sales program.

NOTE: This field is only applicable to UPS shipments.

freightClass
String
Default Value: ""

Indicates the freight class of the commodity.

The following table lists freight classes available from UPS freight services.


Freight Class
50
55
60
65
70
77.5
85
92.5
100
110
125
150
175
200
250
300
400
500