4D Shipping SDK 2020 .NET Edition

Questions / Feedback?

UPSShipIntl Component

Properties   Methods   Events   Configuration Settings   Errors  

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

Syntax

DPayments.DShipping.Upsshipintl

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 special services you want to associate the shipment (such as Saturday Pickup, Saturday Delivery), and any other specific information on international shipments (such as Commercial Invoice, international forms required by Customs, 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, where the MasterTrackingNumber parameter identifies the shipment.

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 .
CODReportImage of a COD Turn In Page.
CODReportFileFilename and location to save the CODReport to.
CODTotalAmountThe total amount to be collected on shipment level.
CODTypeThe code that indicates the type of funds that will be used for the COD payment.
CommercialInvoiceContains specific details on Commercial Invoice (when this form is requested).
CommoditiesCollection of commodity line items.
DutiesPayorIdentifies the payor of duty and tax charges for the requested shipment.
FirewallA set of properties related to firewall access.
FormTypesContains the collection of types for international forms that can associate an international shipment.
InternationalFormsImage of the international forms.
InternationalFormsFileFilename and location to save the InternationalForms to.
LabelImageTypeType of image or printer commands the shipping label is to be formatted in.
MasterTrackingNumberTracking number assigned to the whole MPS shipment.
NAFTABlanketPeriodContains specific details on NAFTA CO (when this form is requested).
NAFTAPreferenceCriteriaPreference Criteria for NAFTA Certificate of Origin documents.
NAFTAProducerInfoProducer information for NAFTA Certificate of Origin documents.
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.
PickupEarliestTimeThe earliest time a shipment is ready to be picked up.
PickupLatestTimeThe latest time a shipment can be picked up.
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RecipientContactIdentifies the recipient's contact info.
SEDContains specific details on SED (when this form is requested).
SenderAddressIdentifies the sender's address.
SenderContactIdentifies the sender's contact info.
ServiceTypeIdentifies the UPS service type (applicable to international shipments) to use in a ship request.
ShipDateThe date the user requests UPS to pickup the package from the origin.
ShipmentDescriptionA textual description of goods for the whole shipment.
ShipmentReferenceCustomer-defined number (that may or may not be unique) used to identify the whole shipment.
ShipmentSpecialServicesContains the collection of special services offered by UPS on shipment level.
ShipmentVoidStatusStatus description of shipment void request.
SoldToAddressIdentifies the address of the party who imports and pays any duties due on the current shipment, or the end-user of the goods..
SoldToContactIdentifies the contact info of the party who imports and pays any duties due on the current shipment.
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 ).
TotalCustomsValueTotal customs value for the shipment.
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.
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.

AccountAddress3Contains line three details for the Account Address.
AccountTaxIdThe Tax ID Number for the account holder.
AccountTotalNetChargeNet sum of negotiated rates applied to the whole shipment (if applicable).
AdditionalDocumentIndicatorIndicates that additional documents will be supplied.
AlternateDeliveryAddressUsed to specify an XML or SOAP aggregate for Hold for Pickup or Delivery at UPS Access Points.
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.
CIPONumberPurchase Order Number for Commercial Invoice.
CN22CountryOfOriginCountry of origin from where the CN22 contents originated.
CN22FoldHereTextWill replace default 'Fold Here' text displayed on the label.
CN22OtherDescriptionDescription of the type if CN22Type is 'OTHER'.
CN22QuantityTotal number of items associated with this content.
CN22TariffNumberThe tariff number associated with the CN22 contents.
CN22TypeThe type of CN22 form to be used.
CurrencyCodeThe currency code associated with the monetary values present in the request.
DeclarationStatementThe declarations statement to be sent to the customs office.
DocumentsWhether an international shipment contains documents of no commercial value.
EEIFilingXMLThe XML for EEIFilingOption.
ElectronicReturnLabelIndicates that you are arranging for UPS to email a return label to your customer.
EPRAReleaseCodePackage Release code that allows the consignee or claimant to pick-up a package at a UPS Access Point.
ExportDateThe date the goods will be exiting the country.
ExportingCarrierThe name of the carrier that is exporting the shipment.
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.
FRSPaymentAccountNumberThe UPS account number for the payor.
FRSPaymentCountryCodeThe country code of the payor for the Ground Freight Pricing shipment.
FRSPaymentDescriptionDescription for the Ground Freight Pricing payment type.
FRSPaymentPostalCodeThe postal code of the payor for the Ground Freight Pricing shipment.
FRSPaymentTypeMethod of payment for the shipment.
HasXPathDetermines whether a specific element exists in the document.
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].
HighValueReportHigh Value Report (if applicable).
HighValueReportFileNameName of High Value Report (if applicable).
ImportControlCodeCode for type of ImportControl label.
ImportControlDescriptionDescription for ImportControl.
IncludeNegotiatedRatesWhether to include the NegotiatedRatesIndicator in the request.
InvoiceDiscountThe discount to be subtracted from the total value on the invoice.
IrregularIndicatorThe mail classification defined by UPS.
ItemizedChargesCode[i]The Accesorial/Surcharge code of the itemized charge.
ItemizedChargesCountThe 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.
LabelSizeThe size of the label.
MachineableDetermines whether the package is machineable or not.
MasterCartonIdMaster Carton ID.
MasterCartonIndicatorDetermines whether to include the MasterCartonIndicator in the request.
MICostCenterCustomer assigned identifier for report and billing summarization displays to the right of the Cost Center title.
MILabelCN22Determines whether the MILabelCN22Indicator is included in the request.
MIPackageIDCustomer assigned unique piece identifier that returns visibility events.
NAFTAExcludeFromForm[i]Excludes the commodity from NAFTA form (corresponding to the commodity at index i).
NotificationDialectUsed to specify the dialect for Alternate Delivery Location notifications and UAP Shipper notifications.
NotificationLanguageUsed to specify the language for Alternate Delivery Location notifications and UAP Shipper notifications.
OtherChargesThe amount of all additional charges.
OtherChargesDescriptionThe reason for the other charges.
OverridePaperlessIndicatorIndicates that a copy of the invoice and NAFTA Certificate of Origin should be provided.
OverwriteDetermines 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).
PickupEarliestTimeThe earliest time a shipment is ready to be picked up.
PickupFloorNumberThe floor number of the pickup location.
PickupLatestTimeThe latest time a shipment can be picked up.
PickupRoomNumberThe room number of the pickup location.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
RecipientAddress3Contains line three details for the Recipient Address.
RecipientTaxIdThe Tax ID Number for the recipient.
RequestDeliveryConfirmationWhether or not to request delivery confirmation for the package/shipment.
RequestOptionDefines if the address should be validated or not.
ReturnFreightPricesWhen true, UPS will use applicable freight pricing for shipments.
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.
ReturnsFlexibleAccessIndicatorDefines if the Returns Flexible Access service should be used.
SendDutiesPayorIndicates whether to send the duties payor information or not.
SenderAddress3Contains line three details for the Sender Address.
SenderTaxIdThe Tax ID Number for the sender.
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.
ShipmentDescriptionA textual description of goods for the whole shipment when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.
ShipmentIndicationTypeWhether shipment is Hold For Pickup or Delivery at UPS Access Points.
ShipmentSignatureTypeShipment signature type at the shipment level.
ShipmentSignatureTypeIndicates that a shipment requires a signature.
ShippingLabelHTMLDirectoryThe name of the directory where the shipping label files are written.
SoldToTaxIdThe Tax ID Number for the person or business the product was sold to.
SplitDutyVATIndicatorIndicates that whether or not the duties and taxes are split.
SubVersionUPS SubVersion.
TaxInformationIndicatorControls whether to send a TaxInformationIndicator.
TotalCustomsValueInvoice Line Total Monetary Value when shipping to Puerto Rico or Canada using Mail Innovations domestic shipments.
UseSOAPWhether or not to use UPS' webservices.
USPSEndorsementThe USPS endorsement type for Mail Innovations and SurePost 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.
WarningWarning message returned by the server.
WeightUnitWeight unit.
XAttrCountThe number of records in the XAttr arrays.
XAttrName[i]The name of the indexed attribute.
XAttrValue[i]The value of the indexed attribute.
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.
XElementThe name of the current element.
XParentThe parent of the current element.
XPathUsed to set the XPath within the response from the server.
XTextThe text of the current element.
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.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
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.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
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.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
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.
SentHeadersThe full set of headers as sent by the client.
StatusLineThe first line of the last response from the server.
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.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformDeflateWhether to use the platform implementation to decompress compressed responses.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UserAgentInformation about the user agent (browser).
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
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.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
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.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
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.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
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.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
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.
BuildInfoInformation about the product's build.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

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