4D Shipping SDK 2020 .NET Edition
4D Shipping SDK 2020 .NET Edition
Questions / Feedback?

UPSShip Component

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

DPayments.DShipping.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 component 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 component, you must have a UPS AccountNumber. You should also have already obtained a UserId, Password, AccessKey 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 component with short descriptions. Click on the links for further details.

AccountAddressIdentifies the UPS AccountNumber holder's address, if different from the sender's address.
AccountContactIdentifies the UPS AccountNumber holder's contact info if different from SenderContact .
FirewallA set of properties related to firewall access.
LabelImageTypeType of image or printer commands the shipping label is to be formatted in.
MasterTrackingNumberTracking number assigned to the whole MPS shipment.
NotifyCollection of e-mail notifications to be sent.
PackagesA collection of packages contained in the shipment.
PayorIdentifies the payor of transportation charges for the requested shipment.
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.
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RecipientContactIdentifies the recipient's contact info.
SenderAddressIdentifies the sender's address.
SenderContactIdentifies the sender's contact info.
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.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
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 ).
UPSAccountLogin information for UPS.

Method List


The following is the full list of the methods of the component 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 component 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 component 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 set the XPath within the response from the server.
HasXPathDetermines whether a specific element exists in the document.
XParentThe parent of the current element.
XElementThe name of the current element.
XTextThe text of the current element.
XChildCountThe number of records in the XChild arrays.
XChildElement[i]The name of the indexed child element.
XChildText[i]The text of the indexed child element.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
WarningWarning message returned by the server.
AlternateDeliveryAddressUsed to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points.
IncludeNegotiatedRatesWhether to include the NegotiatedRatesIndicator in the request.
ShipmentIndicationTypeWhether shipment is Hold For Pickup or Delivery at UPS Access Points.
NotificationLanguageUsed to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications.
NotificationDialectUsed to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications.
ItemizedChargesCountThe count of itemized charges.
ItemizedChargesCode[i]The Accesorial/Surcharge code of the itemized charge.
ItemizedChargesCurrencyCode[i]The currency used for the charge.
ItemizedChargesMonetaryValue[i]The amount being charged.
ItemizedChargesSubType[i]The subtype of the itemized charge.
SubVersionUPS SubVersion.
TaxInformationIndicatorControls whether to send a TaxInformationIndicator.
UseSOAPWhether or not to use UPS' webservices.
EPRAReleaseCodePackage Release code that allows the consignee or claimant to pick-up a package at a UPS Access Point.
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.
ElectronicReturnLabelIndicates that you are arranging for UPS to email a return label to your customer.
HazMatPackagingTypeQuantity[i]The number of pieces of the specific commodity.
HazMatSubRiskClass[i]Secondary hazardous characteristics of a package.
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.
HazMatTechnicalName[i]The technical name (when required) for the specified commodity.
HazMatHazardLabelRequired[i]Defines the type of label that is required on the package for the commodity.
HazMatClassDivisionNumber[i]This is the hazard class associated to the specified commodity.
HazMatReferenceNumber[i]Optional reference number. Will be displayed only on label.
HazMatQuantity[i].
HazMatUOM[i].
HazMatPackagingType[i]The type of package used to contain the regulated good.
HazMatIDNumber[i]This is the ID number (UN/NA/ID) for the specified commodity.
HazMatProperShippingName[i]The Proper Shipping Name assigned by ADR, CFR or IATA.
HazMatAdditionalDescription[i]Additional remarks or special provision information.
HazMatPackagingGroupType[i]This is the packing group category associated to the specified commodity.
HazMatPackagingInstructionCode[i]The packing instructions related to the chemical record.
HazMatEmergencyPhone[i]24 Hour Emergency Phone Number of the shipper.
HazMatEmergencyContact[i]The emergency information, contact name and/or contract number.
HazMatReportableQuantity[i].
HazMatRegulationSet[i]The Regulatory set associated with every regulated shipment.
HazMatTransportationMode[i]Declares that a package was prepared according to ground, passenger aircraft, or cargo aircraft only.
HazMatCommodityRegulatedLevelCode[i]Indicates the type of commodity.
HazMatTransportCategory[i]Transport Category.
HazMatTunnelRestrictionCode[i].
HazMatChemicalRecordIdentifier[i]Identifies the Chemcial Record.
HazMatPackageIdentifier[i]Identifies the package containing Dangerous Goods.
HazMatAllPackedInOneIndicator[i]Presence/Absence Indicator.
HazMatOverPackedIndicator[i]Presence/Absence Indicator.
HazMatQValue[i].
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.
PickupEarliestTimeThe earliest time a shipment is ready to be picked up.
PickupLatestTimeThe latest time a shipment can be picked up.
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.
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.
RequestDeliveryConfirmationWhether or not to request delivery confirmation for the package/shipment.
ShipmentSignatureTypeShipment signature type at the shipment level.
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.
ShipmentSignatureTypeIndicates that a shipment requires a signature.
ShippingLabelHTMLDirectoryThe name of the directory where the shipping label files are written.
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.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AllowNTLMFallbackWhether to allow fallback from Negotiate to NTLM when authenticating.
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.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxHeadersInstructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookiesInstructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
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.
TransferredDataThe contents of the last response from the server.
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.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
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).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
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 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.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

 
 
Copyright (c) 2019 4D Payments Inc. - All rights reserved.
4D Shipping SDK 2020 .NET Edition - Version 20.0 [Build 7233]