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

UPSFreightShip Component

Properties   Methods   Events   Configuration Settings   Errors  

Provides UPS Freight Shipment service.

Syntax

nsoftware.InShip.Upsfreightship

Remarks

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";

component.Commodities.Add(item);

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

component.GetShipmentDocuments();

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.

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.
BarCodeReferenceDetermines whether the reference number's value will be bar coded on the shipping label.
ShipDateThe date the user requests UPS to pickup the package from the origin.
PickupLatestTimeThe latest time a shipment can be picked up.
PickupEarliestTimeThe earliest time a shipment can be picked up.
PickupOptionsValue-Added Freight Pickup Services.
DeliveryOptionsValue-Added Freight Delivery Services.
PiecesToSortThe number of pieces to sort and segregate.
PickupInstructionsSpecifies the pickup instructions for your shipment.
HandlingInstructionsSpecifies the handling instructions for your shipment.
DeliveryInstructionsSpecifies the delivery instructions for your shipment.
SpecialInstructionsSpecifies the special instructions for your shipment.
HandlingChargeAdd a handling charge to your Shipment.
UndeliverableEmailThe emails would be sent to this address if any notification is undeliverable.
CurrencyCodeThe currency code associated with the monetary values present in the request.
WeightUnitWeight unit.
RecipientAddress3Contains line three details for the Recipient Address.
SenderAddress3Contains line three details for the Sender Address.
OverwriteDetermines whether files will be overwritten.
PickupRequestConfirmationNumberThe confirmation number returned on a successful pickup request.
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