UPSShip Class

Properties Methods Events Configuration 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

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 UPSAccountNumber. You should also have already obtained a UPSUserId, UPSPassword, UPSAccessKey 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.


AccountAddress1	Street name.
AccountAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
AccountCity	Name of city, town, etc.
AccountCountryCode	Country code.
AccountState	State or province code.
AccountZipCode	Postal code.
AccountCompany	Identifies the contact person's company name.
AccountEmail	Identifies the contact person's email address.
AccountFax	Recipient's fax number.
AccountFirstName	Sender's first name.
AccountLastName	Person's last name.
AccountMiddleInitial	Middle initial.
AccountPhone	Identifies the contact person's phone number.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
LabelImageType	Type of image or printer commands the shipping label is to be formatted in.
MasterTrackingNumber	Tracking number assigned to the whole MPS shipment.
NotifyCount	The number of records in the Notify arrays.
NotifyAggregate	This can be used to set the entire aggregate xml for the recipient to be notified.
NotifyEmail	Email address of the recipient to be notified.
NotifyMessage	User defined text that will be included in the email to be sent to Email .
NotifyFlags	Identifies the type of notification requested.
PackageCount	The number of records in the Package arrays.
PackageCODAmount	The COD monetary value for the package.
PackageCODType	The code that indicates the type of funds that will be used for the COD payment for this package.
PackageDescription	For FedEx, this is the description that appears in the email to identify this package.
PackageHeight	The height of the package to be shipped.
PackageInsuredValue	Amount of insurance requested for this package.
PackageLength	The length of the package to be shipped.
PackageType	The packaging type of the package being rated and/or shipped.
PackageReference	Indicates the package reference type and value, that associates this package (assigned by the customer).
PackageReturnReceipt	Image of the receipt for a return shipment.
PackageReturnReceiptFile	Filename and location to save the ReturnReceipt of this package to.
PackageShippingLabel	Image of the shipping label for this package return by the Server upon a successful ship response.
PackageShippingLabelFile	Filename and location to save the ShippingLabel of this package to.
PackageSignatureType	Specifies one of the Delivery Signature Options requested for this package.
PackageSpecialServices	Contains the collection of special services offered on the package level.
PackageTotalSurcharges	Total surcharges applicable to this package.
PackageTrackingNumber	Tracking number assigned to this package.
PackageWeight	Weight of this package.
PackageWidth	The width of the package to be shipped.
PayorAccountNumber	The account number of the party responsible for payment (shipping charges, or duties and taxes).
PayorType	Method of payment for shipment, or duties and taxes.
PayorZipCode	Payor's postal code (if applicable).
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.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
RecipientAddress1	Street name.
RecipientAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientAddressFlags	Various flags that denote information about the address.
RecipientCity	Name of city, town, etc.
RecipientCountryCode	Country code.
RecipientState	State or province code.
RecipientZipCode	Postal code.
RecipientCompany	Identifies the contact person's company name.
RecipientEmail	Identifies the contact person's email address.
RecipientFax	Recipient's fax number.
RecipientFirstName	Sender's first name.
RecipientLastName	Person's last name.
RecipientMiddleInitial	Middle initial.
RecipientPhone	Identifies the contact person's phone number.
SenderAddress1	Street name.
SenderAddress2	A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderCity	Name of city, town, etc.
SenderCountryCode	Country code.
SenderState	State or province code.
SenderZipCode	Postal code.
SenderCompany	Identifies the contact person's company name.
SenderEmail	Identifies the contact person's email address.
SenderFax	Recipient's fax number.
SenderFirstName	Sender's first name.
SenderLastName	Person's last name.
SenderMiddleInitial	Middle initial.
SenderPhone	Identifies the contact person's phone number.
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.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
TotalBaseCharge	The total base charge (transportation charges) applied to the whole shipment (specific to the AccountNumber ).
TotalNetCharge	The total net charge (transport charges + 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 ).
UPSAccessKey	An identifier required to connect to a UPS server.
UPSAccountNumber	The shipper's UPS account number.
UPSPassword	Password to use for logging in to a UPS Server .
UPSServer	URL for the UPS server where the requests are sent.
UPSUserId	User Id for logging in to 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 component 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.

Configuration Settings

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


RawRequest	Contains the complete request sent to the Server.
RawResponse	Contains the complete response returned by the Server.
XPath	Used to retrieve data at any place within the response.
Warning	Warning message returned by the server.
UseSOAP	Whether or not to use UPS' webservices.
AccountTotalNetCharge	Net sum of negotiated rates applied to the whole shipment (if applicable).
BarCodeReference	Determines whether the reference number's value will be bar coded on the shipping label.
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.
HighValueReportFileName	Name of High Value Report (if applicable).
HighValueReport	High Value Report (if applicable).
IrregularIndicator	The mail classification defined by UPS.
LabelSize	The size of the label.
Machineable	Determines whether the package is machineable or not.
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.
Overwrite	Determines whether label files will be overwritten.
PackageDeclaredValueType[i]	The type of declared value (corresponding to the package at index i).
PackageShippingLabelHTML[i]	HTML version of the shipping label (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.
PickupFloorNumber	The floor number of the pickup location.
PickupRoomNumber	The room number of the pickup location.
RequestOption	Defines if the address should be validated or not.
ReturnsFlexibleAccessIndicator	Defines if the Returns Flexible Access service should be used.
ElectronicReturnLabel	Indicates that you are arranging for UPS to email a return label to your customer.
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.
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.
ShippingLabelHTMLDirectory	The name of the directory where the shipping label files are written.
PickupEarliestTime	The earliest time a shipment is ready to be picked up.
PickupLatestTime	The latest time a shipment can be picked up.
AccountAddress3	Contains line three details for the Account Address.
RecipientAddress3	Contains line three details for the Recipient Address.
SenderAddress3	Contains line three details for the Sender Address.
USPSEndorsement	The USPS endorsement type for Mail Innovations and SurePost shipments.
TotalCustomsValue	Invoice Line Total Monetary Value when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.
ShipmentDescription	A textual description of goods for the whole shipment when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.
USPSPICNumber[i]	USPS Tracking Number (corresponding to the package at index i).
VerbalConfirmationName	The contact name for verbal confirmation.
VerbalConfirmationPhone	The contact phone number for verbal confirmation.
WeightUnit	Weight unit.
ReturnFreightPrices	When true, UPS will use applicable freight pricing for shipments.
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.
FRSPaymentType	Method of payment for the shipment.
FRSPaymentDescription	Description for the Ground Freight Pricing payment type.
FRSPaymentAccountNumber	The UPS account number for the payor.
FRSPaymentPostalCode	The postal code of the payor for the Ground Freight Pricing shipment.
FRSPaymentCountryCode	The country code of the payor for the Ground Freight Pricing shipment.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
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.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
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.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
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 TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
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.
CodePage	The system code page used for Unicode to Multibyte translations.