UPSShip Class

Properties Methods Events Config Settings Errors

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

Syntax

dshippingsdk.Upsship

Remarks

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

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

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

Property List

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


AccountAddress	Identifies the UPS AccountNumber holder's address, if different from the sender's address.
AccountContact	Identifies the UPS AccountNumber holder's contact info if different from SenderContact .
Firewall	A set of properties related to firewall access.
LabelImageType	Type of image or printer commands the shipping label is to be formatted in.
MasterTrackingNumber	Tracking number assigned to the whole MPS shipment.
Notify	Collection of e-mail notifications to be sent.
Packages	A collection of packages contained in the shipment.
Payor	Identifies the payor of transportation charges for the requested shipment.
PickupContainerType	The type of container to be picked up.
PickupEarliestTime	The earliest time a shipment is ready to be picked up.
PickupLatestTime	The latest time a shipment can be picked up.
PickupPaymentMethod	The method of payment for a pickup.
Proxy	This property includes a set of properties related to proxy access.
RecipientAddress	Identifies the recipient's address.
RecipientContact	Identifies the recipient's contact info.
SenderAddress	Identifies the sender's address.
SenderContact	Identifies the sender's contact info.
ServiceType	Identifies the UPS service type (applicable to US domestic shipments) to use in a ship request.
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.
ShipmentVoidStatus	Status description of shipment void request.
SSLAcceptServerCert	Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLProvider	This specifies the SSL/TLS implementation to use.
SSLServerCert	The server certificate for the last established connection.
Timeout	A timeout for the class.
TotalBaseCharge	The total base charge applied to the whole shipment (specific to the AccountNumber ).
TotalNetCharge	The total net charge (transportation charge + options charges) applied to the whole shipment (specific to the AccountNumber ).
TotalSurcharges	The total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ).
TotalTransportationCharge	The total transportation charges applied to the whole shipment (specific to the AccountNumber ).
UPSAccount	Login information for UPS.

Method List

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


CancelPackage	Cancels a single package by deleting it from the shipping log.
CancelPickup	Cancel a pickup.
CancelShipment	Cancels an entire multi-package (MPS) shipment by deleting it from the shipping log.
Config	Sets or retrieves a configuration setting.
GetShipmentLabels	Generates a shipping label using one of domestic UPS services.
Reset	Resets the internal state of the class and all properties to their default values.
SchedulePickup	Schedules a pickup.

Event List

The following is the full list of the events fired by the class 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	Shows the progress of the secure connection.

Config Settings

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


AccountAddress3	Contains line three details for the Account Address.
AccountTotalNetCharge	Net sum of negotiated rates applied to the whole shipment (if applicable).
AlternateDeliveryAddress	Alternate Delivery Address is used for Hold for Pickup or Delivery at UPS Access Points.
BarCodeReference	Determines whether the reference number's value will be bar coded on the shipping label.
CancelPickUpStatus	Status description of Cancel Pickup request.
CertifyDirectory	The name of the directory where the files needed for Label Certification are written.
CurrencyCode	The currency code associated with the monetary values present in the request.
CustomerTransactionId	Customer transaction id / customer context information.
ElectronicReturnLabel	Indicates that you are arranging for UPS to email a return label to your customer.
EPRAReleaseCode	Package Release code that allows the consignee or claimant to pick-up a package at a UPS Access Point.
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.
HazMatAdditionalDescription[i]	Additional remarks or special provision information.
HazMataDRItemNumber[i]	The type of regulated goods for an ADR package where ADR is for Europe to Europe ground movement.
HazMataDRPackingGroupLetter[i]	Required if the field applies to the material by regulation. Must be shown in Roman Numerals.
HazMatAllPackedInOneIndicator[i]	Presence/Absence Indicator.
HazMatChemicalRecordIdentifier[i]	Identifies the Chemcial Record.
HazMatClassDivisionNumber[i]	This is the hazard class associated to the specified commodity.
HazMatCommodityRegulatedLevelCode[i]	Indicates the type of commodity.
HazMatEmergencyContact[i]	The emergency information, contact name and/or contract number.
HazMatEmergencyPhone[i]	24 Hour Emergency Phone Number of the shipper.
HazMatHazardLabelRequired[i]	Defines the type of label that is required on the package for the commodity.
HazMatIDNumber[i]	This is the ID number (UN/NA/ID) for the specified commodity.
HazMatOverPackedIndicator[i]	Presence/Absence Indicator.
HazMatPackageIdentifier[i]	Identifies the package containing Dangerous Goods.
HazMatPackagingGroupType[i]	This is the packing group category associated to the specified commodity.
HazMatPackagingInstructionCode[i]	The packing instructions related to the chemical record.
HazMatPackagingType[i]	The type of package used to contain the regulated good.
HazMatPackagingTypeQuantity[i]	The number of pieces of the specific commodity.
HazMatProperShippingName[i]	The Proper Shipping Name assigned by ADR, CFR or IATA.
HazMatQuantity[i]	.
HazMatQValue[i]	.
HazMatReferenceNumber[i]	Optional reference number. Will be displayed only on label.
HazMatRegulationSet[i]	The Regulatory set associated with every regulated shipment.
HazMatReportableQuantity[i]	.
HazMatSubRiskClass[i]	Secondary hazardous characteristics of a package.
HazMatTechnicalName[i]	The technical name (when required) for the specified commodity.
HazMatTransportationMode[i]	Declares that a package was prepared according to ground, passenger aircraft, or cargo aircraft only.
HazMatTransportCategory[i]	Transport Category.
HazMatTunnelRestrictionCode[i]	.
HazMatUOM[i]	.
HighValueReport	High Value Report (if applicable).
HighValueReportFileName	Name of High Value Report (if applicable).
IncludeNegotiatedRates	Whether to include the NegotiatedRatesIndicator in the request.
IrregularIndicator	The mail classification defined by UPS.
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.
LabelSize	The size of the label.
Machineable	Determines whether the package is machineable or not.
MasterCartonId	Master Carton ID.
MICostCenter	Customer assigned identifier for report and billing summarization displays to the right of the Cost Center title.
MIPackageID	Customer assigned unique piece identifier that returns visibility events.
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.
Overwrite	Determines whether label files will be overwritten.
PackageDeclaredValueType[i]	The type of declared value (corresponding to the package at index i).
PackageShippingLabelFileHTML[i]	Name of the file where the HTML image of the shipping label (corresponding to the package at index i) is saved to disk.
PackageShippingLabelHTML[i]	HTML version of the shipping label (corresponding to the package at index i).
PickupEarliestTime	The earliest time a shipment is ready to be picked up.
PickupFloorNumber	The floor number of the pickup location.
PickupLatestTime	The latest time a shipment can be picked up.
PickupRoomNumber	The room number of the pickup location.
RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
RecipientAddress3	Contains line three details for the Recipient Address.
RequestDeliveryConfirmation	Whether or not to request delivery confirmation for the package/shipment.
RequestOption	Defines if the address should be validated or not.
ReturnFreightPrices	When true, UPS will use applicable freight pricing for shipments.
ReturnPrintAndMail	Indicates that you are arranging for UPS to print and mail a return label to your customer.
ReturnServiceFirstAttempt	Indicates that you are arranging for UPS to make one attempt to pick up the package to be returned.
ReturnServiceThirdAttempt	Indicates that you are arranging for UPS to make three attempts to pick up the package to be returned.
SenderAddress3	Contains line three details for the Sender Address.
ShipmentAcceptRequest	Contains the Shipment Accept Request sent to UPS.
ShipmentAcceptResponse	Contains the Shipment Accept Response returned by UPS.
ShipmentConfirmRequest	Contains the Shipment Confirm Request sent to UPS.
ShipmentConfirmResponse	Contains the Shipment Confirm Response returned by UPS.
ShipmentDescription	A textual description of goods for the whole shipment when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.
ShipmentIndicationType	Whether shipment is Hold For Pickup or Delivery at UPS Access Points.
ShipmentSignatureType	Shipment signature type at the shipment level.
ShippingLabelHTMLDirectory	The name of the directory where the shipping label files are written.
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.
TotalCustomsValue	Invoice Line Total Monetary Value when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.
USPSEndorsement	The USPS endorsement type for Mail Innovations and SurePost shipments.
USPSPICNumber[i]	USPS Tracking Number (corresponding to the package at index i).
Version	UPS API Version.
Warning	Warning message returned by the server.
WeightUnit	Weight unit.
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.
AllowNTLMFallback	Whether to allow fallback from Negotiate to NTLM when authenticating.
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 class.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to True the class 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 class.
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.
MaxHeaders	Instructs class to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs class to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
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 class.
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.
UsePlatformDeflate	Whether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UseProxyAutoConfigURL	Whether to use a Proxy auto-config file when attempting a connection.
UserAgent	Information about the user agent (browser).
CloseStreamAfterTransfer	If true, the class will close the upload or download stream after the transfer.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallListener	If true, the class binds to a SOCKS firewall as a server (TCPClient only).
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 class 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.
UseNTLMv2	Whether to use NTLM V2.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
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.
SSLContextProtocol	The protocol used when getting an SSLContext instance.
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.
SSLServerCACerts	A newline separated list of CA certificate to use during SSL server certificate validation.
SSLTrustManagerFactoryAlgorithm	The algorithm to be used to create a TrustManager through TrustManagerFactory.
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.
GUIAvailable	Tells the class whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseInternalSecurityAPI	Tells the class whether or not to use the system security libraries or an internal implementation.

AccountAddress Property (UPSShip Class)

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

Syntax


public AddressDetail getAccountAddress();


public void setAccountAddress(AddressDetail accountAddress);

Remarks

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

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

Please refer to the AddressDetail type for a complete list of fields.

AccountContact Property (UPSShip Class)

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

Syntax


public ContactDetail getAccountContact();


public void setAccountContact(ContactDetail accountContact);

Remarks

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

If the CountryCode is international, or if Commercial Invoice and other International forms are requested, the FirstName and LastName are required to be provided in the request.

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

Please refer to the ContactDetail type for a complete list of fields.

Firewall Property (UPSShip Class)

A set of properties related to firewall access.

Syntax


public Firewall getFirewall();


public void setFirewall(Firewall firewall);

Remarks

This is a Firewall type property which contains fields describing the firewall through which the class will attempt to connect.

Please refer to the Firewall type for a complete list of fields.

LabelImageType Property (UPSShip Class)

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

Syntax


public int getLabelImageType();


public void setLabelImageType(int labelImageType);


Enumerated values:
  public final static int uitGIF = 0;
  public final static int uitEPL = 1;
  public final static int uitSPL = 2;
  public final static int uitZPL = 3;
  public final static int uitStar = 4;

Default Value

Remarks

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

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


Value	Usage
uitGIF (0)	To be used for image formats.
uitEPL (1)	To be used with EPL2 formatted labels.
uitSPL (2)	To be used with SPL formatted labels.
uitZPL (3)	To be used with ZPL formatted labels.
uitStar (4)	To be used with STAR printer formatted labels. Not a valid image type when using Mail Innovations.

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

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

MasterTrackingNumber Property (UPSShip Class)

Tracking number assigned to the whole MPS shipment.

Syntax


public String getMasterTrackingNumber();

Default Value

Remarks

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

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

This property is read-only.

Notify Property (UPSShip Class)

Collection of e-mail notifications to be sent.

Syntax


public NotifyDetailList getNotify();


public void setNotify(NotifyDetailList notify);

Remarks

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

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

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

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

class.Notify[0].Email = "test@test.com"; class.Notify[0].NotificationFlags = 0x00000001; // On Shipment class.Notify[0].Message = "test";

This property is not available at design time.

Please refer to the NotifyDetail type for a complete list of fields.

Packages Property (UPSShip Class)

A collection of packages contained in the shipment.

Syntax


public PackageDetailList getPackages();


public void setPackages(PackageDetailList packages);

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 PackagingType is required. The Description is optional. The Weight, Length, Width, and Height are all conditionally required. More information can be found in the individual field definitions.

This property is not available at design time.

Please refer to the PackageDetail type for a complete list of fields.

Payor Property (UPSShip Class)

Identifies the payor of transportation charges for the requested shipment.

Syntax


public PayorDetail getPayor();


public void setPayor(PayorDetail payor);

Remarks

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

Please refer to the PayorDetail type for a complete list of fields.

PickupContainerType Property (UPSShip Class)

The type of container to be picked up.

Syntax


public int getPickupContainerType();


public void setPickupContainerType(int pickupContainerType);


Enumerated values:
  public final static int pccPackage = 0;
  public final static int pccLetter = 1;
  public final static int pccPallet = 2;

Default Value

Remarks

This indicates what type of container is being picked up.

Note the pccPallet is only valid if ServiceType is set to stUPSWorldwideExpressFreight.

PickupEarliestTime Property (UPSShip Class)

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

Syntax


public String getPickupEarliestTime();


public void setPickupEarliestTime(String pickupEarliestTime);

Default Value

Remarks

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

This should be entered in this format: HHmm.

PickupLatestTime Property (UPSShip Class)

The latest time a shipment can be picked up.

Syntax


public String getPickupLatestTime();


public void setPickupLatestTime(String pickupLatestTime);

Default Value

Remarks

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

This should be entered in this format: HHmm.

PickupPaymentMethod Property (UPSShip Class)

The method of payment for a pickup.

Syntax


public int getPickupPaymentMethod();


public void setPickupPaymentMethod(int pickupPaymentMethod);


Enumerated values:
  public final static int ppmNone = 0;
  public final static int ppmAccount = 1;
  public final static int ppmTrackingNumber = 2;
  public final static int ppmCheckOrMoneyOrder = 3;

Default Value

Remarks

This indicates how the pickup will be paid for.

The valid values are as follows:


Value	Meaning
ppmNone (0)	For countries and/or zip codes where pickup is free of charge.
ppmAccount (1)	The account number specified will be billed for the pickup.
ppmTrackingNumber (2)	The shipper has agreed to pay for the pickup.
ppmCheckOrMoneyOrder (3)	The shipper will pat for the pickup with a check or money order.

Proxy Property (UPSShip Class)

This property includes a set of properties related to proxy access.

Syntax


public Proxy getProxy();


public void setProxy(Proxy proxy);

Remarks

This property contains fields describing the proxy through which the class will attempt to connect.

Please refer to the Proxy type for a complete list of fields.

RecipientAddress Property (UPSShip Class)

Identifies the recipient's address.

Syntax


public AddressDetail getRecipientAddress();


public void setRecipientAddress(AddressDetail recipientAddress);

Remarks

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

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

Please refer to the AddressDetail type for a complete list of fields.

RecipientContact Property (UPSShip Class)

Identifies the recipient's contact info.

Syntax


public ContactDetail getRecipientContact();


public void setRecipientContact(ContactDetail recipientContact);

Remarks

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

The Company is required to be provided in the request. In domestic shipments: the FirstName and LastName are required when using UPS Next Day Air Early A.M. service. In international shipments: the FirstName and LastName are required when the CountryCode is different than CountryCode, and if Commercial Invoice international form is requested.

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

Please refer to the ContactDetail type for a complete list of fields.

SenderAddress Property (UPSShip Class)

Identifies the sender's address.

Syntax


public AddressDetail getSenderAddress();


public void setSenderAddress(AddressDetail senderAddress);

Remarks

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

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

Please refer to the AddressDetail type for a complete list of fields.

SenderContact Property (UPSShip Class)

Identifies the sender's contact info.

Syntax


public ContactDetail getSenderContact();


public void setSenderContact(ContactDetail senderContact);

Remarks

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

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

Please refer to the ContactDetail type for a complete list of fields.

ServiceType Property (UPSShip Class)

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

Syntax


public int getServiceType();


public void setServiceType(int serviceType);


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

Default Value

Remarks

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

Valid values for UPS are:


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
stUPSNextDayAir (40)	US Domestic Shipments
stUPS2ndDayAir (42)	US Domestic Shipments
stUPSGround (43)	US Domestic Shipments
stUPS3DaySelect (48)	US Domestic Shipments
stUPSNextDayAirSaver (49)	US Domestic Shipments
stUPSSaver (50)	US Domestic Shipments, only available when shipping to remote parts of Alaska or Hawaii
stUPSNextDayAirEarlyAM (51)	US Domestic Shipments
stUPS2ndDayAirAM (55)	US Domestic Shipments

This property is not available at design time.

ShipDate Property (UPSShip Class)

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

Syntax


public String getShipDate();


public void setShipDate(String shipDate);

Default Value

Remarks

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

This should be entered in this format: YYYYMMDD.

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

ShipmentSpecialServices Property (UPSShip Class)

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

Syntax


public long getShipmentSpecialServices();


public void setShipmentSpecialServices(long shipmentSpecialServices);

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 CountryCode, CountryCode and CountryCode: 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 Description is required to be provided in the request for each package contained in the shipment. The PackagingType should be set to a value other than: 4 (ptUPS25kgBox), 5 (ptUPS10kgBox), and 6 (ptPallet). Return shipments cannot be voided at the package level. Return shipments can be voided within 24 hours only.

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

ShipmentVoidStatus Property (UPSShip Class)

Status description of shipment void request.

Syntax


public String getShipmentVoidStatus();

Default Value

Remarks

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

This property is read-only.

SSLAcceptServerCert Property (UPSShip Class)

Instructs the class to unconditionally accept the server certificate that matches the supplied certificate.

Syntax


public Certificate getSSLAcceptServerCert();


public void setSSLAcceptServerCert(Certificate SSLAcceptServerCert);

Remarks

If it finds any issues with the certificate presented by the server, the class will normally terminate the connection with an error.

You may override this behavior by supplying a value for SSLAcceptServerCert. If the certificate supplied in SSLAcceptServerCert is the same as the certificate presented by the server, then the server certificate is accepted unconditionally, and the connection will continue normally.

Please note that this functionality is provided only for cases where you otherwise know that you are communicating with the right server. If used improperly, this property may create a security breach. Use it at your own risk.

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (UPSShip Class)

The certificate to be used during SSL negotiation.

Syntax


public Certificate getSSLCert();


public void setSSLCert(Certificate SSLCert);

Remarks

The digital certificate that the class will use during SSL negotiation. Set this property to a valid certificate before starting SSL negotiation. To set a certificate, you may set the Encoded field to the encoded certificate. To select a certificate, use the store and subject fields.

Please refer to the Certificate type for a complete list of fields.

SSLProvider Property (UPSShip Class)

This specifies the SSL/TLS implementation to use.

Syntax


public int getSSLProvider();


public void setSSLProvider(int SSLProvider);


Enumerated values:
  public final static int sslpAutomatic = 0;
  public final static int sslpPlatform = 1;
  public final static int sslpInternal = 2;

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 is used by default. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used.

SSLServerCert Property (UPSShip Class)

The server certificate for the last established connection.

Syntax


public Certificate getSSLServerCert();

Remarks

SSLServerCert contains the server certificate for the last established connection.

SSLServerCert is reset every time a new connection is attempted.

This property is read-only.

Please refer to the Certificate type for a complete list of fields.

Timeout Property (UPSShip Class)

A timeout for the class.

Syntax


public int getTimeout();


public void setTimeout(int timeout);

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 throws an exception.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

TotalBaseCharge Property (UPSShip Class)

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

Syntax


public String getTotalBaseCharge();

Default Value

Remarks

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

This property is read-only.

TotalNetCharge Property (UPSShip Class)

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

Syntax


public String getTotalNetCharge();

Default Value

Remarks

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

This property is read-only.

TotalSurcharges Property (UPSShip Class)

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

Syntax


public String getTotalSurcharges();

Default Value

Remarks

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

This property is read-only.

TotalTransportationCharge Property (UPSShip Class)

The total transportation charges applied to the whole shipment (specific to the AccountNumber ).

Syntax


public String getTotalTransportationCharge();

Default Value

Remarks

In a MPS ship request, this represents the total base charge applied to all packages contained in the shipment.

This property is read-only.

UPSAccount Property (UPSShip Class)

Syntax


public UPSAccount getUPSAccount();


public void setUPSAccount(UPSAccount UPSAccount);

Remarks

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

Please refer to the UPSAccount type for a complete list of fields.

CancelPackage Method (Upsship Class)

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

Syntax

public void cancelPackage(String masterTrackingNumber, String packageTrackingNumber);

Remarks

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

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

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

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

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

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

CancelPickup Method (Upsship Class)

Cancel a pickup.

Syntax

public void cancelPickup(String confirmationNumber);

Remarks

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

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

CancelShipment Method (Upsship Class)

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

Syntax

public void cancelShipment(String masterTrackingNumber);

Remarks

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

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

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

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

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

Config Method (Upsship Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

GetShipmentLabels Method (Upsship Class)

Generates a shipping label using one of domestic UPS services.

Syntax

public void getShipmentLabels();

Remarks

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

Server (required)
AuthorizationToken (required)
AccountNumber (required)
ServiceType (required)
AccountContact (conditional)
AccountAddress (conditional)
SenderContact (required)
SenderAddress (required)
RecipientContact (required)
RecipientAddress (required)
Payor (required)
ShipmentSpecialServices (optional)
Packages (required)
LabelImageType (required)
Notify (optional)
WeightUnit (required; defaults to LB)

Upon successful response, the following fields might be populated:

MasterTrackingNumber (if MPS)
TrackingNumber for each package included in the shipment
ShippingLabel for each package included in the shipment
TotalSurcharges for each package included in the shipment
TotalNetCharge (applicable to the whole shipment)
TotalBaseCharge (applicable to the whole shipment)
TotalSurcharges (applicable to the whole shipment)

To print out the ShippingLabel, you can save it to the ShippingLabelFile in LabelImageType format.

Reset Method (Upsship Class)

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

Syntax

public void reset();

Remarks

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

SchedulePickup Method (Upsship Class)

Schedules a pickup.

Syntax

public String schedulePickup();

Remarks

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

The valid properties when calling this method are as follows:

ServiceType (Required)
PickupEarliestTime (Required)
PickupLatestTime (Required)
FirstName (Optional, required if Company is not provided)
LastName (Optional, required if Company is not provided)
Company (Optional, required if FirstName and/or LastName are not provided)
Phone (Required)
Address1 (Required)
PickupFloorNumber (Optional)
PickupRoomNumber (Optional)
City (Required)
State (Required, optional if outside US and Canada)
ZipCode (Required)
CountryCode (Required)
ShipDate (Required)

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

Error Event (Upsship Class)

Information about errors during data delivery.

Syntax

public class DefaultUpsshipEventListener implements UpsshipEventListener {
  ...
  public void error(UpsshipErrorEvent e) {}
  ...
}

public class UpsshipErrorEvent {
  public int errorCode;
  public String 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 (Upsship Class)

Notification returned by the server upon successful request (if applicable).

Syntax

public class DefaultUpsshipEventListener implements UpsshipEventListener {
  ...
  public void notification(UpsshipNotificationEvent e) {}
  ...
}

public class UpsshipNotificationEvent {
  public String 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 (Upsship Class)

Fired after the server presents its certificate to the client.

Syntax

public class DefaultUpsshipEventListener implements UpsshipEventListener {
  ...
  public void SSLServerAuthentication(UpsshipSSLServerAuthenticationEvent e) {}
  ...
}

public class UpsshipSSLServerAuthenticationEvent {
  public byte[] certEncoded;
  public String certSubject;
  public String certIssuer;
  public String status;
  public boolean accept;
}

Remarks

This event is where the client can decide whether to continue with the connection process or not. 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 to continue or not.

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

Shows the progress of the secure connection.

Syntax

public class DefaultUpsshipEventListener implements UpsshipEventListener {
  ...
  public void SSLStatus(UpsshipSSLStatusEvent e) {}
  ...
}

public class UpsshipSSLStatusEvent {
  public String message;
}

Remarks

The event is fired for informational and logging purposes only. Used to track 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 fields 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 Address1 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 Address2 should not exceed 35 characters.

AddressFlags
int
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 City and State are not present.

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

Constructors

public AddressDetail();

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

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

This is the date on which this certificate becomes valid. Before this date, it is not valid. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

Encoded
String
Default Value: ""

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

When Encoded is set, a search is initiated in the current Store for the private key of the certificate. If the key is found, Subject is updated to reflect the full subject of the selected certificate; otherwise, Subject is set to an empty string.

EncodedB
byte[]
Default Value: ""

This is the certificate (PEM/base64 encoded). This field is used to assign a specific certificate. The Store and Subject fields also may be used to specify a certificate.

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

This is the date the certificate expires. After this date, the certificate will no longer be valid. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

ExtendedKeyUsage
String
Default Value: ""

This is a comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

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

This is the hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

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

This is the hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

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

This is the hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

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

This is the issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

KeyPassword
String
Default Value: ""

This is the password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the StorePassword. KeyPassword. This field can be used to read such password-protected private keys.

Note: this property defaults to the value of StorePassword. To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling PrivateKey.

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

This is the private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The PrivateKey may be available but not exportable. In this case, PrivateKey returns an empty string.

PrivateKeyAvailable
boolean (read-only)
Default Value: False

This field shows whether a PrivateKey is available for the selected certificate. If PrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

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

This is the name of the PrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

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

This is the public key of the certificate. The key is provided as PEM/Base64-encoded data.

PublicKeyAlgorithm
String
Default Value: ""

This field contains the textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

PublicKeyLength
int (read-only)
Default Value: 0

This is the length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

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

This is the serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

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

The field contains the text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

Store
String
Default Value: "MY"

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field to specify client certificates. If Store has a value, and Subject or Encoded is set, a search for a certificate is initiated. Please see the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of 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.

In Java, the certificate store normally is a file containing certificates and optional private keys.

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. PKCS12 certificate store).

StoreB
byte[]
Default Value: "MY"

This is the name of the certificate store for the client certificate.

The StoreType field denotes the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Designations of certificate stores are platform-dependent.

The following are designations of 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.

In Java, the certificate store normally is a file containing certificates and optional private keys.

StorePassword
String
Default Value: ""

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

StoreType
int
Default Value: 0

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 field 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 (PKCS12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 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 PKCS11 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 Store and set StorePassword 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.

Subject
String
Default Value: ""

This is the subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate the subject is used to locate the certificate in the store.

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 displayed below.


Field	Meaning
CN	Common Name. This is commonly a host name 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.

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

This field contains comma-separated lists of alternative subject names for the certificate.

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

This field contains the MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

This field contains the SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

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

This field contains the SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

Usage
String
Default Value: ""

This field contains the text description of UsageFlags.

This value will be of one or more of the following strings and will be separated by commas:

Digital Signatures
Key Authentication
Key Encryption
Data Encryption
Key Agreement
Certificate Signing
Key Signing

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

UsageFlags
int
Default Value: 0

This field contains the flags that show intended use for the certificate. The value of UsageFlags is a combination of the following flags:


0x80	Digital Signatures
0x40	Key Authentication (Non-Repudiation)
0x20	Key Encryption
0x10	Data Encryption
0x08	Key Agreement
0x04	Certificate Signing
0x02	Key Signing

Please see the Usage field for a text representation of UsageFlags.

This functionality currently is not available when the provider is OpenSSL.

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

This field contains the certificate's version number. The possible values are the strings "V1", "V2", and "V3".

Constructors

public Certificate();

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

public Certificate( certificateFile);

Opens CertificateFile and reads out the contents as an X509 public key.

public Certificate( certificateData);

Parses CertificateData as an X509 public key.

public Certificate( certStoreType,  store,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  subject,  configurationString);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  store,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

public Certificate( certStoreType,  storeBlob,  storePassword,  subject);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

public Certificate( certStoreType,  storeBlob,  storePassword,  subject,  configurationString);

public Certificate( certStoreType,  storeBlob,  storePassword,  encoded);

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the class will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

ContactDetail Type

Represents the contact information.

Remarks

This type contains descriptive data identifying the point-of-contact person (such as sender, recipient, broker, etc.).

Example: Setting the fields of the sender ContactDetail senderContact = new ContactDetail senderContact.Company = "Anything Anywhere" senderContact.FirstName = "John" senderContact.LastName = "Doe" senderContact.Phone = "1234567890" senderContact.Email = "test@test.com"

The fields contained by this type are listed below.

Fields

Company
String
Default Value: ""

Identifies the contact person's company name. In a ship request, either FirstName and LastName or Company are required to be provided.

Email
String
Default Value: ""

Identifies the contact person's email address. Maximum length: 120.

Fax
String
Default Value: ""

Recipient's fax number. The value of this field is optional. No format checking is done on international fax numbers.

FirstName
String
Default Value: ""

Sender's first name. The value of this property is required. Values for either FirstName and LastName or Company must be sent.

LastName
String
Default Value: ""

Person's last name. The value of this field is required. Values for either FirstName and LastName or Company must be sent. Maximum length: 45 characters for both names or company name.

MiddleInitial
String
Default Value: ""

Middle initial. The value of this field is optional.

Phone
String
Default Value: ""

Identifies the contact person's phone number. In a ship request, this is required to be provided. Maximum length: 15.

Constructors

public ContactDetail();

public ContactDetail( firstName,  lastName,  phone);

public ContactDetail( firstName,  lastName,  phone,  email);

public ContactDetail( firstName,  lastName,  phone,  email,  company);

Firewall Type

This is the firewall the class will connect through.

Remarks

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

Fields

AutoDetect
boolean
Default Value: False

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

Connection information will first be obtained from Java system properties, such as http.proxyHost and https.proxyHost. Java properties may be set in a variety of ways; please consult the Java documentation for information about how firewall and proxy values can be specified.

If no Java system properties define connection information, the class will inspect the Windows registry for connection information that may be present on the system (applicable only on Windows systems).

FirewallType
int
Default Value: 0

This field 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. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.
fwSOCKS4A (10)	Connect through a SOCKS4A Proxy. Port is set to 1080.

Host
String
Default Value: ""

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

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

Password
String
Default Value: ""

This field contains a password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, the class throws an exception.

Port
int
Default Value: 0

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

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

User
String
Default Value: ""

This field contains a user name if authentication is to be used connecting through a firewall. If the Host is specified, this field and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, the class throws an exception.

Constructors

public Firewall();

NotifyDetail Type

Represents a single recipient to be notified via email.

Remarks

This type contains specific information about a recipient to be notified via email on shipment, exception and/or delivery status.

The fields contained by this type are listed below.

Fields

Aggregate
String
Default Value: ""

This can be used to set the entire aggregate xml for the recipient to be notified. This is only valid for ship requests only when the EmailNotification=0x00000004 is present in the ShipmentSpecialServices.

FedEx

For FedEx, this aggregate should contain descriptive data required for FedEx to provide e-mail notification to the customer regarding the shipment.

The format of this aggregate should be as follows: <EMailNotificationDetail> <PersonalMessage>personal_message</PersonalMessage> <Recipients> (this aggregate can be entered up to six times) <EMailNotificationRecipientType>recipient_type</EMailNotificationRecipientType> <EMailAddress>recipient_email</EMailAddress> <NotifyOnShipment>true_or_false</NotifyOnShipment> <NotifyOnException>true_or_false</NotifyOnException> <NotifyOnDelivery>true_or_false</NotifyOnDelivery> <Format>format_type</Format> <Localization> <LanguageCode>language_code</LanguageCode> </Localization> </Recipients> </EMailNotificationDetail>

In this aggregate, you can specify:

a message text to be sent in the email notification (via the PersonalMessage element). This is optional.
the type of the recipient: SHIPPER, RECIPIENT, BROKER, OTHER (via the EMailNotificationRecipientType element). This is optional.
the recipient's email address (via the EMailAddress element). This is required.
whether the recipient is to be notified on shipment, exception or delivery (via the NotifyOnShipment, NotifyOnException, NotifyOnDelivery elements). These are required.
the format of the message: HTML, TEXT, WIRELESS (via the Format element). This is required.
the language code you want the message to be sent to (via the LanguageCode element). This is optional. If not present, it will default to English (EN).

The specified shipment notification can be sent up to six (6) email addresses to receive (i.e., the Recipients field can have up to 6 recipient emails).

This setting is optional. If Aggregate is not set it will be automatically created by the class.

UPS

For UPS, the following JSON format is valid: { "NotificationCode": "6", "EMail": { "EMailAddress": [ "recipient1_email", (up to five recipient emails) "recipient2_email" ], "UndeliverableEMailAddress": "undeliverable_email", "FromEMailAddress": "sender_email", "FromName": "sender_name", "Memo": "message" } }

In this aggregate, you can specify:

a notification code which describes the notification requested: "6" (Ship Notification), "7" (Exception Notification), "8" (Delivery Notification), or "2" (Return Notification). This is required.
the recipient's email address (via the EMailAddress element). This is required.
the undeliverable email address if to specify where an undeliverable email should be sent. This is optional.
the email address for the reply-to address. The From field of the email will contain pkginfo@ups.com. This should be specified by the FromEMailAddress element.
an optional from name.
a message text to be sent in the email notification (via the Memo element). This is optional.

Note that this field does not apply for USPS and CanadaPost.

Email
String
Default Value: ""

Email address of the recipient to be notified. This is required to be provided for each recipient.

Message
String
Default Value: ""

User defined text that will be included in the email to be sent to Email. This is optional.

For FedEx, when multiple recipients exist, the message for the first recipient is the only message that will be included in the request. FedEx only allows one message for all of the recipients of the notification email.

This field is not used by USPS or Canada Post.

Name
String
Default Value: ""

The name associated with the notification.

For USPS, this name will appear in the text of the Signature Confirmation e-mail message.

This field is not applicable to FedEx, UPS, or Canada Post.

NotificationFlags
int
Default Value: 0

Identifies the type of notification requested. Valid values are:


Value	Meaning
0x00000001 (On Shipment)	An email notification is requested to be sent to the Email when the package is shipped.
0x00000002 (On Exception)	An email notification should be sent to the Email when an exception occurs during package movement from origin to destination.
0x00000004 (On Delivery)	An email notification is requested to be sent to the Email when the package is delivered.
0x00000008 (On Tender)	An email notification is requested to be sent to the Email when the package is tendered.
0x00000010 (On Return)	An email notification is requested to be sent to the Email when the package is returned.
0x00000020 (HTML)	The email should be sent in HTML format.
0x00000040 (Text)	The email should be sent in Text format.
0x00000080 (Wireless)	The email should be sent in Wireless format.
0x00000200 (In Transit)	An email notification is requested to be sent to the Email when the package is in transit.
0x00000400 (ADL)	Alternate Delivery Location
0x00000800 (UAP)	UAP Shipper.
0x00001000 (On Estimated Delivery)	An email notification is requested to be sent to Email when the package was estimated to be delivered.

For FedEx notifications, the following flags apply:

On Shipment
On Exception
On Delivery
On Tender
On Estimated Delivery
HTML
Text

To use Estimated Delivery with FedEx, the APIVersion configuration setting must be set to 19 or higher.

For UPS notifications, the following flags apply:

On Shipment
On Exception
On Delivery
On Return
In Transit
ADL
UAP

For CanadaPost notifications, only the On Shipment, On Exception, and On Delivery apply.

This field is not used by USPS.

RecipientType
int
Default Value: 0

Identifies the set of valid email notification recipient types. Valid values are:


rtUnspecified (0)
rtRecipient (1)
rtShipper (2)
rtBroker (3)
rtOther (4)
rtThirdParty (5)

For FedEx, when rtShipper, rtRecipient or rtBroker are set, the email address associated with their definitions will be used and the Email specified for these types will be ignored.

For USPS, only the rtShipper and rtRecipient are valid.

This field does not apply to UPS or Canada Post notifications.

Constructors

public NotifyDetail();

public NotifyDetail( notificationFlags,  email,  message);

public NotifyDetail( notificationFlags,  email);

public NotifyDetail( notificationFlags,  recipientType,  email);

public NotifyDetail( name);

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 AccountNumber. 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 fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, 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 fields that store the rating information will be set to 'N/A', and in the last package (at index=PackageCount - 1, these fields 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 CODLabel).

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

For UPS, if the CODAmount 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 CODType. 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 PackagingType Letter/Envelope. COD special service is available for shipper's with PickupType 'Daily Pickup' or 'Drop Shipping'. Delivery Confirmation (represented by SignatureType) and COD cannot coexist on a single package.

This field 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 CODLabel of this package to. This is applicable for package(s) that use the COD service.

When the CODFile is set to a valid path and filename, the contents of the CODLabel 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 CODFile 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 field is only applicable to FedEx shipments.

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.

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 CODFile 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 CODLabel 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 field is only applicable to FedEx.

CODLabelB
byte[] (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 CODLabel 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 field is only applicable to FedEx.

CODType
int
Default Value: 0

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

This field 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., CODAmount 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
boolean
Default Value: False

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

This field is only applicable to FedEx shipments, and is required to be specified when the SpecialServices 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 DangerousGoodsAccessible 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 DangerousGoodsAccessible 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
int
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
int
Default Value: 0

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

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

Note: For parcels, Length is the measurement of the longest dimension and Width and Height make up the other two dimensions. Girth 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 PackagingType field is set to ptNonRectangular. (In this case Width and Height 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 Length, Width, and Height are required for Priority Mail packages when the Size is set to psLarge.

Height
int
Default Value: 0

The height of the package to be shipped.

For FedEx, the Height is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Width 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 Width is provided in the request, then all other dimensions (Length and Height) are to be set as well.

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

Note that the Length, Width, and Height are required for Priority Mail packages when the Size 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 field 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
int
Default Value: 0

The length of the package to be shipped.

For FedEx, the Length is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Width and Height 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. 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 Width is provided in the request, then all other dimensions (Length and Height) 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 PackagingType field is set to ptNonRectangular. (In this case Width and Height must still be set).

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

Note that the Length, Width, and Height are required for Priority Mail packages when the Size 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 AccountNumber. 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 fields that store the rating information: BaseCharge, NetCharge, TotalSurcharges, and TotalDiscount, 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 fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields 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
int
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 PackagingType for the first package is used in label requests.

If the PackagingType is set to 31 (Your Packaging), then the dimensions of the package should be provided in the request by setting the following: Length, Width, and Height.

If the ServiceType is set to any of the FedEx Ground services (Ground or Ground Home Delivery), then the PackagingType 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 PackagingType make sure this is valid for all the following: CountryCode, CountryCode, ServiceType, and all special services requested at both shipment and package level.

Also the following restrictions apply when using UPS Mail Innovations:


ServiceType	PackagingType	Weight
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 Reference 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 Reference 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".

ReturnReceipt
String (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 ReturnReceiptFile is set to a valid path and filename (with .html extension), the receipt is also saved to disk.

ReturnReceiptB
byte[] (read-only)
Default Value: ""

Image of the receipt for a return shipment.

ReturnReceiptFile
String
Default Value: ""

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

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

The ReturnReceiptFile 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.

ShippingLabel
String (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 ShippingLabelFile is set to a valid path and filename, the label is also saved to disk in a LabelImageType format.

ShippingLabelB
byte[] (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 ShippingLabel of this package to. When the ShippingLabelFile is set to a valid path and filename, the contents of the ShippingLabel 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 ShippingLabelFile 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).

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.

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 ShippingLabelFile 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 ShippingLabelFile 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 ShippingLabel field whereas Part 2 can be accessed via ShippingLabelPart2 field.

ShippingLabelPart2B
byte[] (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 ShippingLabelFile is "C:\UPSLabel.gif", the part 2* of the label will be created under: "C:\UPSLabel_Part2.gif".

SignatureType
int
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 SignatureType 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
int
Default Value: 0

Size of the package being mailed.

This field 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 Length, Height, Width and optionally Girth (irregular shaped packages only) fields to specify the dimensions of the package.

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

SpecialServices
long
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 SpecialServices 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 SpecialServices contains this flag, then the DangerousGoodsAccessible 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 CODAmount and CODType 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 SpecialServices 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 CODAmount and CODType, SignatureType, and InsuredValue.

This field 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 AccountNumber. 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 fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields 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 AccountNumber. 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 fields that store the rating information will be set to 'N/A', and in last package (at index=PackageCount - 1, these fields 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 PackagingType 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 PackagingType 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
int
Default Value: 0

The width of the package to be shipped.

For FedEx, the Width is optional, but recommended, if "Your Packaging" is used as PackagingType. This is required if Length and Height 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 Width is provided in the request, then all other dimensions (Length and Height) are to be set as well.

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

Note that the Length, Width, and Height are required for Priority Mail packages when the Size 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 PackageDetail();

public PackageDetail( packagingType,  weight);

public PackageDetail( length,  width,  height);

public PackageDetail( packagingType,  length,  width,  height);

public PackageDetail( packagingType,  weight,  length,  width,  height);

public PackageDetail( packagingType,  weight,  length,  width,  height,  specialServices,  insuredValue,  CODAmount,  CODType,  signatureType);

public PackageDetail( weight,  length,  width,  height,  specialServices,  insuredValue,  CODAmount,  dangerousGoodsAccessible,  signatureType);

public PackageDetail( weight,  length,  width,  height,  description,  reference,  specialServices,  insuredValue,  CODAmount,  dangerousGoodsAccessible,  signatureType,  shippingLabelFile,  CODFile);

public PackageDetail( packagingType,  weight,  length,  width,  height,  description,  reference,  specialServices,  insuredValue,  CODAmount,  CODType,  signatureType,  shippingLabelFile,  returnReceiptFile);

PayorDetail Type

Represents the payor details responsible for payment.

Remarks

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

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

The fields contained by this type are listed below.

Fields

AccountNumber
String
Default Value: ""

The account number of the party responsible for payment (shipping charges, or duties and taxes).

This is required to be provided in the ship request, only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. Otherwise, it defaults to AccountNumber.

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. Combination of Address1 and Address2 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. Combination of Address1 and Address2 should not exceed 35 characters.

City
String
Default Value: ""

Name of city, town, etc.

CountryCode
String
Default Value: "US"

The country code for the payor of the shipment, or duties and taxes.

When shipping via FedEx Express, the CountryCode is required to be provided in the ship request only if PayorType is set to 'RECIPIENT' or 'THIRDPARTY'. For FedEx Ground shipments, the CountryCode is required only if PayorType is set to 'THIRDPARTY'.

For UPS, this should be the same as it was entered in the UPS system when this account was set up. In domestic shipments, it will always default to US.

Name
String
Default Value: ""

Identifies the payor's name.

Name is required only if PayorType is set to 'THIRDPARTY'.

Note: This field is only applicable to UPSFreightRates and UPSFreightShip.

PayorType
int
Default Value: 0

Method of payment for shipment, or duties and taxes. This is required to be provided in a ship request. Valid payment types are:


ptSender (0)
ptRecipient (1)
ptThirdParty (2)
ptCollect (3)
ptConsignee (4)

The COLLECT payment type is only supported in FedEx Ground services. The CONSIGNEE type is only supported in UPS service.

For FedEx, when this field is set to a value other than 0 (ptSender), the AccountNumber and CountryCode are required to be provided in the request as well. Otherwise, those will default to AccountNumber and CountryCode.

For UPS, when set to ptSender, the AccountNumber is automatically set to AccountNumber. When ptRecipient is specified, AccountNumber and ZipCode are required to be provided in the request. For return international shipments, this option is invalid for transportation charges. And, when ptThirdParty has been specified, the AccountNumber, ZipCode and CountryCode are required to be provided in the request. When ptConsignee is specified, it indicates that UPS Consignee Billing option is selected, no other fields need to be set. ptConsignee only applies to US/PR and PR/US shipment origins and destination.

State
String
Default Value: ""

ZipCode
String
Default Value: ""

Payor's postal code (if applicable).

This is only applicable to UPS and is the corresponding postal code of the UPS AccountNumber's pickup address. This should be the same as it was entered in the UPS system when this account was set up.

It can be provided in a ship request only if the PayorType is set to 1 (RECIPIENT) or 2 (THIRDPARTY).

Maximum length: 10.

Constructors

public PayorDetail();

public PayorDetail( payorType,  accountNumber,  countryCode);

Proxy Type

This is the proxy the class will connect to.

Remarks

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

Fields

AuthScheme
int
Default Value: 0

This field is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the User and Password fields are set.

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

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication.

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

If AuthScheme 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 AuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this field will clear the values of User and Password.

AutoDetect
boolean
Default Value: False

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

Note: This setting is applicable only in Windows.

Password
String
Default Value: ""

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

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

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
int
Default Value: 80

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

Server
String
Default Value: ""

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

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

SSL
int
Default Value: 0

This field 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 field contains a user name, if authentication is to be used for the proxy.

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

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Constructors

public Proxy();

public Proxy( server,  port);

public Proxy( server,  port,  user,  password);

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 fields contained by this type are listed below.

Fields

AccountNumber
String
Default Value: ""

The shipper's UPS account number.

This field 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 componernt will send the requests to the preset production end-point. You can utilize the TestMode Config to switch from production to testing.

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

Config Settings (Upsship Class)

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.

UPSShip Config Settings

AccountAddress3: Contains line three details for the Account Address.

This property is used to set specific details which will appear in line three of the Account Address. This is usually department information.

AccountTotalNetCharge: Net sum of negotiated rates applied to the whole shipment (if applicable).

This indicates the account-based rates. It is applicable and returned in the ship response only if shipper account/user id combinations qualifies for Negotiated rates.

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"" } }");

BarCodeReference: Determines whether the reference number's value will be bar coded on the shipping label.

If True, then the reference number's value (first value of the ShipmentReference in the UPSShipIntl class, or first value of the Reference in the UPSShip class) will be bar coded on the shipping label.

Only one shipment-level (applicable to international shipments) or package-level reference number (applicable to domestic shipments throughout US or PR) can be bar coded per shipment.

In order to barcode a reference number, its value must be no longer than 14 alphanumeric characters or 24 numeric characters and cannot contain spaces.

CancelPickUpStatus: Status description of Cancel Pickup request.

This read only configuration setting is populated upon a successful response from the server when the CancelPickup method is called.

CertifyDirectory: The name of the directory where the files needed for Label Certification are written.

To be used in Label Certification process only.

If this config is set to a valid value, all files needed for certification process (html, gif and json files) are written to disk in this specified location.

Note: When this is set, all shipping label filenames will be overwritten with the format required by UPS for the Certification process. For example, if the PackageShippingLabelFileHTML[i]; is set to 'MyShippingLabel.html' and the ShippingLabelFile is set to and the Tracking Number for that package is '1Z0715X10194877288', then the PackageShippingLabelFileHTML[i]; will automatically be changed to 'label1Z0715X10194877288.html', and the corresponding image file name to 'label1Z0715X10194877288.gif'.

If both ShippingLabelHTMLDirectory and CertifyDirectory have been set, then the CertifyDirectory will take precedence over the ShippingLabelHTMLDirectory.

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.

ElectronicReturnLabel: Indicates that you are arranging for UPS to email a return label to your customer.

Indicates that the ship request is made for UPS Print and Mail (PNM). This is applicable to return shipments only. 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. The label will be emailed to your customer by UPS.

If this is set, either SenderContactEmail or AccountContactEmail, as well as RecipientContactEmail should be set.

For return shipments, one of the following conditions must be met on CountryCode, CountryCode and CountryCode: 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 Description is required to be provided in the request for each package contained in the shipment. The PackagingType 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. This is false by default.

EPRAReleaseCode: Package Release code that allows the consignee or claimant to pick-up a package at a UPS Access Point.

The shipper must proivde the Package Release Code to the consignee so that they can provide the code to the UPS Access Point personnel as another item for authentication before the package is released to them. It must be between 4-6 characters.

This configuration setting is only valid when ShipmentIndicationType is set to 1.

FRSCommodityCount: Number of commodities in the shipment.

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

This configuration option is only valid when ReturnFreightPrices is true.

FRSCommodityFreightClass[i]: The freight class of the commodity at the index.

This configuration property indicates the freight class of the commodity.

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


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

Valid indices are from 0 to FRSCommodityCount - 1.

This configuration option is only valid when ReturnFreightPrices is true.

FRSCommodityFreightNMFC[i]: The National Motor Freight Classification numbers for the commodity at the index.

This configuration property identifies the National Motor Freight Classification numbers.

Valid indices are from 0 to FRSCommodityCount - 1.

This configuration option is only valid when ReturnFreightPrices is true.

FRSCommodityFreightNMFCSub[i]: The sub-code of National Motor Freight Classification numbers for the commodity at the index.

This configuration property identifies the sub code of National Motor Freight Classification numbers.

Valid indices are from 0 to FRSCommodityCount - 1.

This configuration option is only valid when ReturnFreightPrices is true.

FRSPaymentAccountNumber: The UPS account number for the payor.

This configuration options should be set to the UPS Account Number of the payor for Ground Freight Pricing. This account number is validated to ensure that Ground Freight Pricing is enabled for the account.

This configuration option is only valid when ReturnFreightPrices is true.

FRSPaymentCountryCode: The country code of the payor for the Ground Freight Pricing shipment.

If FRSPaymentType is set to "2" for "Prepaid (Third Party) then the country code for the third party payor must be specified.

This configuration option is only valid when ReturnFreightPrices is true.

FRSPaymentDescription: Description for the Ground Freight Pricing payment type.

This configuration option is used to specify a description for the Ground Freight Pricing payment type, for example the paying party's name.

This configuration option is only valid when ReturnFreightPrices is true.

FRSPaymentPostalCode: The postal code of the payor for the Ground Freight Pricing shipment.

If FRSPaymentType is set to "2" for "Prepaid (Third Party) then the postal code for the third party payor must be specified.

This configuration option is only valid when ReturnFreightPrices is true.

FRSPaymentType: Method of payment for the shipment.

This configuration property is used to specify the method of payment for the freight rated shipment. Valid options are:


Option	Payment Type
0	Prepaid
1	Freight Collect
2	Prepaid (Third Party)

This configuration option is only valid when ReturnFreightPrices is true.

HazMatAdditionalDescription[i]: Additional remarks or special provision information.

Additional remarks or special provision information. Required if HazMatCommodityRegulatedLevelCode = LQ or FR and if the field applies to the material by regulation. Additional information that may be required by regulation about a hazardous material, such as, "Limited Quantity", DOT-SP numbers, EX numbers.