UPSFreightShip Class
Properties Methods Events Configuration Settings Errors
Provides UPS Freight Shipment service.
Class Name
InShip_UPSFreightShip
Procedural Interface
inship_upsfreightship_open(); inship_upsfreightship_close($res); inship_upsfreightship_register_callback($res, $id, $function); inship_upsfreightship_get_last_error($res); inship_upsfreightship_get_last_error_code($res); inship_upsfreightship_set($res, $id, $index, $value); inship_upsfreightship_get($res, $id, $index); inship_upsfreightship_do_config($res, $configurationstring); inship_upsfreightship_do_getshipmentdocuments($res); inship_upsfreightship_do_reset($res);
Remarks
The UPSFreightShip class allows labels and documents to be generated for a freight shipment. To use the class, 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.SenderCompany = "Developer Test 1" component.SenderPhone = "884530171" component.SenderAddress1 = "101 Developer Way" component.SenderCity = "Richmond" component.SenderState = "VA" component.SenderZipCode = "23224" component.SenderCountryCode = "US" component.RecipientCompany = "Consignee Test 1" component.RecipientAddress1 = "1000 Consignee Street" component.RecipientCity = "Allanton" component.RecipientState = "MO" component.RecipientZipCode = "63001" component.RecipientCountryCode = "US" component.PayorType = ptSender component.HandlingUnit = "SKD:1" component.CommodityCount = 1 component.CommodityDescription(0) = "LCD TVS" component.CommodityFreightClass(0) = "77.5" component.CommodityWeight(0) = "150" component.CommodityFreightNMFC(0) = "132680" component.CommodityFreightNMFCSub(0) = "02" component.CommodityNumberOfPieces(0) = 20 component.CommodityValue(0) = "100" component.DocumentCount = 1 component.DocumentPrintFormat = fpfLaser component.DocumentPrintSize = fpsSize8X11 component.DocumentType = ftcLabel component.DocumentFileName = "TestLabel.pdf" component.GetShipmentDocuments Debug.Print ("Total Charge: " & component.TotalCharge) Dim i As Integer For i = 0 To component.ChargeCount - 1 Debug.Print component.ChargeType(0) & ": " & component.ChargeValue(0) Next i Debug.Print ("Billable Weight: " & component.BillableWeight) Debug.Print ("BOLID: " & component.BOLID) Debug.Print ("Shipment Number: " & component.ShipmentNumber)
Property List
The following is the full list of the properties of the class 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). |
ChargeCount | The number of records in the Charge arrays. |
ChargeType | Indicates the type of the charge. |
ChargeDescription | The description of the rate. |
ChargeValue | The value of the charge type specified by ChargeType . |
CODPayorType | The type of payment that will be used for the COD payment. |
CODRemitToAddress1 | Street name. |
CODRemitToAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
CODRemitToCity | Name of city, town, etc. |
CODRemitToState | State or province code. |
CODRemitToZipCode | Postal code. |
CODRemitToCompany | Identifies the contact person's company name. |
CODRemitToEmail | Identifies the contact person's email address. |
CODRemitToFax | Recipient's fax number. |
CODRemitToFirstName | Sender's first name. |
CODRemitToLastName | Person's last name. |
CODRemitToMiddleInitial | Middle initial. |
CODRemitToPhone | Identifies the contact person's phone number. |
CODTotalAmount | The total amount of additional fees. |
CODType | The code that indicates the type of funds that will be used for the COD payment. |
CommodityCount | The number of records in the Commodity arrays. |
CommodityDescription | Complete and accurate description of this commodity line item. |
CommodityFreightClass | Indicates the freight class of the commodity. |
CommodityFreightIsHazardous | Identifies if the Commodity item is hazardous. |
CommodityFreightNMFC | Identifies the National Motor Freight Classification numbers. |
CommodityFreightNMFCSub | Identifies the sub code of National Motor Freight Classification numbers. |
CommodityFreightPackagingType | Identifies the Commodity item's packaging type. |
CommodityNumberOfPieces | The total number of packages, cartons, or containers for the commodity line item. |
CommodityValue | The value of an individual item being shipped. |
CommodityWeight | The shipping weight of this commodity line item, including containers, for each commodity with a separate Harmonized Tariff Code. |
DimensionalWeight | Represents the dimensional weight associated with the shipment. |
DocumentCount | The number of records in the Document arrays. |
DocumentType | Specifies the type of document that is requested. |
DocumentFile | The decoded binary label file. |
DocumentFileName | Specifies where the file will be written. |
DocumentLabelsPerPage | This specifies the number of labels per page in the returned label file. |
DocumentPrintFormat | Specifies the print format of the label. |
DocumentPrintSize | Specifies the requested print size of the label. |
FirewallAutoDetect | This property tells the component whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
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. |
NotifyCount | The number of records in the Notify arrays. |
NotifyAggregate | This can be used to set the entire aggregate xml for the recipient to be notified. |
NotifyEmail | Email address of the recipient to be notified. |
NotifyMessage | User defined text that will be included in the email to be sent to Email . |
NotifyFlags | Identifies the type of notification requested. |
OverSeasLegHeight | The height of the shipment. |
OverSeasLegLength | The length of the shipment. |
OverSeasLegPricePerCubicFoot | The price per CubicFoot. |
OverSeasLegPricePerCWT | Price per Hundredweight. |
OverSeasLegTotalCubicFeet | Total cubic weight of the shipment, obtained by multiplying width by height by depth. |
OverSeasLegWidth | The width of the shipment. |
PayorAddress1 | Street name. |
PayorAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
PayorCity | Name of city, town, etc. |
PayorCountryCode | The country code for the payor of the shipment, or duties and taxes. |
PayorName | Identifies the payor's name. |
PayorType | Method of payment for shipment, or duties and taxes. |
PayorState | State or province code. |
PayorZipCode | Payor's postal code (if applicable). |
PickupRequesterCompany | Identifies the contact person's company name. |
PickupRequesterEmail | Identifies the contact person's email address. |
PickupRequesterFax | Recipient's fax number. |
PickupRequesterFirstName | Sender's first name. |
PickupRequesterLastName | Person's last name. |
PickupRequesterMiddleInitial | Middle initial. |
PickupRequesterPhone | Identifies the contact person's phone number. |
ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
RecipientAddress1 | Street name. |
RecipientAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
RecipientAddressFlags | Various flags that denote information about the address. |
RecipientCity | Name of city, town, etc. |
RecipientCountryCode | Country code. |
RecipientState | State or province code. |
RecipientZipCode | Postal code. |
RecipientCompany | Identifies the contact person's company name. |
RecipientEmail | Identifies the contact person's email address. |
RecipientFax | Recipient's fax number. |
RecipientFirstName | Sender's first name. |
RecipientLastName | Person's last name. |
RecipientMiddleInitial | Middle initial. |
RecipientPhone | Identifies the contact person's phone number. |
ReferenceCount | The number of records in the Reference arrays. |
ReferenceNumber | The reference number. |
ReferenceNumberOfCartons | The number of cartons. |
ReferenceType | The type of the reference number. |
ReferenceWeight | The weight. |
SenderAddress1 | Street name. |
SenderAddress2 | A specific detail on the address (such as building, suite, apartment, floor number etc. |
SenderCity | Name of city, town, etc. |
SenderCountryCode | Country code. |
SenderState | State or province code. |
SenderZipCode | Postal code. |
SenderCompany | Identifies the contact person's company name. |
SenderEmail | Identifies the contact person's email address. |
SenderFax | Recipient's fax number. |
SenderFirstName | Sender's first name. |
SenderLastName | Person's last name. |
SenderMiddleInitial | Middle initial. |
SenderPhone | Identifies the contact person's phone number. |
ServiceType | The service selected for the shipment. |
ShipmentNumber | The shipment number assigned to the shipment. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
Timeout | A timeout for the component. |
TotalCharge | Represents the total shipment charge. |
UPSAccessKey | An identifier required to connect to a UPS server. |
UPSAccountNumber | The shipper's UPS account number. |
UPSPassword | Password to use for logging in to a UPS Server . |
UPSServer | URL for the UPS server where the requests are sent. |
UPSUserId | User Id for logging in to UPS. |
Method List
The following is the full list of the methods of the class 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 class 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 class 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. |