4D Shipping SDK 2020 .NET Edition

Questions / Feedback?

UPSFreightShip Component

Properties   Methods   Events   Configuration Settings   Errors  

Provides UPS Freight Shipment service.




The UPSFreightShip component allows labels and documents to be generated for a freight shipment. To use the component, populate Documents to specify the type of documents requested. Specify the sender, recipient, commodity and UPS account information before calling GetShipmentDocuments. For instance:

component.UPSAccount.Server = "https://wwwcie.ups.com/webservices/FreightShip";
component.UPSAccount.AccessKey = "Your Access Key";
component.UPSAccount.UserId = "User Id";
component.UPSAccount.Password = "Password";
component.UPSAccount.AccountNumber = "000000";

component.SenderContact.Company = "Developer Test 1";
component.SenderContact.Phone = "884530171";
component.SenderAddress.Address1 = "101 Developer Way";
component.SenderAddress.City = "Richmond";
component.SenderAddress.State = "VA";
component.SenderAddress.ZipCode = "23224";
component.SenderAddress.CountryCode = "US";

component.RecipientContact.Company = "Consignee Test 1";
component.RecipientAddress.Address1 = "1000 Consignee Street";
component.RecipientAddress.City = "Allanton";
component.RecipientAddress.State = "MO";
component.RecipientAddress.ZipCode = "63001";
component.RecipientAddress.CountryCode = "US";

component.Payor.PayorType = TPayorTypes.ptSender;
component.HandlingUnit = "SKD:1";

CommodityDetail item = new CommodityDetail();
item.Description = "LCD TVS";
item.FreightClass = "77.5";
item.Weight = "150";
item.FreightNMFC = "132680";
item.FreightNMFCSub = "02";
item.NumberOfPieces = 20;
item.Value = "100";


DocumentInfo label = new DocumentInfo();
label.FileName = "TestLabel.pdf";
label.PrintFormat = TFreightPrintFormats.fpfLaser;
label.PrintSize = TFreightPrintSizes.fpsSize8X11;
label.DocumentType = TFreightTypeCodes.ftcLabel;


Console.WriteLine("Total Charge: " + component.TotalCharge);
for (int i = 0; i < component.Charges.Count; i++)
	Console.WriteLine(component.Charges[i].ChargeType + ": " + component.Charges[i].Value);
Console.WriteLine("Billable Weight: " + component.BillableWeight);
Console.WriteLine("BOLID: " + component.BOLID);
Console.WriteLine("Shipment Number: " + component.ShipmentNumber);

Property List

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

BillableWeightRepresents the billable weight associated with the shipment.
BOLIDThe retrieval key for the stored BOL (Bill of Lading).
ChargesCollection of shipment charges.
CODPayorTypeThe type of payment that will be used for the COD payment.
CODRemitToAddressSpecifies the contact address detail of the contact to whom to send COD funds. If not specified, sender address will be used.
CODRemitToContactSpecifies the contact detail of the contact to whom to send COD funds. If not specified, funds will be sent to the sender.
CODTotalAmountThe total amount of additional fees.
CODTypeThe code that indicates the type of funds that will be used for the COD payment.
CommoditiesCollection of commodity items of the shipment.
DimensionalWeightRepresents the dimensional weight associated with the shipment.
DocumentsCollection of information about each of the requested documents.
FirewallA set of properties related to firewall access.
HandlingUnitDescribe the Handling Units (Movable Pieces) in this Shipment.
HazMatContactNameIdentifies the contact name for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.
HazMatContactPhoneIdentifies the contact phone for questions of the hazardous materials. Required when any commodity is marked as a hazardous material.
NotifyCollection of e-mail notifications to be sent.
OverSeasLegIdentifies the OverSeasLeg detail. Required when origin or destination is Hawaii, Alaska, and Puerto Rico.
PayorIdentifies the payor of transportation charges for the shipment.
PickupRequesterIdentifies the pickup requester's contact info. Used with the EarliestPickupTime and LatestPickupTime configuration settings.
ProxyA set of properties related to proxy access.
RecipientAddressIdentifies the recipient's address.
RecipientContactIdentifies the recipient's contact info.
ReferencesCollection of reference numbers for the shipment.
SenderAddressIdentifies the sender's address.
SenderContactIdentifies the sender's contact info.
ServiceTypeThe service selected for the shipment.
ShipmentNumberThe shipment number assigned to the 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.
TotalChargeRepresents the total shipment charge.
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.

ConfigSets or retrieves a configuration setting.
GetShipmentDocumentsGenerates a shipping label using one of domestic UPS services.
ResetResets the internal state of the component and all properties to their default values.

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.

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.
CurrencyCodeThe currency code associated with the monetary values present in the request.
DeliveryInstructionsSpecifies the delivery instructions for your shipment.
DeliveryOptionsValue-Added Freight Delivery Services.
HandlingChargeAdd a handling charge to your Shipment.
HandlingInstructionsSpecifies the handling instructions for your shipment.
HasXPathDetermines whether a specific element exists in the document.
IncludeNegotiatedRatesWhether to include the NegotiatedRatesIndicator in the request.
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.
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.
OverwriteDetermines whether files will be overwritten.
PickupEarliestTimeThe earliest time a shipment can be picked up.
PickupInstructionsSpecifies the pickup instructions for your shipment.
PickupLatestTimeThe latest time a shipment can be picked up.
PickupOptionsValue-Added Freight Pickup Services.
PickupRequestConfirmationNumberThe confirmation number returned on a successful pickup request.
PiecesToSortThe number of pieces to sort and segregate.
RawRequestContains the complete request sent to the Server.
RawResponseContains the complete response returned by the Server.
RecipientAddress3Contains line three details for the Recipient Address.
SenderAddress3Contains line three details for the Sender Address.
ShipDateThe date the user requests UPS to pickup the package from the origin.
ShipmentIndicationTypeWhether shipment is Hold For Pickup or Delivery at UPS Access Points.
SpecialInstructionsSpecifies the special instructions for your shipment.
SubVersionUPS SubVersion.
TaxInformationIndicatorControls whether to send a TaxInformationIndicator.
UndeliverableEmailThe emails would be sent to this address if any notification is undeliverable.
UseSOAPWhether or not to use UPS' webservices.
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]