Shipping Integrator V5 - Online Help
Shipping Integrator V5
Questions / Feedback?

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.

AccountAddress1Street name.
AccountAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
AccountCityName of city, town, etc.
AccountCountryCodeCountry code.
AccountStateState or province code.
AccountZipCodePostal code.
AccountCompanyIdentifies the contact person's company name.
AccountEmailIdentifies the contact person's email address.
AccountFaxRecipient's fax number.
AccountFirstNameSender's first name.
AccountLastNamePerson's last name.
AccountMiddleInitialMiddle initial.
AccountPhoneIdentifies the contact person's phone number.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
LabelImageTypeType of image or printer commands the shipping label is to be formatted in.
MasterTrackingNumberTracking number assigned to the whole MPS shipment.
NotifyCountThe number of records in the Notify arrays.
NotifyAggregateThis can be used to set the entire aggregate xml for the recipient to be notified.
NotifyEmailEmail address of the recipient to be notified.
NotifyMessageUser defined text that will be included in the email to be sent to Email .
NotifyFlagsIdentifies the type of notification requested.
PackageCountThe number of records in the Package arrays.
PackageCODAmountThe COD monetary value for the package.
PackageCODTypeThe code that indicates the type of funds that will be used for the COD payment for this package.
PackageDescriptionFor FedEx, this is the description that appears in the email to identify this package.
PackageHeightThe height of the package to be shipped.
PackageInsuredValueAmount of insurance requested for this package.
PackageLengthThe length of the package to be shipped.
PackageTypeThe packaging type of the package being rated and/or shipped.
PackageReferenceIndicates the package reference type and value, that associates this package (assigned by the customer).
PackageReturnReceiptImage of the receipt for a return shipment.
PackageReturnReceiptFileFilename and location to save the ReturnReceipt of this package to.
PackageShippingLabelImage of the shipping label for this package return by the Server upon a successful ship response.
PackageShippingLabelFileFilename and location to save the ShippingLabel of this package to.
PackageSignatureTypeSpecifies one of the Delivery Signature Options requested for this package.
PackageSpecialServicesContains the collection of special services offered on the package level.
PackageTotalSurchargesTotal surcharges applicable to this package.
PackageTrackingNumberTracking number assigned to this package.
PackageWeightWeight of this package.
PackageWidthThe width of the package to be shipped.
PayorAccountNumberThe account number of the party responsible for payment (shipping charges, or duties and taxes).
PayorTypeMethod of payment for shipment, or duties and taxes.
PayorZipCodePayor's postal code (if applicable).
PickupContainerTypeThe type of container to be picked up.
PickupEarliestTimeThe earliest time a shipment is ready to be picked up.
PickupLatestTimeThe latest time a shipment can be picked up.
PickupPaymentMethodThe method of payment for a pickup.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RecipientAddress1Street name.
RecipientAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
RecipientAddressFlagsVarious flags that denote information about the address.
RecipientCityName of city, town, etc.
RecipientCountryCodeCountry code.
RecipientStateState or province code.
RecipientZipCodePostal code.
RecipientCompanyIdentifies the contact person's company name.
RecipientEmailIdentifies the contact person's email address.
RecipientFaxRecipient's fax number.
RecipientFirstNameSender's first name.
RecipientLastNamePerson's last name.
RecipientMiddleInitialMiddle initial.
RecipientPhoneIdentifies the contact person's phone number.
SenderAddress1Street name.
SenderAddress2A specific detail on the address (such as building, suite, apartment, floor number etc.
SenderCityName of city, town, etc.
SenderCountryCodeCountry code.
SenderStateState or province code.
SenderZipCodePostal code.
SenderCompanyIdentifies the contact person's company name.
SenderEmailIdentifies the contact person's email address.
SenderFaxRecipient's fax number.
SenderFirstNameSender's first name.
SenderLastNamePerson's last name.
SenderMiddleInitialMiddle initial.
SenderPhoneIdentifies the contact person's phone number.
ServiceTypeIdentifies the UPS service type (applicable to US domestic shipments) to use in a ship request.
ShipDateThe date the user requests UPS to pickup the package from the origin.
ShipmentSpecialServicesContains the collection of special services offered by UPS on shipment level.
ShipmentVoidStatusStatus description of shipment void request.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TotalBaseChargeThe total base charge (transportation charges) applied to the whole shipment (specific to the AccountNumber ).
TotalNetChargeThe total net charge (transport charges + options charges) applied to the whole shipment (specific to the AccountNumber ).
TotalSurchargesThe total surcharges (on all options) applied to the whole shipment (specific to the AccountNumber ).
UPSAccessKeyAn identifier required to connect to a UPS server.
UPSAccountNumberThe shipper's UPS account number.
UPSPasswordPassword to use for logging in to a UPS Server .
UPSServerURL for the UPS server where the requests are sent.
UPSUserIdUser 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.

CancelPackageCancels a single package by deleting it from the shipping log.
CancelPickupCancel a pickup.
CancelShipmentCancels an entire multi-package (MPS) shipment by deleting it from the shipping log.
ConfigSets or retrieves a configuration setting .
GetShipmentLabelsGenerates a shipping label using one of domestic UPS services.
ResetResets the internal state of the component and all properties to their default values.
SchedulePickupSchedules 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.

ErrorInformation about errors during data delivery.
NotificationNotification returned by the server upon successful request (if applicable).
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
XPathUsed to retrieve data at any place within the response.
WarningWarning message returned by the server.
UseSOAPWhether or not to use UPS' webservices.
AccountTotalNetChargeNet sum of negotiated rates applied to the whole shipment (if applicable).
BarCodeReferenceDetermines whether the reference number's value will be bar coded on the shipping label.
CertifyDirectoryThe name of the directory where the files needed for Label Certification are written.
CurrencyCodeThe currency code associated with the monetary values present in the request.
HighValueReportFileNameName of High Value Report (if applicable).
HighValueReportHigh Value Report (if applicable).
IrregularIndicatorThe mail classification defined by UPS.
LabelSizeThe size of the label.
MachineableDetermines whether the package is machineable or not.
MICostCenterCustomer assigned identifier for report and billing summarization displays to the right of the Cost Center title.
MIPackageIDCustomer assigned unique piece identifier that returns visibility events.
OverwriteDetermines 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.
PickupFloorNumberThe floor number of the pickup location.
PickupRoomNumberThe room number of the pickup location.
RequestOptionDefines if the address should be validated or not.
ReturnsFlexibleAccessIndicatorDefines if the Returns Flexible Access service should be used.
ElectronicReturnLabelIndicates that you are arranging for UPS to email a return label to your customer.
ReturnPrintAndMailIndicates that you are arranging for UPS to print and mail a return label to your customer.
ReturnServiceFirstAttemptIndicates that you are arranging for UPS to make one attempt to pick up the package to be returned.
ReturnServiceThirdAttemptIndicates that you are arranging for UPS to make three attempts to pick up the package to be returned.
ShipmentAcceptRequestContains the Shipment Accept Request sent to UPS.
ShipmentAcceptResponseContains the Shipment Accept Response returned by UPS.
ShipmentConfirmRequestContains the Shipment Confirm Request sent to UPS.
ShipmentConfirmResponseContains the Shipment Confirm Response returned by UPS.
ShippingLabelHTMLDirectoryThe name of the directory where the shipping label files are written.
PickupEarliestTimeThe earliest time a shipment is ready to be picked up.
PickupLatestTimeThe latest time a shipment can be picked up.
AccountAddress3Contains line three details for the Account Address.
RecipientAddress3Contains line three details for the Recipient Address.
SenderAddress3Contains line three details for the Sender Address.
USPSEndorsementThe USPS endorsement type for Mail Innovations and SurePost shipments.
TotalCustomsValueInvoice Line Total Monetary Value when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.
ShipmentDescriptionA 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).
VerbalConfirmationNameThe contact name for verbal confirmation.
VerbalConfirmationPhoneThe contact phone number for verbal confirmation.
WeightUnitWeight unit.
ReturnFreightPricesWhen true, UPS will use applicable freight pricing for shipments.
FRSCommodityCountNumber 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.
FRSPaymentTypeMethod of payment for the shipment.
FRSPaymentDescriptionDescription for the Ground Freight Pricing payment type.
FRSPaymentAccountNumberThe UPS account number for the payor.
FRSPaymentPostalCodeThe postal code of the payor for the Ground Freight Pricing shipment.
FRSPaymentCountryCodeThe country code of the payor for the Ground Freight Pricing shipment.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0