UPSRates Module

Properties Methods Events Config Settings Errors

Provides domestic or international rates based on weight, service, and origin/destination information.

Syntax

DShippingSDK.Upsrates

Remarks

Rates class provides automated online access to domestic and international rate information and is capable also of rating shipments containing multiple packages. Based on the shipment's input characteristics (origin, destination, shipment weight, special services, etc.), the class provides a list of all applicable UPS services and their respective published rates.

For all shipments inside or between the U.S. and Puerto Rico:

The request that is sent to UPS Server must provide details at the package level. For shipments consisting of only one package, the class identifies all the available UPS domestic and international services and returns shipping rates based on the package's specifications. If the shipment consists of two or more packages, the class will return a separate rate for each package and the rate for the total shipment. The total shipment rate will be a sum of the rates for all packages.

For all shipments outside the U.S. and Puerto Rico:

The request must provide details at the shipment level. For shipments consisting of one or more packages, the class will return one rate for all packages at the shipment level (not at the package level).

To retrieve a list of rates for all services applicable to your shipment, the RequestedService must be set to 0 (stUnspecified) when calling GetRates method. To get a rate for a specified service, the RequestedService must be set to the corresponding value of the UPS service to be rated (other than 0: stUnspecified).

In either scenario, UPS server response will contain negotiated rate(s) only for the qualified UPSAccountAccountNumbers. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

Please note that shipping rates retrieved by this class are estimates based on the information supplied. Other shipping charges may apply and the final shipping charge may differ depending upon your UPS Account Number and how the package is tendered to UPS.

Property List

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


AccountAddress	Identifies the UPS account holder's address, if different from the sender's address.
CODTotalAmount	The total amount to be collected on shipment level.
CODType	The code that indicates the type of funds that will be used for the COD payment.
CustomerType	Customer classification code.
Disclaimer	Disclaimer text.
DutyType	Auto duty type applicable for requests outside the US.
Firewall	A set of properties related to firewall access.
Packages	A collection of packages contained in the shipment.
PackageServiceIndex	The service index in the list of available services returned.
PickupType	Pickup type used for the shipment that rate is requested for.
Proxy	A set of properties related to proxy access.
RecipientAddress	Identifies the recipient's address.
RecipientCandidateAggregate	String representing the list of destination address candidates (if any).
RequestedService	Service type for which the shipping rate is requested.
SenderAddress	Identifies the sender's address from which the shipment is originating.
SenderCandidateAggregate	String representing the list of origin address candidates (if any).
Services	Collection of available services returned.
ShipDate	The date the user requests UPS to pickup the package from the origin.
ShipmentSpecialServices	Contains the collection of special services offered by UPS on shipment level.
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.
TotalValue	Monetary value of shipment contents.
TotalWeight	Total shipment's weight.
UPSAccount	Login information for UPS.

Method List

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


Config	Sets or retrieves a configuration setting.
GetRates	Returns rate information for a specified or all available UPS RequestedService s.
GetShippingTime	Provides the average estimated time to ship a package from an origin to a destination address.
Reset	Resets the internal state of the module and all properties to their default values.

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.


AlternateDeliveryAddress	Alternate Delivery Address is used for Hold for Pickup or Delivery at UPS Access Points.
CurrencyCode	The currency code associated with the monetary values present in the request.
CustomerTransactionId	Customer transaction id / customer context information.
Documents	Whether the shipment contains only documents.
EPRAIndicator	Indicates that a Package Release Code is requested for this shipment.
FRSCommodityCount	Number of commodities in the shipment.
FRSCommodityFreightClass[i]	The freight class of the commodity at the index.
FRSCommodityFreightNMFC[i]	The National Motor Freight Classification numbers for the commodity at the index.
FRSCommodityFreightNMFCSub[i]	The sub-code of National Motor Freight Classification numbers for the commodity at the index.
FRSPaymentAccountNumber	The UPS account number for the payor.
FRSPaymentCountryCode	The country code of the payor for the Ground Freight Pricing shipment.
FRSPaymentDescription	Description for the Ground Freight Pricing payment type.
FRSPaymentPostalCode	The postal code of the payor for the Ground Freight Pricing shipment.
FRSPaymentType	Method of payment for the shipment.
ImportControlCode	Code for type of ImportControl label.
ImportControlDescription	Description for ImportControl.
IncludeNegotiatedRates	Whether to include the NegotiatedRatesIndicator in the request.
ItemizedChargesCode[i]	The Accesorial/Surcharge code of the itemized charge.
ItemizedChargesCount	The count of itemized charges.
ItemizedChargesCurrencyCode[i]	The currency used for the charge.
ItemizedChargesMonetaryValue[i]	The amount being charged.
ItemizedChargesSubType[i]	The subtype of the itemized charge.
MasterCartonIndicator	Determines whether to include the MasterCartonIndicator in the request.
MaxRecords	Maximum number of candidates the user wishes to receive in the response.
NotificationDialect	Used to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications.
NotificationLanguage	Used to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications.
PackageDeclaredValueType[i]	The type of declared value (corresponding to the package at index i).
RateCurrency	The currency of the returned rates.
RatesWarning	Rated shipment warning message.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
RecipientCountryName	Country name to which the shipment is destined.
RecipientTown	Town name to where the shipment is destined (applicable to non-US addresses only).
ReturnFreightPrices	When true, UPS will use applicable freight pricing for shipments.
ReturnServiceCode	The code for the request return service.
SenderCountryName	Country name from which the shipment is originating.
SenderTown	Town name from which the shipment is originating (applicable to non-US addresses only).
ShipmentIndicationType	Whether shipment is Hold For Pickup or Delivery at UPS Access Points.
ShipTime	Local Time of shipment based on shipper's time zone.
SimpleRateCode	Determines the box size for the UPS Simple Rate shipping option.
SubVersion	UPS SubVersion.
TaxInformationIndicator	Controls whether to send a TaxInformationIndicator.
TESTMODE	This configuration setting will allow you to run test transactions.
Version	UPS API Version.
Warning	Warning message returned by the server.
WeightUnit	Weight unit.
WWEShipmentIndicator	Determines whether to include the WWEShipmentIndicator in the request.
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.

AccountAddress Property (UPSRates Module)

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

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


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

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

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

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

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

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

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

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

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

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

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

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

Default Value

Remarks

The AccountAddress is required to be provided in a rate request (when the GetRates method is called) only if the SenderAddress is different from the billing address of the UPSAccountAccountNumber. Otherwise, it defaults to SenderAddress.

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

CODTotalAmount Property (UPSRates Module)

The total amount to be collected on shipment level.

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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

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

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

CODType Property (UPSRates Module)

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

Syntax

Swift
Objective-C

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

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


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

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

Default Value

Remarks

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

Valid values are:


Value	Meaning
codtsCash (0)	Only cash is allowed as form of payment.
codtsCheck (1)	Personal check, cashier's check or money order - no cash allowed.

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

CustomerType Property (UPSRates Module)

Customer classification code.

Syntax

Swift
Objective-C

public var customerType: UpsratesCustomerTypes {
  get {...}
  set {...}
}

public enum UpsratesCustomerTypes: Int32 {
  case ccShipperNumber = 0
  case ccDaily = 1
  case ccRetail = 2
  case ccStandard = 3
  case ccNone = 4
  case ccRegional = 5
  case ccGeneral = 6
}


@property (nonatomic,readwrite,assign,getter=customerType,setter=setCustomerType:) int customerType;

- (int)customerType;
- (void)setCustomerType :(int)newCustomerType;

Default Value

Remarks

The CustomerType is applicable only if SenderAddressCountryCode is US. The rates depend on the combination of PickupType and CustomerType.

Valid values are:


Value	Meaning
ccShipperNumber (0)	Rates associated with the shipper number
ccDaily (1)	Daily Rates
ccRetail (2)	Retail Rates
ccStandard (3)	Standard List Rates
ccNone (4)	None (default)
ccRegional (5)	Regional Rates
ccGeneral (6)	General List Rates

Disclaimer Property (UPSRates Module)

Disclaimer text.

Syntax

Swift
Objective-C

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


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

- (NSString*)disclaimer;

Default Value

Remarks

The Disclaimer is a conditional statement about the validity of the service being guaranteed, based on the SenderAddressCountryCode and RecipientAddressCountryCode. If applicable, this property is filled after a call to the GetShippingTime.

Service Guaranteed Disclaimers


Orig	Dest	Message Text
US	US	Services listed as guaranteed are backed by a money-back guarantee for transportation charges only. UPS guarantees the day of delivery for every ground package you ship to any commercial address in the contiguous 48 states. See Terms and Conditions in the Service Guide for details. Certain commodities and high value shipments may require additional transit time for customs clearance.
US	PR	All services are guaranteed if shipment is paid for in full by a payee in the United States or Puerto Rico. Services listed as guaranteed are backed by a money-back guarantee for transportation charges only. See Terms and Conditions in the Service Guide for details. Certain commodities and high value shipments may require additional transit time for customs clearance.
US	CA	All services are guaranteed if shipment is paid for in full by a payee in the United States or Canada. Services listed as guaranteed are backed by a moneyback guarantee for transportation charges only. See Terms and Conditions in the Service Guide for details. Certain commodities and high value shipments may require additional transit time for customs clearance.
US	Other
Other	US	All services are guaranteed if shipment is paid for in full by a payee in the United States. Services listed as guaranteed are backed by a money-back guarantee for transportation charges only. See Terms and Conditions in the Service Guide for details. Certain commodities and high value shipments may require additional transit time for customs clearance.
PR	Other
PR	PR
PR	Other	All services are guaranteed if shipment is paid for in full by a payee in Puerto Rico. Services listed as guaranteed are backed by a money-back guarantee for transportation charges only. See Terms and Conditions in the Service Guide for details. Certain commodities and high value shipments may require additional transit time for customs clearance.
PR	US	All services are guaranteed if shipment is paid for in full by a payee in Puerto Rico or the United States. Services listed as guaranteed are backed by a money-back guarantee for transportation charges only. See Terms and Conditions in the Service Guide for details. Certain commodities and high value shipments may require additional transit time for customs clearance.

This property is read-only.

DutyType Property (UPSRates Module)

Auto duty type applicable for requests outside the US.

Syntax

Swift
Objective-C

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


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

- (NSString*)dutyType;

Default Value

"Dutiable"

Remarks

The duty is automatically calculated in such requests if the Documents is set to False. This is returned in the server response only for requests outside the US.

The possible values to be returned:


Dutiable
Non-Dutiable
Low-value
Courier Remission
Gift
Military
Exception
Line Release
Section 321 Low Value

All US domestic letters and documents are Non-Dutiable.

For non-documents the following logic applies:

a. When export and import countries are the same, duty type is Non-Dutiable;
b. All European transborder shipments (country pair must be found on DGTM TBL #462) are Non-Dutiable;
c. If not found in step b, the duty type is assigned from the first value larger or equal to the converted customs declared value (order by declared value ascending) for that import country;
If not found, default the duty type to Dutiable;

Note: When processing auto duty logic and for any reason the program experiences problems getting the duty type, the duty type will be defaulted to Dutiable. If the CurrencyCode is the same as the import currency code, there will be no currency conversion and the entered value will be used in the determination of the auto duty logic.

This property is read-only.

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

Packages Property (UPSRates Module)

A collection of packages contained in the shipment.

Syntax

Swift
Objective-C

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


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

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

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

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

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

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

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

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

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

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

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

Default Value

Remarks

At least one package must be specified.

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

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

PackageServiceIndex Property (UPSRates Module)

The service index in the list of available services returned.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=packageServiceIndex,setter=setPackageServiceIndex:) int packageServiceIndex;

- (int)packageServiceIndex;
- (void)setPackageServiceIndex :(int)newPackageServiceIndex;

Default Value

Remarks

To retrieve all rating attributes on package level (PackagesBaseCharge, PackagesTotalSurcharges, PackagesNetCharge, and PackagesRatingAggregate) you must set the PackageServiceIndex from 0 to ServiceCount - 1 for each PackageIndex from 0 to PackageCount - 1.

PickupType Property (UPSRates Module)

Pickup type used for the shipment that rate is requested for.

Syntax

Swift
Objective-C

public var pickupType: UpsratesPickupTypes {
  get {...}
  set {...}
}

public enum UpsratesPickupTypes: Int32 {
  case ptDailyPickup = 0
  case ptCustomerCounter = 1
  case ptOneTimePickup = 2
  case ptOnCallAir = 3
  case ptLetterCenter = 4
  case ptAirServiceCenter = 5
  case ptNoneType = 6
}


@property (nonatomic,readwrite,assign,getter=pickupType,setter=setPickupType:) int pickupType;

- (int)pickupType;
- (void)setPickupType :(int)newPickupType;

Default Value

Remarks

The rates depend on the combination of PickupType and CustomerType.

Valid values are:


Value	Description
ptDailyPickup (0)	Daily Pickup
ptCustomerCounter (1)	Customer Counter
ptOneTimePickup (2)	One Time Pickup
ptOnCallAir (3)	On Call Air
ptLetterCenter (4)	Letter Center
ptAirServiceCenter (5)	Air Service Center
ptNoneType (6)	None

Proxy Property (UPSRates 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 (UPSRates 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 rate request (when the GetRates method is called). The Residential flag in the RecipientAddressAddressFlags property is applicable for US domestic requests only. When this is set, it indicates that the rate request is made for Residential delivery address. Otherwise, the rate query is calculated for a Commercial delivery address.

Requests outside the US will only be calculated for Commercial. In this case, even if the Residential flag is set, the entry will be ignored.

If negotiated rates are requested to be received, then the RecipientAddressState is required to be provided in the request. Otherwise, it is optional.

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.

RecipientCandidateAggregate Property (UPSRates Module)

String representing the list of destination address candidates (if any).

Syntax

Swift
Objective-C

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


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

- (NSString*)recipientCandidateAggregate;

Default Value

Remarks

If the destination address provided in the time-in-transit request (when the GetShippingTime method is called) is an invalid address, a list of potential candidates for the destination address will be returned in the server response. This is applicable for US only.

This destination address candidate list will be stored as a string in RecipientCandidateAggregate, formatted as JSON.

To get the detailed information for each destination address candidate (city, state, zip code range), the UPSAddress class can be used. To read an address, set the Aggregate property of an UPSAddress class to this value, and read the values of the desired fields for each candidate from 0 to UPSAddress's MatchCount - 1 .

The returned candidate list will be ordered according to a level of confidence. The first candidate returned has the highest level of confidence based on the information provided in the request. You can choose the correct address and resubmit the Time-in-Transit request (by calling the GetShippingTime method again) using any of these candidates as the origin and/or destination addresses to get service specific values.

This property is read-only.

RequestedService Property (UPSRates Module)

Service type for which the shipping rate is requested.

Syntax

Swift
Objective-C

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

public enum UpsratesRequestedServices: 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=requestedService,setter=setRequestedService:) int requestedService;

- (int)requestedService;
- (void)setRequestedService :(int)newRequestedService;

Default Value

Remarks

This property is required to be entered in the request only if the rate request is made for a specific UPS service type. In this case, the RequestedService should be set to a value different from 'stUnspecified'.

Otherwise, the rate request will be considered by the UPS server as it has been made for all available services and respective rates to ship a package from the SenderAddress to RecipientAddress. The availability and the description of UPS services depend on the country of origin.

Valid values for UPS are:


Value	Applicable for
stUnspecified (0)
stUPSFirstClass(35)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMail(36)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSExpeditedMailInnovations(37)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMailInnovations (38)	All origins, requires a contract with Mail Innovations, single package shipments only
stUPSEconomyMailInnovations (39)	All Origins, requires a contract with Mail Innovations, single package shipments only
stUPSNextDayAir (40)	US Domestic Shipments; Originating in US/PR
stUPSExpress (41)	Polish Domestic Shipments; All Origins
stUPS2ndDayAir (42)	US Domestic Shipments; Originating in US/PR
stUPSGround (43)	US Domestic Shipments; Originating in US/PR
stUPSWorldwideExpress (44)	Originating in US/PR
stUPSWorldwideExpedited (45)	US/PR, Canada and Non-EU origins, EXCEPT Mexico
stUPSExpedited (46)	Polish Domestic Shipments; Originating in EU or Mexico
stUPSStandard (47)	Polish Domestic Shipments; All Origins
stUPS3DaySelect (48)	US Domestic Shipments; Originating in CA or US
stUPSNextDayAirSaver (49)	US Domestic Shipments
stUPSSaver (50)	US or Polish Domestic Shipments; All Origins
stUPSNextDayAirEarlyAM (51)	US Domestic Shipments; Originating in CA or US/PR
stUPSExpressEarlyAM (52)	Originating in CA
stUPSWorldwideExpressPlus (53)	Polish Domestic Shipments; All Origins EXCEPT Canada and Mexico
stUPSExpressPlus (54)	Originating in Mexico
stUPS2ndDayAirAM (55)	US Domestic Shipments; Originating in US
stUPSTodayStandard (56)	Polish Domestic Shipments (Stolica)
stUPSTodayCourrier (57)	Polish Domestic Shipments (Stolica)
stUPSTodayInterCity (58)	Polish Domestic Shipments (Stolica)
stUPSTodayExpress (59)	Polish Domestic Shipments (Stolica)
stUPSTodayExpressSaver (60)	Polish Domestic Shipments (Stolica)
stUPSWorldwideExpressFreight (61)	All Origins; Worldwide Express Freight
stUPSSurePostLessThan1LB (62)	US Domestic Shipments, SurePost Less Than 1LB
stUPSSurePost1LBOrGreater (63)	US Domestic Shipments, SurePost 1LB Or Greater
stUPSSurePostBPM (64)	US Domestic Shipments, SurePost BPM (Bound Printed Matter)
stUPSSurePostMedia (65)	US Domestic Shipments, SurePost Media
stUPSWorldwideEconomyDDU (131)	Originating in Canada or US, requires a contract with UPS
stUPSWorldwideEconomyDDP (132)	Originating in Canada or US, requires a contract with UPS

Note: stUPSSaver (50) is a valid option for US domestic shipment, but only when sending to remote parts of Alaska or Hawaii Note: stUPSFirstClass (35), stUPSPriorityMail (36), stUPSExpeditedMailInnovations (37), stUPSPriorityMailInnovations (38), and stUPSEconomyMailInnovations (39) will not return any rates.

SenderAddress Property (UPSRates Module)

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

Syntax

Swift
Objective-C

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


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

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

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

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

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

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

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

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

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

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

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

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

Default Value

Remarks

The SenderAddress is required to be provided in a rate request (when the GetRates method is called).

If negotiated rates are requested to be received, then the SenderAddressState is required to be provided in the request. Otherwise, it is optional.

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

SenderCandidateAggregate Property (UPSRates Module)

String representing the list of origin address candidates (if any).

Syntax

Swift
Objective-C

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


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

- (NSString*)senderCandidateAggregate;

Default Value

Remarks

If the origin address provided in the time-in-transit request (when the GetShippingTime method is called) is an invalid address, a list of potential candidates for the origin address will be returned in the server response. This is applicable for US only.

This origin address candidate list will be stored as a string in SenderCandidateAggregate, formatted as JSON.

To get the detailed information for each origin address candidate (city, state, zip code range), the UPSAddress class can be used. To read an address, set the Aggregate property of an UPSAddress class to this value, and read the values of the desired fields for each candidate from 0 to UPSAddress's MatchCount - 1 .

This property is read-only.

Services Property (UPSRates Module)

Collection of available services returned.

Syntax

Swift
Objective-C

public var services: Array<ServiceDetail> {
  get {...}
}


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

- (int)serviceCount;

- (NSString*)serviceAccountNetCharge:(int)serviceIdx;

- (NSString*)serviceAggregate:(int)serviceIdx;

- (int)serviceBusinessDays:(int)serviceIdx;

- (NSString*)serviceCustomerCenterCutoff:(int)serviceIdx;

- (int)serviceDelayDays:(int)serviceIdx;

- (NSString*)serviceDeliveryDate:(int)serviceIdx;

- (NSString*)serviceDeliveryDay:(int)serviceIdx;

- (NSString*)serviceDeliveryTime:(int)serviceIdx;

- (NSString*)serviceGuaranteedDescription:(int)serviceIdx;

- (int)serviceHolidays:(int)serviceIdx;

- (NSString*)serviceListBaseCharge:(int)serviceIdx;

- (NSString*)serviceListNetCharge:(int)serviceIdx;

- (NSString*)serviceListTotalSurcharge:(int)serviceIdx;

- (int)serviceRestDays:(int)serviceIdx;

- (int)serviceType:(int)serviceIdx;

- (NSString*)serviceTypeDescription:(int)serviceIdx;

- (NSString*)serviceShipDate:(int)serviceIdx;

- (NSString*)serviceShipTime:(int)serviceIdx;

- (NSString*)serviceTransitTime:(int)serviceIdx;

Default Value

Remarks

This property will contain the list of all available UPS services that satisfy the rate request. It should be inspected after a call to GetRates. Each service has a , , , , , , , , tied to it.

For instance, if the response contains only one available service that satisfies the search criteria: ServiceCount = 1, (0) = "UPS Next Day Air", (0) = "1",

ShipDate Property (UPSRates Module)

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

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

This is required to be provided when GetShippingTime method is called. Query cannot exceed 60 days into the future.

This should be entered in this format: YYYYMMDD.

ShipmentSpecialServices Property (UPSRates Module)

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

Syntax

Swift
Objective-C

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


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

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

Default Value

Remarks

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


Value	Meaning
0x00008000L	Hold for Pickup
0x00100000L	Liftgate Dropoff
0x00200000L	Liftgate Pickup
0x08000000L	Return Shipment
0x10000000L	Saturday Delivery
0x20000000L	Saturday Pickup
0x20000000000L	Return of Document
0x40000000000L	Import Control
0x80000000000L	Commercial Invoice Removal
0x0100000000000L	Exchange Forward
0x0200000000000L	Carbon Neutral
0x0400000000000L	Dropoff at UPS Facility
0x0020000000000000L	Deliver To Addressee Only
0x0040000000000000L	Direct Delivery Only

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

Hold for Pickup: This indicates that UPS should deliver your package to the UPS Customer Center you choose and then call the recipient when the package is ready.
This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.
Liftgate Dropoff: This requests that UPs provide their liftgate services unload a shipment when unloading docks are not available.
This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.
Liftgate Pickup: This requests that UPs provide their liftgate services load a shipment when loading docks are not available.
This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.
Return Shipment: This is applicable to return shipments only. Indicates that the ship request is made for Print Return Label (PRL). With this option you can print a return label to include in an outbound shipment, or provide a label to your customer separately.
If you want to arrange for UPS to mail a return label to your customer, you can use the ReturnPrintAndMail config setting.

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

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

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

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

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

Also please note that when you set this option that only the return label is being printed, you must submit a separate request to print the shipping label.
Saturday Delivery: Indicates that you request to have the shipment delivered on a Saturday. Saturday delivery service is available for an additional charge depending on the package service type and origin/destination pair. This service is not available for return shipments.
Saturday Pickup: The presence indicates Saturdary pickup is requested. Saturday pickup service is available for an additional charge depending on the package service type and origin/destination pair.
Return of Document: This may also be referred to as the Return of Invoice service and is unique to Poland. If set UPS will use their Return of Document service to return the signed invoice to the shipper.
Commercial Invoice Removal: When set this will indicate that the commercial invoice should be removed before delivery, thus not revealing the value of the contents to the recipient.
Carbon Neutral: This is required to make a shipment that is carbon neutral.
Exchange Forward: This is required in order to make exchange forward shipments.
Dropoff at UPS Facility: When set this indicates that the package will be dropped off at a UPS Facility.
This is applicable only if ServiceType is set to stUPSWorldwideExpressFreight.
Deliver To Addressee Only: When set this requires that the addressee be the one who takes final delivery of the package being held at a UPS Access Point
This accessorial is only valid when ShipmentIndicationType is set to 1.
Direct Delivery Only: When set this will ensure that the package is delivered to the ShipTo address on the shipping label.
This accessorial is not valid when ShipmentIndicationType is set.

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

This is the type of certificate store for this certificate.

Syntax

Swift
Objective-C

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

public enum UpsratesSSLCertStoreTypes: 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 (UPSRates 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 (UPSRates Module)

This specifies the SSL/TLS implementation to use.

Syntax

Swift
Objective-C

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

public enum UpsratesSSLProviders: 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 (UPSRates 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 (UPSRates 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.

TotalValue Property (UPSRates Module)

Monetary value of shipment contents.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=totalValue,setter=setTotalValue:) NSString* totalValue;

- (NSString*)totalValue;
- (void)setTotalValue :(NSString*)newTotalValue;

Default Value

"0.00"

Remarks

Required for all non-document shipments outside the US. Required for Document shipments (when Documents is set to True) only when either the SenderAddressCountryCode or RecipientAddressCountryCode is CA (Canada).

This is returned in the server response only if provided in the request.

Cannot exceed more than 9 whole numbers and 2 decimal places. Maximum value is: 999999999.99.

TotalWeight Property (UPSRates Module)

Total shipment's weight.

Syntax

Swift
Objective-C

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


@property (nonatomic,readwrite,assign,getter=totalWeight,setter=setTotalWeight:) NSString* totalWeight;

- (NSString*)totalWeight;
- (void)setTotalWeight :(NSString*)newTotalWeight;

Default Value

"1.0"

Remarks

This indicates shipment's weight. Required for shipments outside the US and non-document shipments inside the US. It will be returned in the server response only if provided in the request.

Allows for only one decimal point and one decimal place. It cannot exceed: 150 LBS, 65 KGS for Canada, 70 KGS for the rest of the world.

UPSAccount Property (UPSRates Module)

Syntax

Swift
Objective-C

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


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

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

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

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

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

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

Default Value

Remarks

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

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

GetRates Method (UPSRates Module)

Returns rate information for a specified or all available UPS RequestedService s.

Syntax

Swift
Objective-C

public func getRates() throws -> Void

- (void)getRates;

Remarks

To get the courtesy rate quotes for UPS services, you can call the GetRates method. If rates are needed for a specific service type, you will have to set the RequestedService to the value you need the rates for (other than 0 : stUnspecified). The RequestedService identifies the UPS service for which you want to retrieve rate information.

If the rates are wanted for all available UPS services, you should set the RequestedService to 0 (stUnspecified). Following validation, the UPSRates identifies and rates all available services. The server response will include a list of services, their associated rate, and guaranteed delivery time, if available.

In either case, the following properties or config settings are sent in the request (if any of these have not been set, their default values will be used instead):

UPSAccountServer (required)
UPSAccountAuthorizationToken (required)
UPSAccountAccountNumber (required only when requesting to receive negotiated rates; otherwise optional)
RequestedService (required)
PickupType (required)
CustomerType (required)
SenderAddress(required)
RecipientAddress (required)
Packages (required)
WeightUnit (optional)
CurrencyCode (optional)

Returned values upon a successful reply are:

Services

If there is a problem with any of the input values within the request, the response will either raise an error (when it's an hard error) and transaction will fail, or give a warning (when it's a soft error), which can be accessed via Warning, and the transaction will go through.

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

GetShippingTime Method (UPSRates Module)

Provides the average estimated time to ship a package from an origin to a destination address.

Syntax

Swift
Objective-C

public func getShippingTime() throws -> Void

- (void)getShippingTime;

Remarks

This method call issues a Time in Transit request to the UPS Server and parses the response.

The following can be set when this method is called:

SenderAddress (required: the SenderAddressCity is required for requests outside the US if the SenderAddressZipCode is not used in the origin country; the SenderAddressState is optional; the SenderAddressCountryCode is required; the SenderAddressZipCode is required if the SenderAddressCountryCode supports postal code system. If not provided, a candidate list will be returned for the user to enter a valid Postal Code for the specified SenderAddressCity.
RecipientAddress (required: the RecipientAddressCity is required for requests outside the US if the RecipientAddressZipCode is not used in the destination country; the RecipientAddressState is optional; the RecipientAddressCountryCode is required; the RecipientAddressZipCode is required if the RecipientAddressCountryCode supports postal code system. If not provided, a candidate list will be returned for the user to enter a valid Postal Code for the specified RecipientAddressCity.
SenderTown is optional, applicable to non-US addresses, and used to make the origin address more precise;
RecipientTown is optional, applicable to non-US addresses, and used to make the destination address more precise;
ShipDate (required)
TotalWeight (conditional)
WeightUnit (conditional - applicable when the TotalWeight is provided in the request)
Documents (optional)
TotalValue (conditional - required for Document shipments when the origin or destination is Canada or non-document shipments outside the US)
CurrencyCode (conditional - applicable when the TotalValue is provided in the request)

The minimum information returned in the response include a summary of the user's input as well as:

Disclaimer (when applicable)
SenderCountryName
RecipientCountryName

If the SenderAddress and RecipientAddress addresses provided in the request are found in UPS system exactly as entered, then the Services is filled upon server's response.

Otherwise, if those do not match any data located in UPS system, then the server returns a list of candidates for the origin and/or destination addresses, which will be stored as strings (formatted as JSON) in SenderCandidateAggregate (for origin) and RecipientCandidateAggregate (for destination).

To read an address, set the Aggregate property of an UPSAddress class to this value, and read the values of the desired fields for each candidate from 0 to UPSAddress's MatchCount - 1 .

So, after submitting the request, you will either receive a successful response containing time-in-transit information (as described above), or an error if error conditions were found.

Reset Method (UPSRates 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 (UPSRates 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 (UPSRates 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 (UPSRates 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 (UPSRates 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

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. For UPS should not exceed 35 characters.

address2
String
Default Value: ""

A specific detail on the address (such as building, suite, apartment, floor number etc.). This is optional. For UPS should not exceed 35 characters.

addressFlags
Int32
Default Value: 0

Various flags that denote information about the address.


Value	Meaning
0x00000001	POBox - Set this flag when using a P.O. Box for the address. This flag is only used by USPSShip and USPSShipIntl addresses.
0x00000002	Residential - Whether or not the address is a residential address. This flag is only relevant for UPS and FedEx, and if this flag is not set, the address is assumed to be commercial.

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: "US"

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. Note that with USPS you can also specify the full country name here.


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

* Not supported by USPS

** Has multiple values, the values used for USPS are below


Country Name	Country Code
Cayman Islands	KY
French Polynesia	PF
Guadeloupe	GP
Italy	IT
Netherlands	NL
Netherlands Antilles	AN
Northern Mariana Islands	MP
Spain	ES
St. Kitts and Nevis	KN
St. Vincent	VC
United Kingdom	GB
U.S. Virgin Islands	VI

state
String
Default Value: ""

State or province code. This is the identifying abbreviation for US state, Canada province, 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.

zipCode
String
Default Value: ""

Postal code. This is identification of a region (usually small) for mail/package delivery. Format and presence of this field will vary, depending on country.

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: 16.

Constructors

public init()

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall and the .

Fields

autoDetect
Bool
Default Value: False

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewallType
FirewallTypes
Default Value: 0

This property determines the type of firewall to connect through. The applicable values are as follows:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. is set to 1080.

host
String
Default Value: ""

This property contains the name or IP address of firewall (optional). If a is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class .

password
String
Default Value: ""

This property contains a password if authentication is to be used when connecting through the firewall. If is specified, the and properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

port
Int32
Default Value: 0

This property contains the transmission control protocol (TCP) port for the firewall . See the description of the property for details.

Note: This property is set automatically when is set to a valid value. See the description of the property for details.

user
String
Default Value: ""

This property contains a user name if authentication is to be used connecting through a firewall. If the is specified, this property and properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class .

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

baseCharge
String (read-only)
Default Value: ""

Actual Base Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl only. When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on the package level. In this case, the properties that store the rating information: PackagesBaseCharge, PackagesNetCharge, PackagesTotalSurcharges, and PackagesTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, this is the "transportation charge - fuel surcharge" applicable to this package. Upon a successful response, this is returned in the server reply for each package included in the shipment if SubVersion is 1701 or greater.

This is not applicable to USPS.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

codAmount
String
Default Value: ""

The COD monetary value for the package.

For FedEx, this is applicable and required for Ground shipments only. If the shipment is using COD special service (i.e., the ShipmentSpecialServices is set to the corresponding value of COD), then the COD amount should be specified on package level for all packages that are going to use COD. If this is set, then the package will be considered as using the COD service.

Since Ground packages do not travel together and may be delivered at different times, you should add the value for the individual packages to be collected. On MPS Ground shipments, a COD return label will be generated for each package that uses COD service (stored in ).

On COD Express shipments, the COD amount should be specified on shipment level and the CODTotalAmount is required instead.

For UPS, if the is set to a value other than "0.00", it indicates that COD special service is requested for that package. The collection type should be specified in the request via the . COD special service is not valid for return service movements. Package level COD is available for shipment from US/PR to US/PR, CA to CA, and CA to US. COD service for shipment from CA to US is not allowed for PackagesPackagingType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by ) and COD cannot coexist on a single package.

This property is not applicable to USPS packages.

Format: Two explicit decimal positions (e.g. 100.00).

This is not applicable for Canada Post.

codFile
String
Default Value: ""

Filename and location to save the of this package to. This is applicable for package(s) that use the COD service.

When the is set to a valid path and filename, the contents of the are written to disk when either the GetPackageLabel or GetShipmentLabels method is called.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to PDF, then has to have .pdf extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

This property is only applicable to FedEx shipments.

codLabelB
Data (read-only)
Default Value: ""

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

This is the decoded binary image file of the COD return label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a PNG label, the data returned will be a PNG file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

Since MPS Ground packages do not travel together and may be delivered at different times, a return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This property is only applicable to FedEx.

codLabel
String (read-only)
Default Value: ""

Image of the COD return label for this package retrieved by FedEx Server upon a successful COD ship request.

Since MPS Ground packages do not travel together and may be delivered at different times, a return label will be generated for each package that uses COD service.

On MPS Express packages, only one COD label will be generated and this will be returned on the last package of the MPS.

This property is only applicable to FedEx.

codType
TPCODTypes
Default Value: 0

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

This property is only applicable to FedEx and UPS and identifies the type of funds that should be collected upon package delivery. It is required to be provided in the request only if COD is requested for this package (i.e., is set to a value other than "0.00").

Valid values are:


Value	Description
codtpAny (0)	Company check, personal check, cashier's check or money order - UPS no cash allowed. Not applicable for Canada Post
codtpCash (1)	Cash - FedEx only, only valid for Ground shipments
codtpGuaranteedFunds (2)	Cashier's check or money order
codtpCompanyCheck (3)	Company check - FedEx and Canada Post only
codtpPersonalCheck (4)	Personal check - FedEx and Canada Post only

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

Also note that only codtpAny (0) and codtGuaranteedFunds (2) are valid for UPS. For CanadaPost codtpAny is not valid and any type of check is accepted.

dangerousGoodsAccessible
Bool
Default Value: False

Identifies whether or not the dangerous goods being shipped are required to be accessible during delivery.

This property is only applicable to FedEx shipments, and is required to be specified when the contains the corresponding flag for Dangerous Goods.

There are two types of dangerous goods:

Accessible, which may be shipped using: FedEx Priority Overnight, FedEx 1Day Freight, FedEx International Priority, FedEx International Priority Freight. The should be set to True.
Inaccessible, which may be shipped using: FedEx Priority Overnight, FedEx Standard Overnight, FedEx 2Day, FedEx Express Saver, FedEx 1Day Freight, FedEx 2Day Freight, FedEx 3Day Freight, FedEx International Priority, FedEx International Priority Freight. The should be set to False.

The accessibility type affects the service availability and rates.

Note: To locate FedEx services that allow dangerous goods shipping for your origin/destination pair, use the FedExRates class by requesting rates for all available services.

dangerousGoodsOptions
Int32
Default Value: 0

Contains the collection of options will be used on the package level when using dangerous goods. Valid values are:


Value	Meaning
0x00000001	Hazardous Materials
0x00000002	Battery
0x00000004	Other Regulated Materials - Domestic (ORM-D)
0x00000008	Reportable Quantities
0x00000010	Small Quantity Exception
0x00000020	Limited Quantities Commodities

Note: This is only valid when using FedEx.

description_
String
Default Value: ""

For FedEx, this is the description that appears in the email to identify this package. This is optional.

For UPS, this is applicable and required for shipments with return service only.

This does not apply for USPS and Canada Post.

girth
Int32
Default Value: 0

Measurement around the widest part of the package, perpendicular to the .

This property is only applicable when requesting rates for USPS packages.

Note: For parcels, is the measurement of the longest dimension and and make up the other two dimensions. is the measurement around the thickest part of the package, perpendicular to the length. It is only required if the package is irregular and the property is set to ptNonRectangular. (In this case and must still be set).

Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note that the , , and are required for Priority Mail packages when the is set to psLarge.

height
Int32
Default Value: 0

The height of the package to be shipped.

For FedEx, the is optional, but recommended, if "Your Packaging" is used as . This is required if and are provided in the request. It is also required if a FedEx Express heavyweight service is selected for the shipment.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When is provided in the request, then all other dimensions ( and ) are to be set as well.

For USPS, this only applies to GetRates and is only required if the package is irregular and the property is set to ptNonRectangular. (In this case and must still be set). For parcels, is the measurement of the longest dimension and and make up the other two dimensions. is the measurement around the thickest part of the package, perpendicular to the length.

Note that the , , and are required for Priority Mail packages when the is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the Shortest dimension (3.1 digits e.g. 999.9 pattern).

id
String
Default Value: ""

An 8-digit Unique Parcel Identification Number.

Unique number used to identify the package. This property is optional, and only applies to USPS return labels.

insuredValue
String
Default Value: ""

Amount of insurance requested for this package. The value has 2 explicit decimal position and has a maximum of 11 characters including the decimal.

length
Int32
Default Value: 0

The length of the package to be shipped.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments. Length must be the longest dimension of the container.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When is provided in the request, then all other dimensions ( and ) are to be set as well.

Valid values are 0 to 108 IN and 0 to 270 CM.

For USPS, this is only required if the package is irregular and the property is set to ptNonRectangular. (In this case and must still be set).

Note: For parcels, the is the measurement of the longest dimension and and make up the other two dimensions. is the measurement around the thickest part of the package, perpendicular to the length.

Note that the , , and are required for Priority Mail packages when the is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the longest dimension (3.1 digits e.g. 999.9 pattern).

netCharge
String
Default Value: ""

Actual Net Charge applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

When this is used, please note that for MPS the FedEx server provides the rating information in two different ways for domestic and international shipments.

In MPS domestic shipments, the rating information is available on package level. In this case, the properties that store the rating information: PackagesBaseCharge, PackagesNetCharge, PackagesTotalSurcharges, and PackagesTotalDiscount, indicate the rate for that particular package.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response to GetRates, this is returned in the server reply for each package included in the shipment.

For USPS, this specifies the postage required for mailing a package of the indicated size and weight. If this property is not supplied, it will be calculated and returned in the response.

This will also be set when an Endicia label is returned describing how much postage was charged from the Endicia account for the package.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

packagingType
TPackagingTypes
Default Value: 0

The packaging type of the package being rated and/or shipped.

Possible values are:


Value	FedEx	UPS	USPS	USPS (Endicia)	USPS (Stamps.com)	Canada Post
ptNone (0)		X	X			X
ptPostcards (1)			X	X	X
ptLetter (2)	X	X		X	X
ptLargeEnvelope (3)			X	X	X
ptFlatRateEnvelope (4)			X	X	X
ptFlatRateLegalEnvelope (5)			X	X	X
ptFlatRatePaddedEnvelope (6)			X	X	X
ptFlatRateGiftCardEnvelope (7)			X	X
ptFlatRateWindowEnvelope (8)			X	X
ptFlatRateCardboardEnvelope (9)				X
ptSmallFlatRateEnvelope (10)			X	X
ptPak (11)	X	X
ptBox (12)	X	X
pt10kgBox (13)	X	X
pt25kgBox (14)	X	X
ptSmallExpressBox (15)		X
ptMediumExpressBox (16)		X
ptLargeExpressBox (17)		X
ptFlatRateBox (18)			X		X
ptSmallFlatRateBox (19)			X	X	X
ptMediumFlatRateBox (20)			X	X	X
ptLargeFlatRateBox (21)			X	X	X
ptDVDFlatRateBox (22)				X
ptLargeVideoFlatRateBox (23)				X
ptRegionalRateBoxA (24)			X	X	X
ptRegionalRateBoxB (25)			X	X	X
ptRectangular (26)			X
ptNonRectangular (27)			X
ptTube (28)	X	X				X
ptMatterForTheBlind (29)			X
ptPallet (30)		X
ptYourPackaging (31)	X	X	X	X	X	X
ptDocument (32)						X
ptFlats (33)		X
ptParcels (34)		X
ptBPM (35)		X
ptFirstClass (36)		X
ptPriority (37)		X
ptMachinables (38)		X
ptIrregulars (39)		X
ptParcelPost (40)		X
ptBPMParcel (41)		X
ptMediaMail (42)		X
ptBPMFlat (43)		X
ptStandardFlat (44)		X
ptRegionalRateBoxC (45)			X	X	X
ptThickEnvelope (46)			X	X	X
ptSmallBox (47)	X
ptMediumBox (48)	X
ptLargeBox (49)	X
ptExtraLargeBox (50)	X
ptPackageService (51)			X
ptCubicParcels (52)			X
ptCubicSoftPack (53)			X

If this is set to a value that is not applicable to a certain provider, it will automatically be set to ptNone (0).

For FedEx, this is required in a ship request when either the GetPackageLabel or GetShipmentLabels method is called. FedEx only supports one packaging type for the whole shipment, so only the for the first package is used in label requests.

If the is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: PackagesLength, PackagesWidth, and PackagesHeight.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the will be automatically set to 31 (Your Packaging).

Please note that the types pt10kgBox (13) and pt25kgBox (14) are only meant for international shipments and domestic shipments outside of the United States.

For UPS, please note that when selecting make sure this is valid for all the following: SenderAddressCountryCode, RecipientAddressCountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:


ServiceType
stFirstClass (35)	ptFirstClass (36)	1 to 13 OZS
stPriorityMail (36)	ptPriority (37)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptMachinables (38)	6 to <16 OZS
stExpeditedMailInnovations (37)	ptIrregulars (39)	1 to <16 OZS
stExpeditedMailInnovations (37)	ptParcelPost (40)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptBPMParcel (41)	1 to 15 LBS
stExpeditedMailInnovations (37)	ptMediaMail (42)	1 to 70 LBS
stExpeditedMailInnovations (37)	ptBPMFlat (43)	1 to 15 LBS
stExpeditedMailInnovations (37)	ptStandardFlat (44)	1 to <16 OZS
stPriorityMailInnovations (38)	ptFlats (33)	1 to 70 LBS
stPriorityMailInnovations (38)	ptParcels (34)	1 to 70 LBS
stPriorityMailInnovations (38)	ptBPM (35)	1 to 70 LBS
stEconomyMailInnovations (39)	ptFlats (33)	1 to 70 LBS
stEconomyMailInnovations (39)	ptParcels (34)	1 to 70 LBS
stEconomyMailInnovations (39)	ptBPM (35)	1 to 70 LBS

For USPS, this is used for getting rates and Endicia labels. For international shipments, the only valid values are: ptRectangular and ptNonRectangular.

For Canada Post, ptLetter (2) is only applicable if theContractId is set.

ratingAggregate
String (read-only)
Default Value: ""

Rating aggregate applicable to this package.

reference
String
Default Value: ""

Indicates the package reference type and value, that associates this package (assigned by the customer).

For FedEx, this is optional to be provided in a ship request. You can enter up to 3 customer references by providing: the type(s) and value(s) in the request.

Valid values for types are:


Type value	Meaning
CR	Customer Reference - this gets printed on shipping label and invoice.
BL	Bill Of Lading - this gets printed on shipping label, Ground shipping reports, and in the Customer Reference element on the invoice.
IN	Invoice Number - this gets printed on shipping label and invoice.
PO	Purchase Order Number - this gets printed on shipping label and invoice.
DN	Department Number - this gets printed on shipping label and invoice.
SI	Shipment Integrity - this gets printed on invoice only.
SN	Store Number - this gets printed on shipping label and invoice.
IR	Intracountry Reglatory Reference
EPC	Electronic Product Code
RMA	RMA Number

The type and value pair(s) should be entered as a string in this format: type1:value1; type2:value2; type3:value3;. For example, if the user wants to assign 3 references to this package, the should be set to: CN:123456; IN:123; SN:12;.

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

For UPS, this is also optional to be provided in a ship request and valid if the origin/destination pair is US/US or PR/PR.

You can enter up to two customer references on package level by providing: the type(s) and value(s) in the request.

Valid values for types are:


Code	Reference Number Type
AJ	Accounts Receivable Customer Account
AT	Appropriation Number
BM	Bill of Lading Number
9V	Collect on Delivery (COD) Number
ON	Dealer Order Number
DP	Department Number
3Q	Food and Drug Administration (FDA) Product Code
IK	Invoice Number
MK	Manifest Key Number
MJ	Model Number
PM	Part Number
PC	Production Code
PO	Purchase Order Number
RQ	Purchase Request Number
RZ	Return Authorization Number
SA	Salesperson Number
SE	Serial Number
ST	Store Number
TN	Transaction Reference Number
EI	Employer ID Number
TJ	Federal Taxpayer ID No.
SY	Social Security Number

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

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

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

For USPS, this is only used by Endicia labels, and is used as a reference value for logs.

This is used in Canada Post to provide user-defined values, such as an internal "orderID".

returnReceiptB
Data (read-only)
Default Value: ""

Image of the receipt for a return shipment.

This is only valid for UPS, and is the decoded binary image file of the receipt, stored in memory upon successful ship response. The receipt is generated in HTML format, and if the is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

returnReceipt
String (read-only)
Default Value: ""

Image of the receipt for a return shipment.

returnReceiptFile
String
Default Value: ""

Filename and location to save the of this package to. This is applicable only if using UPS.

When the is set to a valid path and filename, the contents of the are written to disk upon successful response (if a return shipment).

The has to have .html extension.

Note: When using UPS, the HTML file references a 'page 2', this is the HTML page containing the return label. You can print this page by using the ShippingLabelHTMLDirectory and PackageShippingLabelFileHTML[i]; configuration settings.

shippingLabelB
Data (read-only)
Default Value: ""

Image of the shipping label for this package returned by the Server upon a successful ship response.

This is the decoded binary image file of the shipping label, stored in memory upon successful ship response. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

shippingLabel
String (read-only)
Default Value: ""

Image of the shipping label for this package returned by the Server upon a successful ship response.

shippingLabelFile
String
Default Value: ""

Filename and location to save the of this package to. When the is set to a valid path and filename, the contents of the are written to disk upon successful response.

This filename should have the same extension defined by LabelImageType (for example, if LabelImageType is set to GIF, then has to have .gif extension).

If the filename exists, you can choose to overwrite it or not by setting the Overwrite config setting (which defaults to True).

shippingLabelPart2B
Data (read-only)
Default Value: ""

Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS.

This is the decoded binary image file of the part 2* of the shipping label, stored in memory when either the GetPackageLabel or the GetShipmentLabels method is called. The kind of label data returned depends on the label formatting specified in your ship request via LabelImageType. If you requested a GIF label, the data returned will be a GIF file. If you requested a thermal label, it will be a thermal label image. If the is set to a valid path and filename, the part 2* of the label is also saved to disk in a LabelImageType format.

For instance, if the PackagesShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif".

Note: *Mail Innovations (MI) shipments with more than 3 commodities will receive a 2 page combination label. Part 1 of the label can be accessed via PackagesShippingLabel property whereas Part 2 can be accessed via PackagesShippingLabelPart2 property.

shippingLabelPart2
String (read-only)
Default Value: ""

Image of the part 2* of the shipping label for this package returned by the Server. This is applicable only if using UPS.

For instance, if the PackagesShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif".

signatureType
TSignatureTypes
Default Value: 0

Specifies one of the Delivery Signature Options requested for this package. Possible values are:


stServiceDefault (0)	The default value for the requested service.
stAdult (1)	Available for both residential and nonresidential deliveries.
stDirect (2)	Available for both residential and nonresidential deliveries.
stIndirect (3)	Available for residential deliveries only.
stNoSignatureRequired (4)	Not available for Ground services.
stUSPSDeliveryConfirmation (5)	Available for UPS Mail Innovations only.
stAdult19 (6)	Available for Canada Post only.

For FedEx Express shipments, the NoSignatureRequired option will not be allowed when the following special services are requested: Alcohol, Hold At Location or Dangerous Goods.

For residential FedEx Ground International shipments from Canada to the U.S., two valid signature options are allowed: NoSignatureRequired and Direct.

The impact of signature options fees may vary depending on your agreement with FedEx. Following are the definitions for FedEx:

Service Default: In this case, the appropriate signature option will be selected for your shipping service. For example, if the package contains Dangerous Goods, the Direct signature option is chosen for you. The actual signature option applied to this package could be different than the signature option requested if a conflict occurred with other service features in the package. In this case, the value set in the request will be ignored.
Indirect Signature Required: Indicates that an indirect signature is required upon delivery. This is allowed to residential addresses only. In this case, FedEx obtains a signature in one of three ways: from any person at the delivery address, from a neighbor, building manager, or other person at a neighboring address. The recipient can sign a FedEx door tag authorizing release of the package without anyone present. This might affect the shipping rates and/or service availability.
Direct Signature Required: Indicates that a direct signature is required upon delivery. In this case, FedEx obtains a signature from any person at the delivery address. If no one is at the address, FedEx will reattempt delivery; Direct Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This option is not available for Hold at FedEx Location shipments. This might affect the shipping rates and/or service availability.
Adult Signature Required: Indicates that the adult signature is required upon delivery. In this case, FedEx obtains a signature from any person at least 21 years old (government-issued photo identification required) at the delivery address. If no one is at the address, FedEx will reattempt delivery. Adult Signature Required overrides any recipient release that may be on file for deliveries to nonresidential addresses. This might affect the shipping rates and/or service availability.

Note: In the server reply, this option may differ from that requested value due to other characteristics of the shipment.

For UPS, when delivery confirmation is requested for a package, the should be set to a value other than 0 (stServiceDefault). The availability of this special service depends on the ServiceType. The type stIndirect is not valid for UPS packages.

Also, when using UPS Mail Innovations, delivery confirmation can be requested by setting this to stUSPSDeliveryConfirmation.

Delivery Confirmation and COD cannot coexist on a single package. Also, Delivery Confirmation option cannot be combined with the Return Services option.

For USPS, if this is not set to stServiceDefault or stNoSignatureRequired, the Signature Confirmation service will be used. Also, for Express label shipments, set this to stNoSignatureRequired to waive the signature requirements.

This does not apply for Canada Post.

size
TPackages
Default Value: 0

Size of the package being mailed.

This property is only used by USPS and is required for the GetRates method call.

See below for valid entries:


Package Size	Description	ServiceType
psRegular	For Priority Mail: Package is less than one cubic foot in size. For all other ServiceTypes: Package length plus girth is 84 inches or less.	Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
psLarge	For Priority Mail: Package is greater than one cubic foot in size. For all other ServiceTypes: Package length plus girth measure more than 84 inches but not more than 108 inches. This tag does not affect the rate for Express Mail, Bound Printed Mater, Media Mail or Library Mail.	Parcel Post, Priority Mail, First-Class Mail, Express Mail, Bound Printed Matter, Library Mail, Media Mail
dsOversize	Package length plus girth is more than 108 but not more than 130 inches. Parcel Post packages that measure more than 108 inches but not more than 130 inches in combined length and girth are charged the oversized Parcel Post rate regardless of the weight of the package.	Parcel Post only.

Note: For parcels, length; is the measurement of the longest dimension and girth is the measurement around the thickest part (perpendicular to the length). Except for Parcel Post, no mailpiece may measure more than 108 inches in length and girth combined. Parcel Post pieces measuring over 108 inches, but not more than 130 inches in combined length and girth are mailable at the applicable oversized rate.

Note: Use the , , and optionally (irregular shaped packages only) properties to specify the dimensions of the package.

Note: only psRegular and psLarge are available when getting rates for international shipments.

specialServices
Int64
Default Value: 0

Contains the collection of special services offered on the package level. Valid values are:


Value	Meaning	FedEx	FedEx Freight	UPS
0x00000001	Appointment Delivery	X
0x00000002	Dangerous Goods	X	X	X
0x00000004	Dry Ice	X
0x00000008	Priority Alert	X
0x00000010	Non Standard Container	X		X
0x00000020	COD	X	X
0x00000040	Additional Handling			X
0x00000080	Signature Option	X
0x00000100	Alcohol	X

For FedEx, to request any of the special services offered for a particular package in a ship request, you must set the of that package to a set of valid flags.

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

Appointment Delivery: Indicates that the appointment delivery special service is requested for this package. This might affect the shipping rates and/or service availability.
Dangerous Goods: Indicates that this package contains dangerous goods. When the contains this flag, then the is required to be provided in the request as well. For FedEx Express services, these types of shipments are referred to as dangerous goods shipments. For FedEx Ground services, these types of shipments are referred to as hazardous materials (Hazmat) shipments. Hazmat shipments must be single package. FedEx Ground provides reliable delivery of hazardous materials in all U.S. states except Alaska and Hawaii. If you have not shipped hazardous materials with FedEx Ground before, contact your FedEx account executive first. FedEx needs to confirm that you have met government training requirements and can generate the documentation your shipments need. Additional information regarding hazardous materials shipping is provided at fedex.com/ us/services/options under the Hazardous Materials link. The Shipper's Hazardous Materials Certification report (OP-950), prints after a successful Ground close request. Please note that Hazmat shipments must be single package. If you create a multiple package (MPS) hazmat shipment, only one commodity prints on the OP-950. FedEx assesses a surcharge on each package containing dangerous goods/Hazmat materials. This might affect service availability as well.
Dry Ice: Indicates that this package contains dry ice. FedEx assesses a surcharge on each package containing dry ice. This might affect service availability as well.
Priority Alert: Indicates whether the priority alert special service is requested for this package. This is applicable to domestic shipments only. A per package surcharge is associated with Priority Alert. This is applicable for FedEx First Overnight and FedEx Priority Overnight. It can be associated with: Saturday Delivery, Hold Saturday, Hold at Location, Dangerous Goods, Dry Ice or Signature Service Option. Please note that Priority Alert requires a service contract. If you are interested in signing up for Priority Alert, contact your FedEx account executive.
Non Standard Container: Indicates whether this package type is a non standard container. This might affect the shipping rates and/or service availability.
COD: Indicates that this is a COD package. This service will affect shipping rates and service availability. This is applicable for domestic FedEx Express and Ground services, except FedEx Home Delivery premium. When shipping COD via FedEx Ground, the and must also be provided in the request.

For UPS, to request any of the special services offered for a particular package in a rate or ship request, you must set the of that package to a set of valid flags.

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

Additional Handling: Indicates that additional handling special service is requested for this package. This might affect the shipping rates and/or service availability.
Non Standard Container: Indicates whether this package type is to be considered a large package (a non standard container). Dimensions must be 130 to 165 inches: Length + (2 x Width) + (2 x Height). This might affect the shipping rates and/or service availability.

Some other special services on package level, such as COD, Delivery Confirmation, Insured Value, are already implemented respectively through the and , , and .

This property is not applicable to USPS or Canada Post.

totalDiscount
String (read-only)
Default Value: ""

Total Actual Discount applicable to this package.

This is normally specific to the FedEx PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

totalSurcharges
String (read-only)
Default Value: ""

Total Actual Surcharges applicable to this package.

For FedEx, this is normally specific to the PayorAccountNumber. It is used in the FedExShip and FedExShipIntl classs only.

Please note that for MPS, the FedEx server provides the rating information in two different ways for domestic and international shipments.

While in MPS international shipments, the rating information is available on shipment level only and it is returned in the last package response. That being said, please note that: for all packages with index=0 to PackageCount - 2, the properties that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these properties will contain the rate for the whole shipment.

For UPS, upon a successful response, this is returned in the server reply for each package included in the shipment.

This does not apply to USPS packages.

For Canada Post, upon a successful response, this is returned in the server reply for the package requested.

trackingNumber
String (read-only)
Default Value: ""

Tracking number assigned to this package. Upon successful request, this is returned in the server reply for each package included in the shipment.

weight
String
Default Value: "0.0"

Weight of this package.

For FedEx, this is required to be provided in the request. It requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

For UPS, this is required to be provided in the request for each package contained in the shipment if is set to a value other than 0 (UPS Letter). For Ground shipments, if the actual weight is less than 150 pounds, then the billable weight is 150 pounds. Air and 3 Day Select shipments will not be subject to a minimum billable weight. Format: it requires one explicit decimal position in pounds or kilograms, depending on the value of the WeightUnit config, (i.e. N.N formatting).

Note that if the ServiceType stUPSSurePostLessThan1LB or stUPSFirstClassMail is used, or the ServiceType stUPSExpeditedMailInovations is used with the ptMachineables, ptIrregulars, or ptStandardFlat then the weight must be specified in ounces. The WeightUnit config will be set automatically to "OZS" if not set.

For USPS, this must be the weight in pounds and ounces of the package. Package weight cannot exceed 70 pounds. (First-Class Mail cannot exceed 13 ounces. Bound Printed Matter cannot exceed 15 pounds). On international shipments, weight limits vary by country.

The format must be in "N lbs N oz", or as an integer showing the number of ounces. For example, a package with weight 6 lbs, 8 oz can be specified as "6 lbs 8 oz" or as "104".

However, in USPS, if PostageProvider is set to ppEndicia, then the format must be one explicit decimal position in ounces (i.e. N.N formatting).

For Canada Post, the weight of the parcel should be specified in kilograms (e.g. 99.999).

width
Int32
Default Value: 0

The width of the package to be shipped.

For UPS, this is the width of the package used to determine dimensional weight and therefore is recommended for all shipments.

It is required for GB to GB, and Poland to Poland shipments, and for 'Pallete' packaging type. For UPS packaging types: the length, width and height are defaulted.

Length + 2*(Width+Height) must be less than or equal to 130 IN or 330 CM. When is provided in the request, then all other dimensions ( and ) are to be set as well.

For USPS, this is only required if the package is irregular and the property is set to ptNonRectangular. (In this case and must still be set).

Note: For parcels, is the measurement of the longest dimension and and make up the other two dimensions. is the measurement around the thickest part of the package, perpendicular to the length.

Note that the , , and are required for Priority Mail packages when the is set to psLarge.

Note also that this applies to Endicia shipping label requests.

For Canada Post, this field should be set to the second longest dimension (3.1 digits e.g. 999.9 pattern).

Constructors

public init()

public init(length: , width: , height: )

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the and the .

Fields

authScheme
ProxyAuthSchemes
Default Value: 0

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the and properties are set.

should be set to authNone (3) when no authentication is expected.

By default, is authBasic (0), and if the and properties are set, the component will attempt basic authentication.

If is set to authDigest (1), digest authentication will be attempted instead.

If is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of and .

autoDetect
Bool
Default Value: False

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is .

password
String
Default Value: ""

This property contains a password if authentication is to be used for the proxy.

If is set to Basic Authentication, the and are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.

If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

port
Int32
Default Value: 80

This property contains the Transmission Control Protocol (TCP) port for the proxy (default 80). See the description of the property for details.

server
String
Default Value: ""

If a proxy is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the property is set to the corresponding address. If the search is not successful, an error is returned.

ssl
ProxySSLTypes
Default Value: 0

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:


psAutomatic (0)	Default setting. If the URL is an `https` URL, the class will use the `psTunnel` option. If the URL is an `http` URL, the class will use the `psNever` option.
psAlways (1)	The connection is always SSL enabled.
psNever (2)	The connection is not SSL enabled.
psTunnel (3)	The connection is made through a tunneling (HTTP) proxy.

user
String
Default Value: ""

This property contains a username if authentication is to be used for the proxy.

If is set to Basic Authentication, the and properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If is set to Digest Authentication, the and properties are used to respond to the Digest Authentication challenge from the server.

If is set to NTLM Authentication, the and properties are used to authenticate through NTLM negotiation.

Constructors

public init()

public init(server: , port: )

public init(server: , port: , user: , password: )

ServiceDetail Type

Indicates the rates and service details of a service.

Remarks

This type represents the details (on delivery time, rates, etc.) of a service type. The fields contained by this type are listed below.

Fields

accountBaseCharge
String (read-only)
Default Value: ""

Transportation charges before surcharges and discounts applied to a . This applies to FedEx only and is specific to the FedExAccountAccountNumber. After calling the GetRates method, the will be filled with the value of discounted base charge amount specific to the FedExAccountAccountNumber (i.e. depending on the current rate schedule the FedExAccountAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the base cost of the shipment before taxes (numeric 99999.99).

accountNetCharge
String (read-only)
Default Value: ""

Net charge amount applied to a .

For FedEx, this is specific to the FedExAccountAccountNumber. After calling the GetRates method, the will be filled with the value of discounted net charge amount specific to the FedExAccountAccountNumber (i.e. depending on the current rate schedule the FedExAccountAccountNumber is receiving from FedEx).

For UPS, this is the value of grand total charges for account based rating applied to a shipment when using the returned

The UPS server response will contain negotiated rate(s) only for the qualified UPSAccountAccountNumbers. If the user is authorized for negotiated rates, and if negotiated rates apply to the particular service, UPS returns those rates along with the published rates in its response. Otherwise, a warning message might be returned that indicates ineligibility and only the published rates are returned in the response. For more information on negotiated rates, including authorization to receive them, please check with your UPS account representative.

This property is not used by the USPS class.

For Canada Post, this field will contain the total cost of the shipment if sent using this service including the cost of selected or required options, surcharges, discounts and taxes.

accountTotalDiscount
String (read-only)
Default Value: ""

Total discount amount applied to the shipment for a . This is for FedEx only and is specific to the FedExAccountAccountNumber. After calling the GetRates method, the will be filled with the value of total discount applied, which is specific to the FedExAccountAccountNumber (i.e. depending on the current rate schedule the FedExAccountAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of discounts.

accountTotalSurcharge
String (read-only)
Default Value: ""

Total surcharge amount for all additional services applied to a . This is only for FedEx, and is specific to the FedExAccountAccountNumber. After calling the GetRates method, the will be filled with the value of total surcharges applied, which is specific to the FedExAccountAccountNumber (i.e. depending on the current rate schedule the FedExAccountAccountNumber is receiving from FedEx).

For Canada Post, this field will contain the total amount of surcharges.

aggregate
String (read-only)
Default Value: ""

Aggregate of details and rates for the in the list of available services.

businessDays
Int32 (read-only)
Default Value: 0

Number of business days from origin to destination location. This is valid only for UPS and is returned for the number of UPS business days (Monday, Tuesday, Wednesday, Thursday, Friday and Saturday) the shipment will take to travel from one location to another.

If applicable, this property is filled after a call to the GetShippingTime.

commitments
String (read-only)
Default Value: ""

Service commitments for the when shipping to RecipientAddressCountryCode.

This is valid only for USPS, and indicates how long it will take for the package to be delivered when shipped via .

customerCenterCutoff
String (read-only)
Default Value: ""

Time the UPS Customer Service Center closes.

This value is only relevant for UPS and it provides the user with the time the Customer Service Center closes. This is applicable for shipments outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

delayDays
Int32 (read-only)
Default Value: 0

Number of days the shipment is delayed in customs. This is only valid for UPS requests, and is returned for requests outside the US only and when the request indicates the query is in reference to a Non-Document type of shipment.

If applicable, this property is filled after a call to the GetShippingTime.

deliveryDate
String (read-only)
Default Value: ""

This indicates the shipment delivery date for the .

In regards to International services, the delivery date availability is limited to some postal-code supported countries. The delivery date will be returned if available. Format: YYYY-MM-DD.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

For Canada Post, this field will be populated after a GetRates call and will contain the estimated date of delivery, starting from the expected mailing-date.

deliveryDay
String (read-only)
Default Value: ""

Indicates the day of the week the shipment can be delivered when using the . Possible values are: SUN, MON, TUE, WED, THU, FRI, SAT. In regards to International services, the delivery date availability is limited to some postal-code supported countries and it will be returned if available.

For UPS, this property is filled after a call to the GetShippingTime.

This is not applicable to USPS.

deliveryTime
String (read-only)
Default Value: ""

Scheduled local delivery time. This is available only for UPS, and indicates the latest time of day the shipment will be delivered as guaranteed by UPS. Format: HH:MM:SS.

If applicable, this property is filled after a call to the GetShippingTime.

effectiveNetDiscount
String (read-only)
Default Value: ""

Indicates the net discount applied to a . This is only valid for FedEx.

After calling the GetRates method, the will be filled with the value of net discount applied. This is specific to the FedExAccountAccountNumber (i.e. depending on the current rate schedule the FedExAccountAccountNumber is receiving from FedEx). This is the difference between the list net charge and account net charge.

guaranteedDescription
String (read-only)
Default Value: ""

Textual description of a guaranteed delivery for a UPS service type in the list of available services returned. This is populated when the GetShippingTime method is called for UPS only.

This method is also populated for Canada Post after the GetRates method is called. The returned value will either be "true" or "false" to indicate whether the delivery date is guaranteed.

holidays
Int32 (read-only)
Default Value: 0

Number of national holidays during transit. This is returned only for UPS when the shipment would be in transit during a national holiday. Holidays outside the US are taken into account. Returned for requests outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

indemnityCoverage
String (read-only)
Default Value: ""

Indicates the indemnity coverage available for this service. This property is valid only for USPS, and is only returned when TotalValue was sent in the request. It contains the lesser of maximum parcel indemnity coverage per given weight and TotalValue, if applicable. Otherwise it will be blank.

insuranceComment
String (read-only)
Default Value: ""

Explains why no InsuranceCost was returned in the response.

This property is only applicable to USPS.

If the TotalValue was sent in the request (indicating you wish to receive the in the response), but no was returned, then will contain text explaining why no value was returned for . It may be one of three reasons:


Value	Meaning
SERVICE	Insurance is not available for this service.
DESTINATION	Insurance is not available to the given country via this service.
INSURED VALUE	Insurance is available for the country and service, but not for the given value.

insuranceCost
String (read-only)
Default Value: ""

Insurance fee. This is applicable only to USPS and it describes the cost of purchasing insurance for this package.

listBaseCharge
String (read-only)
Default Value: ""

Transportation charges before surcharges and discounts applied to a . After calling the GetRates method, the will be filled with the value of base charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This does not apply to USPS.

listNetCharge
String (read-only)
Default Value: ""

Net charge amount applied to a .

After calling the GetRates method, the will be filled with the value of list net charge amount.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

listTotalDiscount
String (read-only)
Default Value: ""

Total discount amount applied to a . This applies only to FedEx. After calling the GetRates method, the will be filled with the value of total discount applied. This is returned in the server response only if the RateType is set to 0 (rtList) in the request.

listTotalSurcharge
String (read-only)
Default Value: ""

Total surcharge amount for all additional services applied to a .

After calling the GetRates method, the will be filled with the value of total surcharges applied.

For FedEx, this is returned in the server response only if the RateType is set to 0 (rtList) in the request.

This value does not apply to USPS.

maxDimensions
String (read-only)
Default Value: ""

Maximum dimensions of a package allowed when sending to the RecipientAddressCountryCode. This is only applicable to USPS. After a call to GetRates, this property will contain the maximum allowable dimensions of a package sent to the RecipientAddressCountryCode via the indicated ServiceType.

maxWeight
String (read-only)
Default Value: ""

Maximum weight of package allowed when sending to the RecipientAddressCountryCode.

This is only applicable to USPS.

After a call to GetRates, this property will contain the maximum allowable weight (in pounds) of a package sent to the RecipientAddressCountryCode via the indicated ServiceType.

Note: This property may contain a fractional quantity (eg: "0.2188", which indicates a max weight of 3.5 ounces).

packagingType
String (read-only)
Default Value: ""

The mail service type when shipping to RecipientAddressCountryCode.

This is only valid for USPS international rate requests.

indicates what type of shipping service is being used for each InternationalService. may contain the following information:


Priority	Priority Mail rate.
FirstClass	First Class rate.
ParcelPost	Parcel Post rate.
BPM	Bound Printed Matter rate (books, magazines).
Media	Media Mail rate (CDs, movies, etc).
Library	Inter-library mail rate (not for public use).
Express	Express Mail rate.

rateScale
String (read-only)
Default Value: ""

Applicable rate scale for the .

The indicates the rate scale (this is specific to the FedExAccountAccountNumber) used by FedEx to rate a shipment when shipped via the . This is applicable for FedEx Express services only.

rateZone
String (read-only)
Default Value: ""

Applicable rate zone for the .

The indicates the zone used by FedEx to rate a shipment (this is specific to the RecipientAddressZipCode) when using a FedEx Express service. This is applicable for FedEx Express services only.

restDays
Int32 (read-only)
Default Value: 0

Number of days the shipment is in rest due to non-business days. Returned for UPS requests outside the US only.

If applicable, this property is filled after a call to the GetShippingTime.

serviceType
ServiceTypes (read-only)
Default Value: 0

Indicates the service type in the list of available services returned.

This is populated when the GetShippingTime or GetRates methods are called.

Valid values for FedEx are:


stUnspecified (0)
stFedExPriorityOvernight (10)
stFedExStandardOvernight (11)
stFedExFirstOvernight (12)
stFedEx2Day (13)
stFedExExpressSaver (14)
stFedExGround (15)
stFedExGroundHomeDelivery (16)
stFedEx1DayFreight (17)
stFedEx2DayFreight (18)
stFedEx3DayFreight (19)
stFedExInternationalPriority (20)
stFedExInternationalEconomy (21)
stFedExInternationalFirst (22)
stFedExInternationalPriorityFreight (23)
stFedExInternationalEconomyFreight (24)
stFedExEuropeFirstInternationalPriority (25)	For intra-Europe shipments only.
stFedExSmartPost (26)
stFedEx2DayAM (27)
stFedExFirstFreight (28)
stFedExFreightEconomy (30)
stFedExFreightPriority (31)
stFedExInternationalPriorityExpress (32)
stFedExInternationalConnectPlus (33)
stFedExFirst (140)	For EU and APAC Regions only.
stFedExPriority (141)	For EU and APAC Regions only.
stFedExPriorityExpress (142)	For EU and APAC Regions only.
stFedExPriorityExpressFreight (143)	For EU and APAC Regions only.
stFedExPriorityFreight (144)	For EU and APAC Regions only.
stFedExEconomySelect (145)	For UK only.

Valid values for UPS are:


Value	Applicable for
stUnspecified (0)
stUPSFirstClass(35)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMail(36)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSExpeditedMailInnovations(37)	US Domestic Shipments, requires a contract with Mail Innovations, single package shipments only
stUPSPriorityMailInnovations (38)	All origins, requires a contract with Mail Innovations, single package shipments only
stUPSEconomyMailInnovations (39)	All Origins, requires a contract with Mail Innovations, single package shipments only
stUPSNextDayAir (40)	US Domestic Shipments; Originating in US/PR
stUPSExpress (41)	Polish Domestic Shipments; All Origins
stUPS2ndDayAir (42)	US Domestic Shipments; Originating in US/PR
stUPSGround (43)	US Domestic Shipments; Originating in US/PR
stUPSWorldwideExpress (44)	Originating in US/PR
stUPSWorldwideExpedited (45)	US/PR, Canada and Non-EU origins, EXCEPT Mexico
stUPSExpedited (46)	Polish Domestic Shipments; Originating in EU or Mexico
stUPSStandard (47)	Polish Domestic Shipments; All Origins
stUPS3DaySelect (48)	US Domestic Shipments; Originating in CA or US
stUPSNextDayAirSaver (49)	US Domestic Shipments
stUPSSaver (50)	US or Polish Domestic Shipments; All Origins
stUPSNextDayAirEarlyAM (51)	US Domestic Shipments; Originating in CA or US/PR
stUPSExpressEarlyAM (52)	Originating in CA
stUPSWorldwideExpressPlus (53)	Polish Domestic Shipments; All Origins EXCEPT Canada and Mexico
stUPSExpressPlus (54)	Originating in Mexico
stUPS2ndDayAirAM (55)	US Domestic Shipments; Originating in US
stUPSTodayStandard (56)	Polish Domestic Shipments (Stolica)
stUPSTodayCourrier (57)	Polish Domestic Shipments (Stolica)
stUPSTodayInterCity (58)	Polish Domestic Shipments (Stolica)
stUPSTodayExpress (59)	Polish Domestic Shipments (Stolica)
stUPSTodayExpressSaver (60)	Polish Domestic Shipments (Stolica)
stUPSWorldwideExpressFreight (61)	All Origins; Worldwide Express Freight
stUPSSurePostLessThan1LB (62)	US Domestic Shipments, SurePost Less Than 1LB
stUPSSurePost1LBOrGreater (63)	US Domestic Shipments, SurePost 1LB Or Greater
stUPSSurePostBPM (64)	US Domestic Shipments, SurePost BPM (Bound Printed Matter)
stUPSSurePostMedia (65)	US Domestic Shipments, SurePost Media
stUPSWorldwideEconomyDDU (131)	Originating in Canada or US, requires a contract with UPS
stUPSWorldwideEconomyDDP (132)	Originating in Canada or US, requires a contract with UPS

Valid values for USPS are:


stUnspecified (0)
stUSPSExpress (70)
stUSPSFirstClass (71)
stUSPSPriority (72)
stUSPSParcelPost (73)
stUSPSBPM (74) (USPS Only )
stUSPSMedia (75)
stUSPSLibrary (76)
stUSPSOnline (77) (USPS Only )
stUSPSParcelSelect (79) (Endicia only)
stUSPSCriticalMail (80) (Endicia only)
stUSPSStandardMail (81) (Endicia only)
stUSPSPriorityExpress (85) (Endicia only)
stUSPSRetailGround (86) (Endicia only)
stUSPSParcelSelectGround (133)
stUSPSPriorityMailCubic (134)
stUSPSGroundAdvantage (135)
stUSPSGroundAdvantageCubic (136)

Please note that the RequestedService stUSPSBPM (74) is no longer supported by Endicia.

Valid values for Canada Post are:


stCanadaRegularParcel (90)
stCanadaExpeditedParcel (91)
stCanadaXpresspost (92)
stCanadaXpresspostCertified (93)
stCanadaPriority (94)
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)

serviceTypeDescription
String (read-only)
Default Value: ""

Indicates the textual description of a service type in the list of available services returned.

Possible returned values for FedEx are:


Service Type	Service Type Description
10	PRIORITY_OVERNIGHT
11	STANDARD_OVERNIGHT
12	FIRST_OVERNIGHT
13	FEDEX_2_DAY
14	FEDEX_EXPRESS_SAVER
15	FEDEX_GROUND
16	GROUND_HOME_DELIVERY
17	FEDEX_1_DAY_FREIGHT
18	FEDEX_2_DAY_FREIGHT
19	FEDEX_3_DAY_FREIGHT
20	FEDEX_INTERNATIONAL_PRIORITY
21	INTERNATIONAL_ECONOMY
22	INTERNATIONAL_FIRST
23	INTERNATIONAL_PRIORITY_FREIGHT
24	INTERNATIONAL_ECONOMY_FREIGHT
25	EUROPE_FIRST_INTERNATIONAL_PRIORITY
26	SMART_POST
27	FEDEX_2_DAY_AM
28	FEDEX_FIRST_FREIGHT
30	FEDEX_FREIGHT_ECONOMY
31	FEDEX_FREIGHT_PRIORITY
32	FEDEX_INTERNATIONAL_PRIORITY_EXPRESS
33	FEDEX_INTERNATIONAL_CONNECT_PLUS
140	FEDEX_FIRST
141	FEDEX_PRIORITY
142	FEDEX_PRIORITY_EXPRESS
143	FEDEX_PRIORITY_EXPRESS_FREIGHT
144	FEDEX_PRIORITY_FREIGHT
145	FEDEX_ECONOMY_SELECT

shipDate
String (read-only)
Default Value: ""

Date UPS picks up the package from the origin. In the event the differs from the ShipDate provided in the request, a warning message will be returned.

This is only applicable to UPS GetShippingTime.

Format: YYYY-MM-DD.

shipTime
String (read-only)
Default Value: ""

Time UPS picks up the package from the origin. It is returned for requests outside the US. If applicable, this property is filled after a call to the GetShippingTime.

This is only applicable to UPS GetShippingTime.

Format: HH:MM:SS

signatureType
String (read-only)
Default Value: ""

Indicates the textual description of the delivery signature services option required by FedEx for the . This might be different from the requested PackagesSignatureType.

Possible returned values are:


ADULT
DIRECT
INDIRECT
NO_SIGNATURE_REQUIRED
SERVICE_DEFAULT

transitTime
String (read-only)
Default Value: ""

Expected number of days in transit from pickup to delivery for the . This is an estimate only and depends on the customs clearance times. It is optional to be returned in the server reply.

UPSAccount Type

Represents the details of a UPS account.

Remarks

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

Example: Setting the fields of an account UPSAccount account = new UPSAccount account.AuthorizationToken = "Bearer token..." account.Server = "https://wwwcie.ups.com/api/"; account.AccountNumber = "12345";

The properties contained by this type are listed below.

Fields

accountNumber
String
Default Value: ""

The shipper's UPS account number.

This property describes the shipper's 6- or 10- digit UPS account number.

authorizationToken
String
Default Value: ""

Authorization Token used to authenticate the request.

This field should be set to the value of a bearer token obtained through OAuth 2.0. For more information on getting a bearer token, see the documentation for the OAuth component.

server
String
Default Value: ""

URL for the UPS server where the requests are sent. This will overwrite the internal values that the component uses.

Normally, you do not need to set this property. By default, the component will send the request to the preset production end-point. In order to send request to the test environment, you must set the TESTMODE config to true like: component.Config("TESTMODE=true").

The following URLs may be used for testing:


class	Test URL
UPSAddress	https://wwwcie.ups.com/api/addressvalidation/
UPSFreightRate	https://wwwcie.ups.com/api/freight/
UPSFreightShip	https://wwwcie.ups.com/api/freight/
UPSRates	https://wwwcie.ups.com/api/rating/
UPSRates (ShippingTime)	https://wwwcie.ups.com/api/shipments/
UPSShip	https://wwwcie.ups.com/api/shipments/
UPSShip (Schedule Pickup)	https://wwwcie.ups.com/api/pickupcreation/
UPSShipIntl	https://wwwcie.ups.com/api/shipments/
UPSTrack	https://wwwcie.ups.com/api/track/
All (Void)	https://wwwcie.ups.com/api/shipments/

Constructors

public init()

Config Settings (UPSRates Module)

The class accepts one or more of the following configuration settings. Configuration 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.

UPSRates Config Settings

AlternateDeliveryAddress: Alternate Delivery Address is used for Hold for Pickup or Delivery at UPS Access Points.

This field, if used, should be specified as a JSON and will be contained within the "AlternateDeliveryAddress" element of the request.

Sample JSON: component.Config(@"AlternateDeliveryAddress= ""AlternateDeliveryAddress: { ""Name"": ""THE UPS STORE"", ""AttentionName"": ""THE UPS STORE"", ""UPSAccessPointID"": "", ""Address"": { ""AddressLine"": [ ""1289 FORDHAM BLVD"" ], ""City"": ""Chapel Hill"", ""StateProvinceCode"": ""NC"", ""PostalCode"": ""27514-6110"", ""CountryCode"": ""US"" } }");

CurrencyCode: The currency code associated with the monetary values present in the request.

This is required to be provided if monetary values are specified in the request (such as COD amount, insured value, customs value, etc.). This must conform to ISO standards.

Maximum length: 3.

Here is a list of currency names and their codes used by UPS services.


Currency Name	Currency Code
AFGHANI	AFA
AFGHANI	AFG
ALGERIA	DZD
ALGERIAN DINAR	ALD
ARGENTINE PESO	ARN
ARGENTINE PESO	ARP
ARUBIAN CUR. CD	NAF
ARUBIAN GUILDER	AWG
AUSTRALIAN DOLLAR	AUD
AUSTRIAN EURO	EUR
BAHAMIAN DOLLAR	BSD
BAHRAINI DINAR	BHD
BAHT	BHT
BAHT	THB
BALBOA	BAL
BALBOA	PAB
BARBADOS DOLLAR	BBD
BARBADOS DOLLAR	BDD
BELGIUM EURO	EUR
BELIZE DOLLAR	BZD
BERMUDA DOLLAR	BMD
BERMUDAN DOLLAR	BED
BOLIVAR	VBO
BOLIVAR	VEB
BOLIVIAN PESO	BOP
BOSNIA DINAR	BAD
BRITISH POUND	UKL
BRUNEI DOLLAR	BND
BRUNEI DOLLAR	BRD
BURUNDI FRANC	BIF
BURUNDI FRANC	FRB
CANADIAN DOLLAR	CAD
CAYMAN DOLLAR	CID
CAYMAN DOLLAR	KYD
CEDI	GHC
CFA FRANC	AFR
CFA FRANC	XAF
CFA FRANC	XOF
CFP FRANC	PFR
CFP FRANC	XPF
CHILEAN PESO	CHP
CHILEAN PESO	CLP
COLOMBIAN PESO	COP
COMOROS FRANC	KMF
CONGO, DEMOCRATIC REPUBLIC OF	CDF
CORDOBA	COR
CORDOBA	NIC
COSTA RIC COLON	CRC
COSTA RICAN COLON	CFC
CP VERDE ESCUDO	CVE
CRUZEIRO	BRC
CRUZEIRO	CRU
CUBAN PESO	CUP
CYPRUS POUND	CYL
CYPRUS POUND	CYP
DALASI	GAD
DALASI	GMD
DANISH KRONE	DKK
DANISH KRONE	DKR
DEUTSCHE MARK	DMK
DJIBOUTI FRANC	DFR
DJIBOUTI FRANC	DJF
DOBRA	STD
DOMINICAN REP	DOP
DONG	VDD
DONG	VND
E.CARI.DOLLAR	ECD
EAST CARRIBEAN DOLLAR	XCD
EGYPTIAN POUND	EGL
EGYPTIAN POUND	EGP
EKWELE	GQE
EL SAL. COLON	SAC
EL SALVADOR COLON	SVC
ESTLAND KROWN	EKR
ESTONIA KRONERS	EEK
ETHIOPIAN BIRR	ETB
EURO	EUR
EUROP. CUR. UNT	XEU
FIJI DOLLAR	FID
FIJI DOLLAR	FJD
FINNISH EURO	EUR
FORINT	FOR
FORINT	HUF
FRANC CFA	CFA
FRENCH EURO	EUR
FRF FFR	HRK
GERMAN EUR	EUR
GIBRALTAR POUND	GBL
GIBRALTAR POUND	GIP
GOURDE	GOU
GOURDE	HTG
GREEK EURO	EUR
GUARANI	GUA
GUARANI	PYG
GUINEA-BISSAU PESO	GWP
GUINE-BS.PESO	GWE
GUYANA DOLLAR	GYD
HONG KONG DOLLAR	HKD
ICELAND KRONA	IKR
ICELAND KRONA	ISK
INDIAN RUPEE	RPS
INDIAN RUPES	INR
IRANIAN RIAL	IRI
IRANIAN RIAL	IRR
IRAQI DINAR	IQD
IRAQI DINAR	IRD
IRISH EURO	EUR
ITALIAN EURO	EUR
JAMAICAN DOLLAR	JAD
JAMAICAN DOLLAR	JMD
JAPANESE YEN	JPY
JAPANESE YEN	JYE
JORDANIAN DINAR	JOD
KENYA SCHILLING	KES
KINA	NGK
KINA	PGK
KIP	KIP
KIP	LAK
KORUNA	CKR
KORUNA	CSK
KORUNA	CZK
KORUNA	SKK
KUWAITI DINAR	KUD
KUWAITI DINAR	KWD
KWACHA	MWK
KWACHA	ZMK
KWANZA	AKZ
KWANZA	AOK
KYAT	BUK
KYAT	BUR
LEBANESE POUND	LBP
LEBANESE POUND	LEL
LEK	ALL
LEK	LEK
LEMPIRA	HNL
LEMPIRA	LEM
LEONE	SLE
LEONE	SLL
LEU	LEI
LEU	ROL
LEV	BGL
LEV	LEV
LIBERIAN DOLLAR	LID
LIBERIAN DOLLAR	LRD
LIBYAN DOLLAR	LBD
LIBYAN DOLLAR	LYD
LILANGENI	SZL
LITAS	UAH
LITHUANIA LITAS	LTL
LITHUANIA RUBLE	LTR
LUXEMBOURG FRANC	LFR
LUXEMBOURG FRANC	LUF
MALAGASY FRANC	FMG
MALAGASY FRANC	MGF
MALAYSIAN RINGGIT	MYR
MALDIVE RUPEE	MVR
MALETESE	MAL
MALI FRANC	MLF
MALOTI	LSM
MALTESE POUND	MTP
MARK DER DDR	MRK
MAURITIUS RUPEE	MAR
MAURITIUS RUPEE	MUR
MAYLASIAN RINGGIT	RGT
METICAL	ESM
METICAL	MZM
MEXICAN PESO	MEP
MEXICAN PESO	MXN
MEXICAN PESO	MXP
MOROCCAN DIRHAM	MAD
MOROCCAN DIRHAM	MDH
NAIRA	NGN
NAMIBIA DOLLARS	NAD
NEPALESE RUPEE	NER
NEPALESE RUPEE	NPR
NETH. AN GUILDER	AFL
NETHERLANDS ANTILLIAN GUILDER	ANG
NETHERLANDS EURO	EUR
NEW TAIWAN DOLLAR	NTD
NEW TAIWAN DOLLAR	TWD
NEW YUGOSLAVIAN DINAR	CTD
NEW YUGOSLAVIAN DINAR	YUD
NEW ZEALAND DOLLAR	NZD
NORWEGIAN KRONE	NKR
NORWEGIAN KRONE	NOK
OMANI RIAL	OMR
OMANI RIAL	RIO
OUGUIYA	MOG
OUGUIYA	MRO
PAANGA	TOP
PAKISTAN RUPEE	PKR
PAKSTAN RUPEE	PAR
PATACA	MOP
PHILLIPINE PESO	PHP
POLISH ZLOTY	PLN
PORTUGESE EURO	EUR
POUND STERLING	GBP
PULA	BTP
PULA	BWP
QATARI RIAL	QAR
QATARI RIAL	QRI
QUETZAL	GTO
QUETZAL	QUE
REPUBLIC OF CONGO (ZAIRE)	ZRN
RIEL	KHR
RIEL	RLS
ROUBLE	ROU
ROUBLE	SUR
RUPIAH	IDR
RUPIAH	RPA
RUSSIAN FEDERATION	RUB
RUSSIAN ROUBLE	RUR
RWANDA FRANC	FRR
RWANDA FRANC	RWF
S KOREAN WON	KRW
S KOREAN WON	WON
SAUDI RIAL	ARI
SCHEKEL	ISL
SEYCHELL.RUPEE	SCR
SEYCHELL.RUPEE	SER
SHEKEL	ILS
SINGAPORE DOLLAR	SGD
SINGAPORE DOLLAR	SID
SLOVENIA	SIT
SOL	PES
SOL	SOL
SOLOMON ISLANDS DOLLAR	SBD
SOMALI SHILLING	SOS
SOMALI SHILLING	SOM
SOUTH AFRICAN RAND	SAR
SOUTH AFRICAN RAND	ZAR
SPANISH EURO	EUR
SRI LANKA RUPEE	CER
SRI LANKA RUPEE	LKR
SRNME.GUILDER	SFL
SRNME.GUILDER	SRG
ST HELENA POUND	SHP
SUCRE	ECS
SUCRE	SUC
SUDANESE POUND	SDP
SUDANESE POUND	SUL
SWEDISH KRONA	SEK
SWEDISH KRONA	SKR
SWISS FRANC	SFR
SWISS FRANK	CHF
SYLI	GNS
SYLI	GSI
SYRIAN POUND	SYL
SYRIAN POUND	SYP
TAKA	BDT
TALA	SAT
TALA	WST
TIMOR ESCUDO	TPE
TNZN.SHILLING	TAS
TNZN.SHILLING	TZS
TRINIDAD AND TOBAGO DOLLAR	TTD
TUGRIK	MNT
TUGRUG	TUG
TUNISIAN DINAR	TND
TUNISIAN DINAR	TUD
TURKISH LIRA	TRL
TURKISH LIRA	TUL
UAE DIRHAM	ADH
UAE DIRHAM	AED
UGANDA SHILLING	UGS
URUGUAYAN PESO	NUP
URUGUAYAN PESO	UYP
US DOLLAR	USD
VATU	VUV
YEMENI DINAR	DYD
YEMENI DINAR	YDD
YEMENI RIAL	YEM
YEMENI RIAL	YER
YUAN RENMINBI	RMB
YUAN RENMINIBI	CNY
ZAIRE	ZAI
ZAIRE	ZRZ
ZIMBABWE DOLLAR	ZWD

CustomerTransactionId: Customer transaction id / customer context information.

This element allows you to assign a unique identifier to your transaction. This element is returned in the reply and helps you match requests to replies.

Documents: Whether the shipment contains only documents.

If False (default value), this means that this shipment contains NO documents. If set to True, it means that this shipment contains documents ONLY. This is applicable for international shipments only. An international shipment can either contain documents only, or no documents. Documents and other commodities cannot be mixed in a shipment.

EPRAIndicator: Indicates that a Package Release Code is requested for this shipment.

Indicates that a Package Release Code is requested for this shipment. Only valid when ShipmentIndicationType is 1.

FRSCommodityCount: Number of commodities in the shipment.

This configuration property is used to specify the number of commodities for the freight rated shipment.