UPSFreightShip Bean
Properties Methods Events Configuration Settings Errors
Provides UPS Freight Shipment service.
Syntax
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 bean with short descriptions. Click on the links for further details.
BillableWeight | Represents the billable weight associated with the shipment. |
BOLID | The retrieval key for the stored BOL (Bill of Lading). |
Charges | Collection of shipment charges. |
CODPayorType | The type of payment that will be used for the COD payment. |
CODRemitToAddress | Specifies the contact address detail of the contact to whom to send COD funds. If not specified, sender address will be used. |
CODRemitToContact | Specifies the contact detail of the contact to whom to send COD funds. If not specified, funds will be sent to the sender. |
CODTotalAmount | The total amount of additional fees. |
CODType | The code that indicates the type of funds that will be used for the COD payment. |
Commodities | Collection of commodity items of the shipment. |
DimensionalWeight | Represents the dimensional weight associated with the shipment. |
Documents | Collection of information about each of the requested documents. |
Firewall | A set of properties related to firewall access. |
HandlingUnit | Describe the Handling Units (Movable Pieces) in this Shipment. |
HazMatContactName | Identifies the contact name for questions of the hazardous materials. Required when any commodity is marked as a hazardous material. |
HazMatContactPhone | Identifies the contact phone for questions of the hazardous materials. Required when any commodity is marked as a hazardous material. |
Notify | Collection of e-mail notifications to be sent. |
OverSeasLeg | Identifies the OverSeasLeg detail. Required when origin or destination is Hawaii, Alaska, and Puerto Rico. |
Payor | Identifies the payor of transportation charges for the shipment. |
PickupRequester | Identifies the pickup requester's contact info. Used with the EarliestPickupTime and LatestPickupTime configuration settings. |
Proxy | A set of properties related to proxy access. |
RecipientAddress | Identifies the recipient's address. |
RecipientContact | Identifies the recipient's contact info. |
References | Collection of reference numbers for the shipment. |
SenderAddress | Identifies the sender's address. |
SenderContact | Identifies the sender's contact info. |
ServiceType | The service selected for the shipment. |
ShipmentNumber | The shipment number assigned to the shipment. |
SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
SSLCert | The certificate to be used during SSL negotiation. |
SSLServerCert | The server certificate for the last established connection. |
Timeout | A timeout for the component. |
TotalCharge | Represents the total shipment charge. |
UPSAccount | Login information for UPS. |
Method List
The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.
config | Sets or retrieves a configuration setting . |
getShipmentDocuments | Generates a shipping label using one of domestic UPS services. |
reset | Resets 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 bean with short descriptions. Click on the links for further details.
Error | Information about errors during data delivery. |
Notification | Notification returned by the server upon successful request (if applicable). |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
Configuration Settings
The following is a list of configuration settings for the bean with short descriptions. Click on the links for further details.
RawRequest | Contains the complete request sent to the Server. |
RawResponse | Contains the complete response returned by the Server. |
XPath | Used to retrieve data at any place within the response. |
Warning | Warning message returned by the server. |
UseSOAP | Whether or not to use UPS' webservices. |
BarCodeReference | Determines whether the reference number's value will be bar coded on the shipping label. |
ShipDate | The date the user requests UPS to pickup the package from the origin. |
PickupLatestTime | The latest time a shipment can be picked up. |
PickupEarliestTime | The earliest time a shipment can be picked up. |
PickupOptions | Value-Added Freight Pickup Services. |
DeliveryOptions | Value-Added Freight Delivery Services. |
PiecesToSort | The number of pieces to sort and segregate. |
PickupInstructions | Specifies the pickup instructions for your shipment. |
HandlingInstructions | Specifies the handling instructions for your shipment. |
DeliveryInstructions | Specifies the delivery instructions for your shipment. |
SpecialInstructions | Specifies the special instructions for your shipment. |
HandlingCharge | Add a handling charge to your Shipment. |
UndeliverableEmail | The emails would be sent to this address if any notification is undeliverable. |
CurrencyCode | The currency code associated with the monetary values present in the request. |
WeightUnit | Weight unit. |
RecipientAddress3 | Contains line three details for the Recipient Address. |
SenderAddress3 | Contains line three details for the Sender Address. |
Overwrite | Determines whether files will be overwritten. |
PickupRequestConfirmationNumber | The confirmation number returned on a successful pickup request. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |